Yelo

Create Order

POST

/open/admin/order/create

Create Order

This API will enable you to create orders.

Request Body Parameters:

Name	Type	Description
api_key	string	Your API-key
payment_method	number	payment method =
job_description	string(optional)	Job description
customer_address	string	Customer's address
customer_username	string	Customer's username
customer_email	string	Customer's email address
customer_phone	number	Customer's phone number
job_date_time	string	Job date and time
job_latitude	number	Job latitude
job_longitude	number	Job longitude
products	array	Refer below products table
vendor_id	number	Customer id
is_scheduled	number	To enable scheduled customization enter 1 else 0
amount	number	Amount of products
delivery_charge	number	Delivery charge
currency_id	number	Currency id
store_id	number	Seller id
self_pickup	number(optional)	To enable self pickup enter 1 else 0

Products

Name	Type	Description
product_id	number	Product Id
unit_price	number(optional)	Per unit price of product
quantity	number	Quantity of product
total_price	number(optional)	Total price of products
Customizations	array(optional)	Refer below customization table

Customizations

Name	Type	Description
cust_id	number	Customization Id
unit_price	number(optional)	Per unit price
quantity	number	Quantity of product
total_price	number(optional)	Total price of products
name	string(optional)	Name of customization
checkout_template	array	checkout template
tip	number	tip
subtotal_amount	number	subtotal amount

payment method

Name	id	Description
ENABLED STRIPE PAYPAL PAYPALV2 CASH PAY_ON_DELIVERY VENMO PAYFORT PAYTM RAZORPAY PAYSTACK ETISALAT SUNCASH GOCARDLESS ATHMOVIL IPAY88 PROXYPAY CYBERSOURCE BANKALFALAH CULQI NMI FLUTTERWAVE MPESA ADYEN HYPUR PAYMARK PAYTMV3 PIXELPAY DOKU PEACH PAGUELOFACIL NOQOODY URWAY GTPAY CXPAY VPOS VUKA PAYKU REVOLUT BAMBORA PAYWAYONE TELR EWAY PLACETOPAY BENEFIT CEVNN PAYMAYA UNIPAY CMI OPENPAY CUSTOMPG PAYMENTEZ STRIPE_GPAY STRIPE_APPLEPAY BILLPLZ SBM NIUBIZ QPAY PAYFAST FAC PAYGATE KANOO ORANGEPAY SPOTII PAYWAY_ABA APCOPAY PAYTABS RAZORPAY_STOREFRONT REDSYS PAYTM_UPI BILLPLZV2 WOMPI PAYZENV2 QUADPAY STRIPE_STANDARD_CONNECT INNSTAPAY KEYPAY HALYKBANK WEBPAY RAZORPAY_UPI PAYULATAM WALLET AUTHORIZENET PAYLATER PAYMOB VISTAMONEY STRIPE_IDEAL PAYNOW VIVA PAYHERE MPAISA PAYTM_LINK CREDIMAX SSL_COMMERZ LIME_LIGHT TWO_CHECKOUT CHECKOUT FAC3D AZUL HYPERPAY MYFATOORAH THETELLER PAYNET TAP CURLEC WIPAY PAGARME WHOOSH MTN STRIPE_WECHAT ONEPAY PAGOPLUX MYBILLPAYMENT BANKOPEN VALITOR BHARATPE TRUEVO CUSTOM_PG_START CUSTOM_PG_STOP PAYZEN FIRSTDATA SQUAREUP	: 1 : 2 : 4 : 6 : 8 : 9 : 16 : 32 : 64 : 128 : 256 : 257 : 258 : 259 : 260 : 261 : 262 : 263 : 264 : 265 : 266 : 267 : 268 : 269 : 270 : 271 : 272 : 273 : 274 : 275 : 276 : 277 : 278 : 279 : 280 : 281 : 282 : 283 : 284 : 285 : 286 : 287 : 288 : 297 : 298 : 299 : 301 : 302 : 305 : 307 : 303 : 311 : 304 : 403 : 512 : 702 : 701 : 704 : 1024 : 2048 : 3001 : 3002 : 5012 : 5020 : 5010 : 5019 : 5021 : 5025 : 5005 : 5007 : 3003 : 3013 : 5001 : 5009 : 5022 : 4096 : 7000 : 7001 : 7002 : 5006 : 8192 : 16384 : 32768 : 65536 : 131072 : 262144 : 524288 : 1048576 : 2097152 : 4194304 : 8388608 : 16777216 : 33554432 : 67108864 : 134217728 : 268435456 : 536870912 : 1073741824 : 2147483648 : 4294967296 : 8589934592 : 17179869184 : 34359738368 : 68719476736 : 137438953472 : 274877906944 : 549755813888 : 1099511627776 : 2199023255552 : 4398046511104 : 8796093022208 : 17592186044416 : 35184372088832 : 70368744177664 : 140737488355328 : 281474976710656 : 562949953421312 : 600000000000000 : 999999999999999 : 1125899906842624 : 2251799813685248 : 4503599627370496

currency id

Name	symbol	id
USD EUR JPY GBP AUD CAD CHF CNY SEK MXN NZD SGD HKD NOK KRW INR RUB ZAR KES ZMW AED EGP PEN UGX IQD QAR COP NGN MYR RES KWD GHS HNL SAR ₱ MAD OMR BHD PKR BMD DOP THB TWD ZK JOD XOF AWG JMD TRY R $< b r / > B D T < b r / > D Z D < b r / > A RS < b r / > PEN < b r / > BR L < b r / > C L P < b r / > GM D < b r / > L BP < b r / > B W P < b r / > BN D < b r / > BTN < b r / > Rp < b r / > TT D < b r / > GE L < b r / > J O D < b r / > L K R < b r / > F J D < b r / > K Y D < b r / > TZS < b r / > A O A < b r / > XC D < b r / > DKK < b r / > MZN < b r / > N I O < b r / > I L S < b r / > MM K < b r / > L A K < b r / > I S K < b r / > XPF < b r / > BS D < b r / > CRC < b r / > GTQ < b r / > I D R < b r / > K GS < b r / > P H P < b r / > P H P < b r / > BOB < b r / > K ZT < b r / > N A D < b r / > SCR < b r / > O U V < b r / > BGN < b r / > B A M < / t d >< t d >$ ‎€ ¥‎ £ $< b r / > C$ Fr. ¥ kr Mex $< b r / > NZ$ S $< b r / > HK$ kr ₩ ₹ ₽ R KSh ZK AED E£ S UGX ع.د QAR $< b r / > ₦ < b r / > RM < b r / > re < b r / > K W D < b r / > G H ₵ < b r / > H N L < b r / > S A R < b r / > ₱ < b r / > M A D < b r / > OMR < b r / > B HD < b r / > R s < b r / >$ RD $< b r / > ‎ ฿ < b r / > NT$ ZK JOD XOF Afl. JMD $< b r / > ₺ < b r / > R$ ৳ DZD $< b r / > S /. < b r / > R$ $< b r / > GM D < b r / > L . L . < b r / > P < b r / > B$ Nu. Rp TT $< b r / > ლ < b r / > دينا < b r / > R s < b r / > F J$ CI $< b r / > TS h < b r / > Kz < b r / >$ DKK MT C $< b r / > ₪ < b r / > MM K < b r / > L A K < b r / > k r < b r / > F < b r / > B$ ₡ Q Rp Лв PHP PHP Bs ₸ N$ ₨ OUV Лв KM	1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 29 30 31 32 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 80 81 82 83 84 85 87 88 89 100 101 150 74 92 86 87 90 90 123 124 102 125 94 95 96

Request

Body Params application/json

object {0}

Example

{
    "api_key"           : {{apikey}} ,
    "payment_method"    : 8 ,
    "job_description"   : "Deliver on time!" ,
    "customer_address"  : "xyz colony, abc, chandigarh-134109" ,
    "customer_username" : "tester" ,
    "customer_email"    : "test@email.com" ,
    "customer_phone"    : "9898981122" ,
    "job_date_time"     : "2021-05-06T15:54:00Z" ,
    "job_latitude"      : 9.96233 ,
    "job_longitude"     : 49.80404 ,
    "products"          : {
        "product_id"        : 457894 ,
        "unit_price"        : 120 ,
        "quantity"          : 2 ,
        "total_price"       : 240 ,
        "Customizations"    : {
            "cust_id"           : 101 ,
            "unit_price"        : 32 ,
            "quantity"          : 1 ,
            "total_price"       : 32 ,
            "name"              : " "
        }
    } ,
    "vendor_id"         : 587465 ,
    "is_scheduled"      : 1 ,
    "amount"            : 341 ,
    "delivery_charge"   : 50 ,
    "currency_id"       : 9955623 ,
    "store_id"          : 125 ,
    "self_pickup"       : 0,
    "checkout_template": { },
    "tip"               : 20,
    "subtotal_amount"   : 130
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.yelo.red/open/admin/order/create' \
--header 'Content-Type: application/json' \
--data-raw '{
    "api_key"           : {{apikey}} ,
    "payment_method"    : 8 ,
    "job_description"   : "Deliver on time!" ,
    "customer_address"  : "xyz colony, abc, chandigarh-134109" ,
    "customer_username" : "tester" ,
    "customer_email"    : "test@email.com" ,
    "customer_phone"    : "9898981122" ,
    "job_date_time"     : "2021-05-06T15:54:00Z" ,
    "job_latitude"      : 9.96233 ,
    "job_longitude"     : 49.80404 ,
    "products"          : {
        "product_id"        : 457894 ,
        "unit_price"        : 120 ,
        "quantity"          : 2 ,
        "total_price"       : 240 ,
        "Customizations"    : {
            "cust_id"           : 101 ,
            "unit_price"        : 32 ,
            "quantity"          : 1 ,
            "total_price"       : 32 ,
            "name"              : " "
        }
    } ,
    "vendor_id"         : 587465 ,
    "is_scheduled"      : 1 ,
    "amount"            : 341 ,
    "delivery_charge"   : 50 ,
    "currency_id"       : 9955623 ,
    "store_id"          : 125 ,
    "self_pickup"       : 0,
    "checkout_template": { },
    "tip"               : 20,
    "subtotal_amount"   : 130
}'

Responses

🟢200Success

application/json

Body

object {0}

Example

{}

Modified at 2024-04-17 07:11:33

Get Order Details