Skip to content
Last update: September 20, 2023

Orders query

This query is used to retrieve a list of customer orders based on various criteria.​

Arguments

Argument Description
filter String Filters query results.
sort String The sorting order for the retrieved orders.
cultureName String A language to retrieve data in.
userId String The Id of the user.
after String A cursor value to paginate through the results.
first Int The number of pages in a single query.

Possible returns

Possible return Description
CustomerOrderConnection A connection of customer orders.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
query {
  orders {
    totalCount
    items {
      id
      status
      number
      createdDate
      modifiedDate
      customerId
      customerName
      shipments {
        id
        status
        shipmentMethodCode
        shipmentMethodOption
        total {
          amount
        }
      }
      addresses {
        id
        firstName
        lastName
        line1
        countryName
        countryCode
        postalCode
      }
      total {
        amount
      }
      subTotal {
        amount
      }
      discountTotal {
        amount
      }
    }
  }
}

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
{
  "data": {
    "orders": {
      "totalCount": 3,
      "items": [
        {
          "id": "order_id_1",
          "status": "Processing",
          "number": "ORD-20230702",
          "createdDate": "2023-07-02T10:15:30Z",
          "modifiedDate": "2023-07-02T11:45:25Z",
          "customerId": "customer_id_1",
          "customerName": "Alice Johnson",
          "shipments": [
            {
              "id": "shipment_id_1",
              "status": "Shipped",
              "shipmentMethodCode": "Standard",
              "shipmentMethodOption": "Express",
              "total": {
                "amount": 45.99
              }
            }
          ],
          "addresses": [
            {
              "id": "address_id_1",
              "firstName": "Alice",
              "lastName": "Johnson",
              "line1": "789 Oak Street",
              "countryName": "United States",
              "countryCode": "US",
              "postalCode": "56789"
            }
          ],
          "total": {
            "amount": 149.99
          },
          "subTotal": {
            "amount": 129.99
          },
          "discountTotal": {
            "amount": 20.00
          }
        },
        {
          "id": "order_id_2",
          "status": "Shipped",
          "number": "ORD-20230703",
          "createdDate": "2023-07-03T14:20:00Z",
          "modifiedDate": "2023-07-03T16:05:15Z",
          "customerId": "customer_id_2",
          "customerName": "Bob Smith",
          "shipments": [
            {
              "id": "shipment_id_2",
              "status": "Delivered",
              "shipmentMethodCode": "Express",
              "shipmentMethodOption": "Next Day",
              "total": {
                "amount": 65.99
              }
            }
          ],
          "addresses": [
            {
              "id": "address_id_2",
              "firstName": "Bob",
              "lastName": "Smith",
              "line1": "456 Pine Avenue",
              "countryName": "Canada",
              "countryCode": "CA",
              "postalCode": "A1B 2C3"
            }
          ],
          "total": {
            "amount": 199.99
          },
          "subTotal": {
            "amount": 169.99
          },
          "discountTotal": {
            "amount": 20.00
          }
        },
        {
          "id": "order_id_3",
          "status": "Processing",
          "number": "ORD-20230704",
          "createdDate": "2023-07-04T09:30:45Z",
          "modifiedDate": "2023-07-04T10:55:20Z",
          "customerId": "customer_id_3",
          "customerName": "Eve Davis",
          "shipments": [
            {
              "id": "shipment_id_3",
              "status": "Processing",
              "shipmentMethodCode": "Standard",
              "shipmentMethodOption": "Ground",
              "total": {
                "amount": 59.99
              }
            }
          ],
          "addresses": [
            {
              "id": "address_id_3",
              "firstName": "Eve",
              "lastName": "Davis",
              "line1": "123 Elm Street",
              "countryName": "United States",
              "countryCode": "US",
              "postalCode": "12345"
            }
          ],
          "total": {
            "amount": 159.99
          },
          "subTotal": {
            "amount": 139.99
          },
          "discountTotal": {
            "amount": 20.00
          }
        }
      ]
    }
  }
}