Skip to content

Order Detail

Returns the complete order-view payload for a single order — the data behind the admin Sales → Orders → View screen.

Operation

OperationTypePurpose
adminOrderDetailQueryFull detail of one order by ID

Details

  • Requires an admin Bearer token in the Authorization header.
  • The id argument is the resource IRI — "/api/admin/orders/{id}".
  • Everything the order-view screen needs is embedded: customer (with group), addresses, items, invoices, shipments, refunds, and the comment thread (comments, newest first).

GraphQL shape notes

  • customer is a typed object — sub-select the fields you need: customer { name email group { code name } }. It is null for guest orders; the buyer's name/email are still on the top-level customerEmail / customerFirstName / customerLastName fields.
  • addresses is a Relay connection carrying both the billing and shipping address — query addresses { edges { node { addressType city … } } } and read addressType (order_billing / order_shipping) on each node to tell them apart.
  • items, invoices, shipments, refunds, comments are Relay connections — query each as { edges { node { … } } } and pick exactly the sub-fields you need.
  • id vs _id. id is the resource IRI (/api/admin/orders/2392); _id is the raw integer. Connection nodes expose _id.

Product-type-aware items

Each item node carries a type (simple, configurable, bundle, downloadable, grouped, virtual). Select the type-specific fields you need per node:

typeType-specific fields available on the item node
simple, virtual
configurablechild, additional
bundle, groupedchildren { edges { node { … } } }, additional
downloadabledownloadableLinks

Released under the MIT License.