CustomerOrderDetail
An order as the customer sees it in full.
type CustomerOrderDetail {
billingAddress: String
billingAddressFields: [CustomFieldDisplayRow!]!
createdAt: DateTime!
currency: String
customFields: JSON
customerPoNumber: String
deliverySelection: CustomerDeliverySelection
discountAmount: Float!
discountAmountMoney: AppMoney
id: ID!
invoiceIds: [ID!]
items: [CustomerOrderItem!]!
notes: String
orderNumber: String
paymentOutstanding: Float
shipmentTrackingLevel: CustomerTrackingLevel!
shipments: [CustomerShipment!]!
shippingAddress: String
shippingAddressFields: [CustomFieldDisplayRow!]!
shippingAmount: Float!
shippingAmountMoney: AppMoney
status: String!
subtotal: Float!
subtotalMoney: AppMoney
taxAmount: Float!
taxAmountMoney: AppMoney
totalAmount: Float!
totalAmountMoney: AppMoney
updatedAt: DateTime
}
Fields
CustomerOrderDetail.billingAddress ● String scalar
The billing address.
CustomerOrderDetail.billingAddressFields ● [CustomFieldDisplayRow!]! non-null object
The organization's own fields on the billing address, as the order recorded them; only those the customer may see.
CustomerOrderDetail.createdAt ● DateTime! non-null scalar
When the record was created.
CustomerOrderDetail.currency ● String scalar
ISO 4217 currency code.
CustomerOrderDetail.customFields ● JSON scalar
The organization's own fields on this order that the customer may see, keyed by field key.
CustomerOrderDetail.customerPoNumber ● String scalar
The purchase order or reference the buyer gave at checkout.
CustomerOrderDetail.deliverySelection ● CustomerDeliverySelection object
The live delivery option chosen at checkout. Empty for flat-fee orders.
CustomerOrderDetail.discountAmount ● Float! non-null scalar
The total discount across every line. 0 when none applies.
CustomerOrderDetail.discountAmountMoney ● AppMoney object
The order discount as { amount, currencyCode }. The Storefront API reads money only through these fields.
CustomerOrderDetail.id ● ID! non-null scalar
The unique ID of this record.
CustomerOrderDetail.invoiceIds ● [ID!] list scalar
The IDs of the issued sales invoices of the order. Drafts, cancelled and voided ones are left out.
CustomerOrderDetail.items ● [CustomerOrderItem!]! non-null object
The lines of the order.
CustomerOrderDetail.notes ● String scalar
Notes on the order.
CustomerOrderDetail.orderNumber ● String scalar
The order number.
CustomerOrderDetail.paymentOutstanding ● Float scalar
What the buyer still owes on the order: the outstanding on its issued sales invoices, or the order total while none is issued.
CustomerOrderDetail.shipmentTrackingLevel ● CustomerTrackingLevel! non-null enum
How much shipment tracking this customer gets on the portal (FULL when the store's setting does not apply to it). STATUS: show no shipment section (and no 'tracking will appear' line) — the order status alone.
CustomerOrderDetail.shipments ● [CustomerShipment!]! non-null object
The outbound shipments, oldest first, with carrier, tracking, expected date and timeline. Never the seller's cost.
CustomerOrderDetail.shippingAddress ● String scalar
The delivery address.
CustomerOrderDetail.shippingAddressFields ● [CustomFieldDisplayRow!]! non-null object
The organization's own fields on the delivery address, as the order recorded them; only those the customer may see.
CustomerOrderDetail.shippingAmount ● Float! non-null scalar
The delivery fee charged on the order.
CustomerOrderDetail.shippingAmountMoney ● AppMoney object
The shipping charge as { amount, currencyCode }. The Storefront API reads money only through these fields.
CustomerOrderDetail.status ● String! non-null scalar
The status of the order.
CustomerOrderDetail.subtotal ● Float! non-null scalar
The order amount before discount and tax.
CustomerOrderDetail.subtotalMoney ● AppMoney object
The order subtotal as { amount, currencyCode }. The Storefront API reads money only through these fields.
CustomerOrderDetail.taxAmount ● Float! non-null scalar
The tax on the order.
CustomerOrderDetail.taxAmountMoney ● AppMoney object
The order tax as { amount, currencyCode }. The Storefront API reads money only through these fields.
CustomerOrderDetail.totalAmount ● Float! non-null scalar
The order total.
CustomerOrderDetail.totalAmountMoney ● AppMoney object
The order total as { amount, currencyCode }. The Storefront API reads money only through these fields.
CustomerOrderDetail.updatedAt ● DateTime scalar
When the record was last changed.
Returned By
customerCancelOrder mutation ● customerOrderDetail query