Skip to content
Last update: February 14, 2024

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.
facet String Facets to apply to the query results, allowing for categorization or grouping based on specific attributes.
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

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
      }
    }
  }
}
{
  "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
          }
        }
      ]
    }
  }
}