Order

Represents a placed order, exposing order details, totals, items, discounts, shipping, and payment information.

Type Definition


type Order {
  id: String
  orderNumber: String
  referenceNumber: String
  createdAt: String
  orderStatus: String
  financialStatus: String
  isFulfilled: Boolean
  isShipped: Boolean
  isCancelled: Boolean
  customer: Customer
  discounts: [CartDiscount]
  tags: [String]
  subtotalPrice: Float
  totalPrice: Float
  currency: String
  totalNetPrice: Float
  totalTax: Float
  taxLines: [CartTaxLine]
  customerNote: String
  paymentMethods: [CartPaymentMethod]
  paymentFee: Float
  shippingMethods: [CartShippingMethod]
  shippingPrice: Float
  lines: [CartLineItem]
  physicalLines: [CartLineItem]
  lineCount: Int
  shippingAddress: Address
  billingAddress: Address
}

Fields

Field	Type	Description
id	String	Returns the id for this order.
orderNumber	String	Returns the order number.
referenceNumber	String	Returns the reference number.
createdAt	String	Date when this order was created in RFC 2822 format.
orderStatus	String	Returns the order status.
financialStatus	String	Returns paid if order is paid, otherwise not_paid.
isFulfilled	Boolean	Returns true if order is fulfilled.
isShipped	Boolean	Returns true if order is shipped.
isCancelled	Boolean	Returns true if this order was cancelled.
customer	Customer	Customer linked to this order if any.
discounts	[CartDiscount]	Returns the discounts applied to this order.
tags	[String]	Returns the tags associated with this order.
subtotalPrice	Float	Returns the subtotal in customer’s currency.
totalPrice	Float	Returns the total in customer’s currency.
currency	String	Returns the currency for this order.
totalNetPrice	Float	Returns the net total in customer’s currency.
totalTax	Float	Returns the total tax in customer’s currency.
taxLines	[CartTaxLine]	Returns the tax lines for this order.
customerNote	String	Returns the customer note.
paymentMethods	[CartPaymentMethod]	Returns the payment methods for this order.
paymentFee	Float	Returns the total payment fee in customer’s currency.
shippingMethods	[CartShippingMethod]	Returns the shipping methods for this order.
shippingPrice	Float	Returns the total shipping costs in customer’s currency.
lines	[CartLineItem]	Returns the items in this order.
physicalLines	[CartLineItem]	Returns the physical items in this order.
lineCount	Int	Returns the number of items in this order.
shippingAddress	Address	Returns the shipping address for this order.
billingAddress	Address	Returns the billing address for this order.

Relationships

The Order type represents a complete order containing customer information through the customer field, which references a Customer object. It aggregates financial and fulfillment details, including applied discounts via CartDiscount, tax information through CartTaxLine, payment methods via CartPaymentMethod, and shipping details through CartShippingMethod. Line items are represented by CartLineItem objects, while shipping and billing information is stored in Address objects.

Example


query {
  order(id: 12345) {
    id
    orderNumber
    referenceNumber
    createdAt
    orderStatus
    financialStatus
    isFulfilled
    isShipped
    isCancelled
    totalPrice
    currency
    subtotalPrice
    totalTax
    shippingPrice
    paymentFee
    lineCount
    customer {
      id
      email
    }
    lines {
      id
      quantity
    }
    shippingAddress {
      address1
      city
    }
    billingAddress {
      address1
      city
    }
  }
}

Implements

None