Arguments
customMeta
StringA filter and retrieve data using special fields included for special use-cases.
fromDate
StringThe date from which the orders should be retrieved.
pageNo
IntThe page number to navigate through the given set of results. Default value is 1.
pageSize
IntThe number of items to retrieve in each page. Default value is 10.
status
IntA filter to retrieve orders by their current status such as 'placed', 'delivered' etc.
toDate
StringThe date till which the orders should be retrieved.
Response
filters
OrderFiltersAn array containing the order statuses.
items
[Order]List of orders, each containing detailed information about individual orders and their respective shipments.
page
OrderPageInfoPage Configuration.
Query
1query orders(2 $customMeta: String3 $fromDate: String4 $pageNo: Int5 $pageSize: Int6 $status: Int7 $toDate: String8) {9 orders(10 customMeta: $customMeta11 fromDate: $fromDate12 pageNo: $pageNo13 pageSize: $pageSize14 status: $status15 toDate: $toDate16 ) {17 items {18 order_created_time19 order_created_ts20 order_id21 total_shipments_in_order22 gstin_code23 meta24 }25 page {26 current27 has_next28 item_total29 size30 type31 }32 }33}
Try it
Input Variables
1{2 "customMeta": "customMeta",3 "fromDate": "fromDate",4 "pageNo": 42,5 "pageSize": 42,6 "status": 42,7 "toDate": "toDate"8}
Response
1{2 "orders": {3 "items": [4 {5 "order_created_time": "order_created_time",6 "order_created_ts": "order_created_ts",7 "order_id": "order_id",8 "total_shipments_in_order": 42,9 "gstin_code": "gstin_code",10 "meta": {}11 }12 ],13 "page": {14 "current": 42,15 "has_next": true,16 "item_total": 42,17 "size": 42,18 "type": "type"19 }20 }21}
Was this section helpful?