Type.

Order

No description

Fields

•

ID!

Required

A unique identifier for the Order.

checkoutSession

•

CheckoutSession

No description

customsSpec

•

CustomsSpec

No description

declaration

•

Declaration

No description

accountOrderNumber

•

String

The order number from the Organization.

amountSubtotals

•

AmountSubtotals!

Required

Subtotal amounts of how the Order amount was calculated.

amountSubtotalsDetails

•

[AmountDetail!]

Details around amount subtotals

cartons

•

[Carton!]

The Cartons that are included in the Order.

createdAt

•

DateTime!

Required

When this Order was created.

createdBy

•

ID!

Required

The user who created the Order.

currencyCode

•

CurrencyCode!

Required

The currency this Order price amount is in.

destinationCountryCode

•

String

The destination country code (denormalized for search performance).

externalGroupIds

•

[String!]

Optional merchant-supplied grouping identifiers (e.g. container, pallet, batch). Multiple orders may share the same value, allowing them to be retrieved together.

hasPendingModificationPayment

•

Boolean!

Required

Whether the order has a pending modification payment that must be completed before fulfillment

items

•

[Item!]

The Items that are included in the Order.

landedCosts

•

[LandedCost!]

The landedCost calculations that are included in the Order.

metadata

•

[OrderMetadata]

Other Order details.

mode

•

Mode!

Required

Specifies whether the Order is in live or test mode.

notes

•

[OrderNote]

The notes associated with an order.

orderModifications

•

[OrderModification!]!

Required

No description

organization

•

ID!

Required

The Organization associated with the Order.

parties

•

[Party!]

The relevant party contact information for the Order.

references

•

[OrderReference!]

The reference information that is included in the Order.

refunds

•

[OrderRefund!]

A List of refunds on the order

remittance

•

[Remittance]

List of remittances

root

•

Root

No description

serviceLevelDisplayName

•

String

The service level display name (denormalized for search performance).

shipmentRatings

•

[ShipmentRating!]

The shipmentRatings that are included in the Order.

status

•

OrderStatus!

Required

The status of the Order.

statusTransitions

•

[OrderStatusTransition!]!

Required

Timestamp for when the status changed.

trackingNumbers

•

[String]

The main tracking number for the order.

updatedAt

•

DateTime!

Required

When this Order was most recently updated.

updatedBy

•

ID!

Required

The user who most recently updated the Order.

zonosOrderId

•

String

The Zonos order id is an ID that is shorter and easier to use than the UUID

shipments

•

[Shipment!]!

Required

No description

Fields

Was this page helpful?