orders

Get the authenticated customer’s orders. Requires a valid customer access token via the @storeContext directive.

Authentication

Authentication Required: Secret API key with scope order:read

Query Structure


{
  orders(
    first: Int
    after: String
    last: Int
    before: String
    sortKey: OrderSortKey
    reverse: Boolean
  ) {
    # OrderConnection fields
  }
}

Arguments

Argument	Type	Required	Description
first	Int	No	Returns the first n elements.
after	String	No	Returns elements after cursor.
last	Int	No	Returns the last n elements.
before	String	No	Returns elements before cursor.
sortKey	OrderSortKey	No	The key to sort orders by.
reverse	Boolean	No	Reverse the order of the underlying list.

Return Type

OrderConnection - A connection object containing a list of orders for the authenticated customer with pagination support.

Example


{
  orders(first: 10, sortKey: CREATED_AT, reverse: true) {
    edges {
      node {
        id
        orderNumber
        createdAt
        totalPrice {
          amount
          currencyCode
        }
        statusUrl
      }
    }
    pageInfo {
      hasNextPage
      hasPreviousPage
    }
  }
}