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
    metafields
    metafield
  }
}

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


{
  order(id: "order_12345") {
    id
    orderNumber
    referenceNumber
    createdAt
    orderStatus
    financialStatus
    subtotalPrice
    totalPrice
    currency
    totalTax
    customer {
      id
      email
    }
    lines {
      id
      quantity
    }
    shippingAddress {
      city
      country
    }
    billingAddress {
      city
      country
    }
    metafields {
      namespace
      key
      value
    }
  }
}

Order
ID