Skip to main content

Order

One sale: what a customer bought, through which channel, what they paid, and how much of it has since been refunded.

type Order {
  id: ID!
  reference: String!
  placedAt: DateTime!
  channel: SalesChannel!
  status: OrderStatus!
  lines: [OrderLine!]!
  subtotal: Money!
  shipping: Money!
  total: Money!
  refundedTotal: Money!
  netTotal: Money!
  settlement: Settlement
}

Fields​

Order.id ● ID! non-null scalar​

The stable identifier of this order, unique across every merchant.

Order.reference ● String! non-null scalar​

The order number the merchant and their customer both see — the one printed on the receipt. Unique within the merchant.

Order.placedAt ● DateTime! non-null scalar​

When the customer placed the order, in UTC.

Order.channel ● SalesChannel! non-null enum​

The selling surface the order arrived through.

Order.status ● OrderStatus! non-null enum​

Where the order has reached, including whether any of it was refunded.

Order.lines ● [OrderLine!]! non-null object​

What the customer bought, in the order it was listed on the receipt. Never empty.

Order.subtotal ● Money! non-null object​

What the goods came to, before delivery.

Order.shipping ● Money! non-null object​

What the customer paid to have the order delivered. Zero when they collected it or the merchant absorbed the cost.

Order.total ● Money! non-null object​

What the customer paid in total: the goods plus delivery.

Order.refundedTotal ● Money! non-null object​

How much of the total has been refunded to the customer. Zero unless the status says otherwise.

Order.netTotal ● Money! non-null object​

What the merchant kept: the total less anything refunded.

Order.settlement ● Settlement object​

The payment that settled this order.

**Returns:**

The payment, or null when no payment has been recorded against this order — an order that was cancelled before the money was taken has none, and so does one whose processor has not reported the capture yet.

Returned By​

order query

Member Of​

OrderConnection object ● OrderEdge object ● Settlement object