Order

An order represents a delivery or shipment of products

When paired with an invoice, an order can also have a payment status. Orders can also be used to trigger service or goods delivery independent of a payment or invoice.

Fields

acceptUrl (String)

The url to accept and pay for this order

amountCents (Int!)

The amount in cents

cancelUrl (String)

The url to cancel this order

createdAt (ISO8601DateTime)

Order creation date

currency (String)

Currency used for this order

discountCents (Int)

The amount of discount for this order in cents including tax

discountExclTaxCents (Int)

The amount of discount for this order in cents excluding tax

extraFieldAnswersSummary (JSON)

Summary of extra field answers from the shipping section only (captured when the order was created). Each entry is an object with a single key-value pair: the field name as key and answer value as value.

fulfilledAt (ISO8601DateTime)

Time at which the order was marked as fulfilled.

id (ID)

ID to identify the order with

invoice (Invoice)

The invoice for this order. Can be null if this order is a shipment-only order without directly being related to a payment or invoice.

orderLines ([OrderLine!])

The lines on the order.

paid (Boolean!)

Wether the order and its invoice is paid. Will always be true if the order total amount is zero and no invoice is attached.

payment (Payment)

The associated payment for this order. Can be null if this order is a shipment-only order.

shipmentDate (ISO8601Date)

The date on which the order is initiated

shippingCostsCents (Int)

The amount of shipping cost for this order in cents including tax

shippingCostsExclTaxCents (Int)

The amount of shipping cost for this order in cents excluding tax

shopifyDraftId (String)

The associated Shopify draft order ID.

shopifyFulfillmentOrderId (String)

The associated Shopify fulfillment order ID.

shopifyId (String)

The associated Shopify order ID.

snoozeUrl (String)

The url to snooze this order

status (OrderStatus!)

Order status

subscription (Subscription)

The subscription this order was made for.

totalTaxCents (Int!)

The total amount of tax for this order in cents

trackAndTraceCode (String)

Deprecated: Please use 'tracking_code' instead.

The track and trace code for this order.

trackingCode (String)

The tracking code for this order. Made available in email templates.

updatedAt (ISO8601DateTime)

The date and time when the order was last updated.