Qodex.ai

Get Order List

GET {{baseUrl}}/order.list.json?customer_id=<string>&customer_email=<string>&order_status=<object>&start=<integer>&count=<integer>&sort_by=<string>&sort_direction=<string>&params=<string>&exclude=<string>&created_to=<string>&created_from=<string>&modified_to=<string>&modified_from=<string>&store_id=<string>&ids=<string>&order_ids=<string>&basket_id=<string>&financial_status=<string>&fulfillment_status=<string>&shipping_method=<>&skip_order_ids=<string>

Get list of orders from store. Returns 4 orders by default.

Request Params

KeyDatatypeRequiredDescription
customer_idstringCounts orders quantity specified by customer id
customer_emailstringCounts orders quantity specified by customer email
order_statusstringCounts orders quantity specified by order status
startstringThis parameter sets the number from which you want to get entities
countstringThis parameter sets the entity amount that has to be retrieved. Max allowed count=250
sort_bystringSet field to sort by
sort_directionstringSet sorting direction
paramsstringSet this parameter in order to choose which entity fields you want to retrieve
excludestringSet this parameter in order to choose which entity fields you want to ignore. Works only if parameter params equal force_all
created_tostringRetrieve entities to their creation date
created_fromstringRetrieve entities from their creation date
modified_tostringRetrieve entities to their modification date
modified_fromstringRetrieve entities from their modification date
store_idstringDefines store id where the webhook should be assigned
idsstringList of сomma-separated webhook ids
order_idsstringCounts orders specified by order ids
basket_idstringRetrieves order’s info specified by basket id.
financial_statusstringCounts orders quantity specified by financial status
fulfillment_statusstringCreate order with fulfillment status
shipping_methodstringRetrieve entities according to shipping method
skip_order_idsstringSkipped orders by ids