GraphQL API
Organization API
Organization / Types/ object

OrderConnection

A paginated list of Order edges.

Fields

2 fields
cursor•String!

A unique cursor that can be used for pagination.

billingAddress•Address

Billing address of the order

brand•Brand!

Brand of the order

canceledAt•DateTimeTz

When the order was canceled.

createdAt•DateTimeTz!

When the order was created.

customer•Customer

Customer of the order

customsInvoiceNumber•String

Invoice number for customs

customsShipmentType•CustomsShipmentType

Shipment export type for customs

DOCUMENTSGIFTRETURNED_GOODSSALE_GOODSSAMPLE

Events related to this order

Exceptions related to this order

fulfillmentPreferences•OrderFulfillmentPreferences

Fulfillment preferences of the order.

fulfillments•FulfillmentConnection!

Fulfillments of the order

id•ID!

Unique primary key.

integration•Integration

Integration of the order

integrationReference•String

Integration reference of the order

isUpdatable•Boolean!

Whether this order can be updated.

Order lines

locale•String

BCP-47 locale used for communication templates

Metafields attached to this order

quantityAllocated•Int!

Quantity allocated in to fulfillments

quantityOrdered•Int!

Quantity ordered

quantityShipped•Int!

Quantity (already) shipped

quantityUnallocated•Int!

Quantity that is not (yet) allocated to a fulfillment

recipientAddress•Address

Recipient address of the order

reference•String

Reference of the order

Shipments

shippedAt•DateTimeTz

When the order was shipped.

shippingPrice•Money

Shipping cost paid by the customer

status•OrderStatus!

Status of the order

ALLOCATEDCANCELEDCREATEDEXPECTEDPARTIALLY_SHIPPEDSHIPPEDUNALLOCATED

Support tickets linked to this order

updatedAt•DateTimeTz!

When the order was last updated.

endCursor•String

The cursor to continue paginating forwards.

hasNextPage•Boolean!

When paginating forwards, are there more items?

hasPreviousPage•Boolean!

When paginating backwards, are there more items?

startCursor•String

The cursor to continue paginating backwards.