v2

latestOpenAPI 3.1.12026-08-06856719.6 KB

Get Orders

Get and filter the orders

get/v1/orders

Query parameters

perPageinteger

version'1.0' | '2.0'

Order version: 1.0 or 2.0. Return all orders as default

keywordsstring

Search for fields: amount ,created_at ,order id, remark, customer_name

statuses[]'completed' | 'sent' | 'draft' | 'expired' | 'canceled'

The available status: completed, sent, draft, expired, canceled

dateFromstring

Example: 2023-04-18

dateTostring

Example: 2023-04-18

withstring

If we want to show the product or charge detail=> add the value: products or charges. For both: products,charges

Headers

X-BUSINESS-API-KEYstring required

Example:b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d

Response

200

idstring

order_display_numberinteger

business_idstring

channelstring

versionstring

{"stackTrail":"paths:/v1/orders:get:responses:200:content:application/json:schema:properties:customer_id","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/v1/orders:get:responses:200:content:application/json:schema:properties:business_customer_id","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/v1/orders:get:responses:200:content:application/json:schema:properties:customer","oasType":"schema","type":"unknown"}

customer_pickupboolean

currencystring

{"stackTrail":"paths:/v1/orders:get:responses:200:content:application/json:schema:properties:order_discount_name","oasType":"schema","type":"unknown"}

statusstring

remarkstring

created_atstring

updated_atstring

{"stackTrail":"paths:/v1/orders:get:responses:200:content:application/json:schema:properties:closed_at","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/v1/orders:get:responses:200:content:application/json:schema:properties:location_id","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/v1/orders:get:responses:200:content:application/json:schema:properties:location","oasType":"schema","type":"unknown"}

business_user_idstring

{"stackTrail":"paths:/v1/orders:get:responses:200:content:application/json:schema:properties:slot_date","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/v1/orders:get:responses:200:content:application/json:schema:properties:slot_time","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/v1/orders:get:responses:200:content:application/json:schema:properties:messages","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/v1/orders:get:responses:200:content:application/json:schema:properties:coupon","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/v1/orders:get:responses:200:content:application/json:schema:properties:payment_status","oasType":"schema","type":"unknown"}

fulfilment_statusstring

line_items_totalinteger

order_discount_amountinteger

line_item_discount_amountinteger

line_item_tax_amountinteger

additional_discount_amountinteger

total_discount_amountinteger

line_item_priceinteger

shipping_amountinteger

total_coupon_amountinteger

amountinteger

subtotalinteger