GraphQL API
Organization API
Organization / Types/ object

Order

An order of the organization

Fields

30 fields
idID!

Unique primary key.

integrationReferenceString

Integration reference of the order

quantityOrderedInt!

Quantity ordered

quantityAllocatedInt!

Quantity allocated in to fulfillments

quantityShippedInt!

Quantity (already) shipped

quantityUnallocatedInt!

Quantity that is not (yet) allocated to a fulfillment

referenceString

Reference of the order

currencyString!

ISO 4217 currency code

valueString!

Amount

statusOrderStatus!

Status of the order

CANCELEDCREATEDEXPECTEDALLOCATEDPARTIALLY_SHIPPEDSHIPPEDUNALLOCATED
customsInvoiceNumberString

Invoice number for customs

customsShipmentTypeCustomsShipmentType

Shipment export type for customs

DOCUMENTSGIFTRETURNED_GOODSSALE_GOODSSAMPLE
localeString

BCP-47 locale used for communication templates

canceledAtDateTimeTz

When the order was canceled.

shippedAtDateTimeTz

When the order was shipped.

createdAtDateTimeTz!

When the order was created.

updatedAtDateTimeTz!

When the order was last updated.

isUpdatableBoolean!

Whether this order can be updated.

idID!

Unique primary key.

nameString!

Name of the brand

customsShipmentTypeCustomsShipmentType

Default customs shipment to use for shipments

DOCUMENTSGIFTRETURNED_GOODSSALE_GOODSSAMPLE
customsUseReferenceIfInvoiceNumberEmptyBoolean!

Use reference if invoice number is empty

inboundGBEoriString

Import EORI for GB

inboundGBVatString

Import VAT number for GB

createdAtDateTimeTz!

When the brand was created.

updatedAtDateTimeTz!

When the brand was last updated.

urlString!

Url of the avatar

urlString!

Url of the avatar

urlString!

Url of the avatar

idID!

Unique primary key.

companyNameString

Company name

nameString

Name

addressString

Street / first address line

address2String

Second address line

houseNumberString

House number

postalCodeString

Postal code

cityString

City

stateCodeString

State code

countryCodeString!

Country code

emailString

Email address

phoneString

Phone number

phoneE164String

Phone number in E.164 format

eoriString

EORI

vatString

VAT number

ossString

One-Stop Shop (OSS) number

formattedLinesString!

Formatted address

idID!

Unique primary key.

companyNameString

Company name

nameString

Name

addressString

Street / first address line

address2String

Second address line

houseNumberString

House number

postalCodeString

Postal code

cityString

City

stateCodeString

State code

countryCodeString!

Country code

emailString

Email address

phoneString

Phone number

phoneE164String

Phone number in E.164 format

eoriString

EORI

vatString

VAT number

ossString

One-Stop Shop (OSS) number

formattedLinesString!

Formatted address

pageInfoPageInfo!

Pagination information about the list of edges.

A list of BrandPortal edges.

pageInfoPageInfo!

Pagination information about the list of edges.

A list of CommunicationTemplate edges.

idID!

Unique primary key.

companyNameString

Company name

nameString

Name

addressString

Street / first address line

address2String

Second address line

houseNumberString

House number

postalCodeString

Postal code

cityString

City

stateCodeString

State code

countryCodeString!

Country code

emailString

Email address

phoneString

Phone number

phoneE164String

Phone number in E.164 format

eoriString

EORI

vatString

VAT number

ossString

One-Stop Shop (OSS) number

formattedLinesString!

Formatted address

idID!

Unique primary key.

companyNameString

Company name

nameString

Name

addressString

Street / first address line

address2String

Second address line

houseNumberString

House number

postalCodeString

Postal code

cityString

City

stateCodeString

State code

countryCodeString!

Country code

emailString

Email address

phoneString

Phone number

phoneE164String

Phone number in E.164 format

eoriString

EORI

vatString

VAT number

ossString

One-Stop Shop (OSS) number

formattedLinesString!

Formatted address

idID!

Unique primary key.

referenceString

Reference of the customer

idID!

Unique primary key.

companyNameString

Company name

nameString

Name

addressString

Street / first address line

address2String

Second address line

houseNumberString

House number

postalCodeString

Postal code

cityString

City

stateCodeString

State code

countryCodeString!

Country code

emailString

Email address

phoneString

Phone number

phoneE164String

Phone number in E.164 format

eoriString

EORI

vatString

VAT number

ossString

One-Stop Shop (OSS) number

formattedLinesString!

Formatted address

idID!

Unique primary key.

companyNameString

Company name

nameString

Name

addressString

Street / first address line

address2String

Second address line

houseNumberString

House number

postalCodeString

Postal code

cityString

City

stateCodeString

State code

countryCodeString!

Country code

emailString

Email address

phoneString

Phone number

phoneE164String

Phone number in E.164 format

eoriString

EORI

vatString

VAT number

ossString

One-Stop Shop (OSS) number

formattedLinesString!

Formatted address

createdAtDateTimeTz!

When the customer was created.

updatedAtDateTimeTz!

When the customer was last updated.

ordersCountInt!

Customer orders count

returnRequestsCountInt!

Customer return requests count

shipmentsCountInt!

Customer shipments count

pageInfoPageInfo!

Pagination information about the list of edges.

A list of Order edges.

pageInfoPageInfo!

Pagination information about the list of edges.

A list of ReturnRequest edges.

pageInfoPageInfo!

Pagination information about the list of edges.

A list of Shipment edges.

idID!

Unique primary key.

isEnabledBoolean!

Synchronization enabled

Category of the integration

invoicingpaymentshopshipping
nameString!

Name of the integration

isOrderSyncEnabledBoolean!

Order sync enabled

orderSyncUpdatedAtDateTimeTz

When the last order was updated at the integration while syncing

isProductSyncEnabledBoolean!

Product sync enabled

productSyncUpdatedAtDateTimeTz

When the last product was updated at the integration while syncing

isStockSyncEnabledBoolean!

Stock sync enabled

nameString!

Profile name

integrationReferenceString!

Reference provided by the integration

createdAtDateTimeTz!

When the integration was created.

updatedAtDateTimeTz!

When the integration was last updated.

shippingServiceMethodIdID

ID of the shipping service method.

returnShippingServiceMethodIdID

ID of the return shipping service method.

printPackingSlipBoolean

Print packing slip of the order fulfillment preferences.

fulfillmentModeFulfillmentMode

Fulfillment mode of the order fulfillment preferences.

DELIVERYLOCAL_PICKUP
allocationStrategyOrderAllocationStrategy

Allocation strategy of the order fulfillment preferences.

FEFOLEFOBULK_NON_PICKABLE
hasNextPageBoolean!

When paginating forwards, are there more items?

hasPreviousPageBoolean!

When paginating backwards, are there more items?

startCursorString

The cursor to continue paginating backwards.

endCursorString

The cursor to continue paginating forwards.

The Fulfillment node.

cursorString!

A unique cursor that can be used for pagination.

hasNextPageBoolean!

When paginating forwards, are there more items?

hasPreviousPageBoolean!

When paginating backwards, are there more items?

startCursorString

The cursor to continue paginating backwards.

endCursorString

The cursor to continue paginating forwards.

nodeOrderLine!

The OrderLine node.

cursorString!

A unique cursor that can be used for pagination.

hasNextPageBoolean!

When paginating forwards, are there more items?

hasPreviousPageBoolean!

When paginating backwards, are there more items?

startCursorString

The cursor to continue paginating backwards.

endCursorString

The cursor to continue paginating forwards.

nodeEvent!

The Event node.

cursorString!

A unique cursor that can be used for pagination.

hasNextPageBoolean!

When paginating forwards, are there more items?

hasPreviousPageBoolean!

When paginating backwards, are there more items?

startCursorString

The cursor to continue paginating backwards.

endCursorString

The cursor to continue paginating forwards.

The OrderException node.

cursorString!

A unique cursor that can be used for pagination.

hasNextPageBoolean!

When paginating forwards, are there more items?

hasPreviousPageBoolean!

When paginating backwards, are there more items?

startCursorString

The cursor to continue paginating backwards.

endCursorString

The cursor to continue paginating forwards.

nodeMetafield!

The Metafield node.

cursorString!

A unique cursor that can be used for pagination.

hasNextPageBoolean!

When paginating forwards, are there more items?

hasPreviousPageBoolean!

When paginating backwards, are there more items?

startCursorString

The cursor to continue paginating backwards.

endCursorString

The cursor to continue paginating forwards.

nodeShipment!

The Shipment node.

cursorString!

A unique cursor that can be used for pagination.

hasNextPageBoolean!

When paginating forwards, are there more items?

hasPreviousPageBoolean!

When paginating backwards, are there more items?

startCursorString

The cursor to continue paginating backwards.

endCursorString

The cursor to continue paginating forwards.

The SupportTicketAccess node.

cursorString!

A unique cursor that can be used for pagination.