Skip to main content

Order Object

Description​

Represents a customer order with items, billing, shipping, and payment information.

Declaration​

type Order {
_id: ID!
id: String!
configRef: ID
created: Date
origin: String!
status: String!
totals: CheckoutTotals!
buyer: User
billing: CheckoutBilling!
shipping: CheckoutShipping!
items: [CheckoutLineItem!]!
messages: [Message!]
paymentUrl: String
}

Fields​

NameTypeDescription
_idID!Internal database identifier.
idString!Order identifier string.
configRefIDConfiguration reference for the shop.
createdDateDate when the order was created.
originString!Origin of the order (e.g., "Online").
statusString!Current status of the order.
totalsCheckoutTotals!Order totals including subtotals, taxes, and shipping.
buyerUserBuyer information.
billingCheckoutBilling!Billing information and payment details.
shippingCheckoutShipping!Shipping information and method.
items[CheckoutLineItem!]!Items included in the order.
messages[Message!]Messages in the order conversation thread.
paymentUrlStringURL for payment processing if payment is pending.