GraphQL API
Organization API
Organization / Types/ object

Order

An order of the organization

Fields

30 fields
addressString

Street / first address line

address2String

Second address line

cityString

City

companyNameString

Company name

countryCodeString!

Country code

emailString

Email address

eoriString

EORI

formattedLinesString!

Formatted address

houseNumberString

House number

idID!

Unique primary key.

nameString

Name

ossString

One-Stop Shop (OSS) number

phoneString

Phone number

phoneE164String

Phone number in E.164 format

postalCodeString

Postal code

stateCodeString

State code

vatString

VAT number

urlString!

Url of the avatar

A list of BrandPortal edges.

pageInfoPageInfo!

Pagination information about the list of edges.

A list of CommunicationTemplate edges.

pageInfoPageInfo!

Pagination information about the list of edges.

createdAtDateTimeTz!

When the brand was created.

customsShipmentTypeCustomsShipmentType

Default customs shipment to use for shipments

DOCUMENTSGIFTRETURNED_GOODSSALE_GOODSSAMPLE
customsUseReferenceIfInvoiceNumberEmptyBoolean!

Use reference if invoice number is empty

idID!

Unique primary key.

inboundGBEoriString

Import EORI for GB

inboundGBVatString

Import VAT number for GB

urlString!

Url of the avatar

urlString!

Url of the avatar

nameString!

Name of the brand

addressString

Street / first address line

address2String

Second address line

cityString

City

companyNameString

Company name

countryCodeString!

Country code

emailString

Email address

eoriString

EORI

formattedLinesString!

Formatted address

houseNumberString

House number

idID!

Unique primary key.

nameString

Name

ossString

One-Stop Shop (OSS) number

phoneString

Phone number

phoneE164String

Phone number in E.164 format

postalCodeString

Postal code

stateCodeString

State code

vatString

VAT number

addressString

Street / first address line

address2String

Second address line

cityString

City

companyNameString

Company name

countryCodeString!

Country code

emailString

Email address

eoriString

EORI

formattedLinesString!

Formatted address

houseNumberString

House number

idID!

Unique primary key.

nameString

Name

ossString

One-Stop Shop (OSS) number

phoneString

Phone number

phoneE164String

Phone number in E.164 format

postalCodeString

Postal code

stateCodeString

State code

vatString

VAT number

updatedAtDateTimeTz!

When the brand was last updated.

canceledAtDateTimeTz

When the order was canceled.

createdAtDateTimeTz!

When the order was created.

addressString

Street / first address line

address2String

Second address line

cityString

City

companyNameString

Company name

countryCodeString!

Country code

emailString

Email address

eoriString

EORI

formattedLinesString!

Formatted address

houseNumberString

House number

idID!

Unique primary key.

nameString

Name

ossString

One-Stop Shop (OSS) number

phoneString

Phone number

phoneE164String

Phone number in E.164 format

postalCodeString

Postal code

stateCodeString

State code

vatString

VAT number

createdAtDateTimeTz!

When the customer was created.

idID!

Unique primary key.

A list of Order edges.

pageInfoPageInfo!

Pagination information about the list of edges.

ordersCountInt!

Customer orders count

addressString

Street / first address line

address2String

Second address line

cityString

City

companyNameString

Company name

countryCodeString!

Country code

emailString

Email address

eoriString

EORI

formattedLinesString!

Formatted address

houseNumberString

House number

idID!

Unique primary key.

nameString

Name

ossString

One-Stop Shop (OSS) number

phoneString

Phone number

phoneE164String

Phone number in E.164 format

postalCodeString

Postal code

stateCodeString

State code

vatString

VAT number

referenceString

Reference of the customer

A list of ReturnRequest edges.

pageInfoPageInfo!

Pagination information about the list of edges.

returnRequestsCountInt!

Customer return requests count

A list of Shipment edges.

pageInfoPageInfo!

Pagination information about the list of edges.

shipmentsCountInt!

Customer shipments count

updatedAtDateTimeTz!

When the customer was last updated.

customsInvoiceNumberString

Invoice number for customs

customsShipmentTypeCustomsShipmentType

Shipment export type for customs

DOCUMENTSGIFTRETURNED_GOODSSALE_GOODSSAMPLE
cursorString!

A unique cursor that can be used for pagination.

nodeEvent!

The Event node.

endCursorString

The cursor to continue paginating forwards.

hasNextPageBoolean!

When paginating forwards, are there more items?

hasPreviousPageBoolean!

When paginating backwards, are there more items?

startCursorString

The cursor to continue paginating backwards.

cursorString!

A unique cursor that can be used for pagination.

The OrderException node.

endCursorString

The cursor to continue paginating forwards.

hasNextPageBoolean!

When paginating forwards, are there more items?

hasPreviousPageBoolean!

When paginating backwards, are there more items?

startCursorString

The cursor to continue paginating backwards.

allocationStrategyOrderAllocationStrategy

Allocation strategy of the order fulfillment preferences.

BULK_NON_PICKABLEFEFOLEFO
fulfillmentModeFulfillmentMode

Fulfillment mode of the order fulfillment preferences.

DELIVERYLOCAL_PICKUP
printPackingSlipBoolean

Print packing slip of the order fulfillment preferences.

returnShippingServiceMethodIdID

ID of the return shipping service method.

shippingServiceMethodIdID

ID of the shipping service method.

cursorString!

A unique cursor that can be used for pagination.

The Fulfillment node.

endCursorString

The cursor to continue paginating forwards.

hasNextPageBoolean!

When paginating forwards, are there more items?

hasPreviousPageBoolean!

When paginating backwards, are there more items?

startCursorString

The cursor to continue paginating backwards.

idID!

Unique primary key.

Category of the integration

invoicingpaymentshippingshop
createdAtDateTimeTz!

When the integration was created.

idID!

Unique primary key.

isEnabledBoolean!

Synchronization enabled

isOrderSyncEnabledBoolean!

Order sync enabled

isProductSyncEnabledBoolean!

Product sync enabled

isStockSyncEnabledBoolean!

Stock sync enabled

nameString!

Name of the integration

orderSyncUpdatedAtDateTimeTz

When the last order was updated at the integration while syncing

integrationReferenceString!

Reference provided by the integration

nameString!

Profile name

productSyncUpdatedAtDateTimeTz

When the last product was updated at the integration while syncing

productsCountInt!

Number of products linked to this integration.

updatedAtDateTimeTz!

When the integration was last updated.

integrationReferenceString

Integration reference of the order

isUpdatableBoolean!

Whether this order can be updated.

cursorString!

A unique cursor that can be used for pagination.

nodeOrderLine!

The OrderLine node.

endCursorString

The cursor to continue paginating forwards.

hasNextPageBoolean!

When paginating forwards, are there more items?

hasPreviousPageBoolean!

When paginating backwards, are there more items?

startCursorString

The cursor to continue paginating backwards.

localeString

BCP-47 locale used for communication templates

cursorString!

A unique cursor that can be used for pagination.

nodeMetafield!

The Metafield node.

endCursorString

The cursor to continue paginating forwards.

hasNextPageBoolean!

When paginating forwards, are there more items?

hasPreviousPageBoolean!

When paginating backwards, are there more items?

startCursorString

The cursor to continue paginating backwards.

quantityAllocatedInt!

Quantity allocated in to fulfillments

quantityOrderedInt!

Quantity ordered

quantityShippedInt!

Quantity (already) shipped

quantityUnallocatedInt!

Quantity that is not (yet) allocated to a fulfillment

addressString

Street / first address line

address2String

Second address line

cityString

City

companyNameString

Company name

countryCodeString!

Country code

emailString

Email address

eoriString

EORI

formattedLinesString!

Formatted address

houseNumberString

House number

idID!

Unique primary key.

nameString

Name

ossString

One-Stop Shop (OSS) number

phoneString

Phone number

phoneE164String

Phone number in E.164 format

postalCodeString

Postal code

stateCodeString

State code

vatString

VAT number

referenceString

Reference of the order

cursorString!

A unique cursor that can be used for pagination.

nodeShipment!

The Shipment node.

endCursorString

The cursor to continue paginating forwards.

hasNextPageBoolean!

When paginating forwards, are there more items?

hasPreviousPageBoolean!

When paginating backwards, are there more items?

startCursorString

The cursor to continue paginating backwards.

shippedAtDateTimeTz

When the order was shipped.

currencyString!

ISO 4217 currency code

valueString!

Amount

statusOrderStatus!

Status of the order

ALLOCATEDCANCELEDCREATEDEXPECTEDPARTIALLY_SHIPPEDSHIPPEDUNALLOCATED
cursorString!

A unique cursor that can be used for pagination.

The SupportTicketAccess node.

endCursorString

The cursor to continue paginating forwards.

hasNextPageBoolean!

When paginating forwards, are there more items?

hasPreviousPageBoolean!

When paginating backwards, are there more items?

startCursorString

The cursor to continue paginating backwards.

updatedAtDateTimeTz!

When the order was last updated.