order

Get a single order by ID for the authenticated customer. Requires a valid customer access token via the @storeContext directive.

Authentication

Authentication Required: Secret API key with scope order:read

Query Structure


order(id: ID!) {
  id
  orderNumber
  referenceNumber
  createdAt
  orderStatus
  financialStatus
  isFulfilled
  isShipped
  isCancelled
  customer
  discounts
  tags
  subtotalPrice
  totalPrice
  currency
  totalNetPrice
  totalTax
  taxLines
  customerNote
  paymentMethods
  paymentFee
  shippingMethods
  shippingPrice
  lines
  physicalLines
  lineCount
  shippingAddress
  billingAddress
}

Arguments

Argument	Type	Required	Description
id	ID	Yes	The ID of the order to retrieve.

Return Type

Order - Represents a placed order, exposing order details, totals, items, discounts, shipping, and payment information.

Example


query {
  order(id: "12345") {
    id
    orderNumber
    referenceNumber
    createdAt
    orderStatus
    financialStatus
    isFulfilled
    isShipped
    totalPrice
    currency
    subtotalPrice
    totalTax
    lineCount
    shippingAddress {
      firstName
      lastName
      address1
      city
      country
    }
    billingAddress {
      firstName
      lastName
      address1
      city
      country
    }
    lines {
      id
      quantity
      title
    }
  }
}

Order