query

orders

Get all orders associated with a customer account.
Arguments
customMeta
String
A filter and retrieve data using special fields included for special use-cases.
fromDate
String
The date from which the orders should be retrieved.
pageNo
Int
The page number to navigate through the given set of results. Default value is 1.
pageSize
Int
The number of items to retrieve in each page. Default value is 10.
status
Int
A filter to retrieve orders by their current status such as 'placed', 'delivered' etc.
toDate
String
The date till which the orders should be retrieved.
Response
An array containing the order statuses.
items
[Order]
List of orders, each containing detailed information about individual orders and their respective shipments.
Page Configuration.
Query
1query orders(
2 $customMeta: String
3 $fromDate: String
4 $pageNo: Int
5 $pageSize: Int
6 $status: Int
7 $toDate: String
8) {
9 orders(
10 customMeta: $customMeta
11 fromDate: $fromDate
12 pageNo: $pageNo
13 pageSize: $pageSize
14 status: $status
15 toDate: $toDate
16 ) {
17 items {
18 order_created_time
19 order_created_ts
20 order_id
21 total_shipments_in_order
22 gstin_code
23 meta
24 }
25 page {
26 current
27 has_next
28 item_total
29 size
30 type
31 }
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}