query

orders

Get all orders associated with a customer account. Returns paginated list of orders with filters.
Arguments
customMeta
String
A filter and retrieve data using special fields included for special use-cases.
fromDate
String
Start date for filtering orders. Format: MM-DD-YYYY, e.g. '04-15-2026' for April 15, 2026.
pageNo
Int
The page number to navigate through the given set of results. Default value is 1. For example, 1, 2, or 3.
pageSize
Int
The number of items to retrieve in each page. Default value is 10. For example, 10, 20, or 50.
status
Int
A filter to retrieve orders by their current status such as 'placed', 'delivered' etc. For example, 1 for 'placed', 2 for 'confirmed', 10 for 'handed_over_to_dg', 114 for 'credit_note_generated'.
toDate
String
End date for filtering orders. Format: MM-DD-YYYY, e.g. '05-15-2026' for May 15, 2026.
startDate
String
Start date for filtering orders by UTC creation date. Format: MM-DD-YYYY, e.g. '04-15-2026' for April 15, 2026. For sub-day precision (timezone-aligned 'Today'/'Yesterday' filtering), use startDatetime.
endDate
String
End date for filtering orders by UTC creation date. Format: MM-DD-YYYY, e.g. '05-15-2026' for May 15, 2026. For sub-day precision (timezone-aligned 'Today'/'Yesterday' filtering), use endDatetime.
startDatetime
String
Start of the order created datetime range. ISO-8601 with explicit timezone offset (e.g. '2026-04-15T16:00:00Z' or '2026-04-15T16:00:00+08:00'). Must be sent together with endDatetime; date-only or offset-less values are rejected. Use this when timezone-aligned hour-precision filtering is required.
endDatetime
String
End of the order created datetime range. ISO-8601 with explicit timezone offset, same shape as startDatetime. Must be sent together with startDatetime; date-only or offset-less values are rejected.
Response
Query
Loading...
Try it
Input Variables
Loading...
Response
Loading...