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 inline: customer (with group), billing/shipping addresses, items, invoices, shipments, refunds, and the comment thread (comments, newest first).

GraphQL shape notes

  • Nested collections are plain JSON arrays. items, invoices, shipments, refunds, and comments are returned as flat arrays (items { id ... }), identical to the REST endpoint. They are NOT GraphQL cursor connections — do not wrap them in edges { node { ... } }. (Prior to 2026-05-28 these were exposed as connections; the shape was unified with REST so both transports return the same payload.)
  • id vs _id. id is the resource IRI (/api/admin/orders/2392); _id is the raw integer.

Product-type-aware items

Each item carries a type (simple, configurable, bundle, downloadable, grouped, virtual). Select the type-specific fields you need and switch on type in the client:

typeType-specific fields
simple, virtual
configurablechild { ... }, additional
bundle, groupedchildren { ... }, additional
downloadabledownloadableLinks

Released under the MIT License.