Admin Sales: Orders

Get order detail

Full order-view payload — flat order fields plus embedded customer, billing/shipping addresses, items, invoices, shipments, refunds, and comments. Over GraphQL the nested collections are field-selectable connections (items { edges { node } }) and the to-one objects are typed (customer { name }); over REST they are flat arrays/objects.

get/orders/{id}

Request

Path parameters

idstring required

Order detail ID

Response

AdminOrderDetail resource

idinteger nullable
incrementIdstring nullable
statusstring nullable
statusLabelstring nullable
channelNamestring nullable
isGuestboolean nullable
isGiftboolean nullable
customerEmailstring nullable
customerFirstNamestring nullable
customerLastNamestring nullable
shippingMethodstring nullable
shippingTitlestring nullable
shippingDescriptionstring nullable
paymentMethodstring nullable
paymentTitlestring nullable
couponCodestring nullable
totalItemCountinteger nullable
totalQtyOrderedinteger nullable
baseCurrencyCodestring nullable
channelCurrencyCodestring nullable
orderCurrencyCodestring nullable
grandTotalnumber nullable
baseGrandTotalnumber nullable
formattedGrandTotalstring nullable
grandTotalInvoicednumber nullable
formattedGrandTotalInvoicedstring nullable
grandTotalRefundednumber nullable
formattedGrandTotalRefundedstring nullable
subTotalnumber nullable
baseSubTotalnumber nullable
formattedSubTotalstring nullable
taxAmountnumber nullable
formattedTaxAmountstring nullable
discountAmountnumber nullable
formattedDiscountAmountstring nullable
shippingAmountnumber nullable
formattedShippingAmountstring nullable
totalDuenumber nullable
baseTotalDuenumber nullable
formattedTotalDuestring nullable
createdAtstring nullable
updatedAtstring nullable
addressesobject[]
itemsobject[]
invoicesobject[]
shipmentsobject[]
refundsobject[]
commentsobject[]

Changes

No recorded changes to this operation across all 8 revisions of this API.