GraphQL API
Organization API
Organization / Types/ object

Order

An order of the organization

Fields

30 fields
address•String

Street / first address line

address2•String

Second address line

city•String

City

companyName•String

Company name

countryCode•String!

Country code

email•String

Email address

eori•String

EORI

formattedLines•String!

Formatted address

houseNumber•String

House number

id•ID!

Unique primary key.

name•String

Name

oss•String

One-Stop Shop (OSS) number

phone•String

Phone number

phoneE164•String

Phone number in E.164 format

postalCode•String

Postal code

stateCode•String

State code

vat•String

VAT number

url•String!

Url of the avatar

A list of BrandPortal edges.

pageInfo•PageInfo!

Pagination information about the list of edges.

A list of CommunicationTemplate edges.

pageInfo•PageInfo!

Pagination information about the list of edges.

createdAt•DateTimeTz!

When the brand was created.

customsShipmentType•CustomsShipmentType

Default customs shipment to use for shipments

DOCUMENTSGIFTRETURNED_GOODSSALE_GOODSSAMPLE
customsUseReferenceIfInvoiceNumberEmpty•Boolean!

Use reference if invoice number is empty

id•ID!

Unique primary key.

inboundGBEori•String

Import EORI for GB

inboundGBVat•String

Import VAT number for GB

url•String!

Url of the avatar

url•String!

Url of the avatar

name•String!

Name of the brand

address•String

Street / first address line

address2•String

Second address line

city•String

City

companyName•String

Company name

countryCode•String!

Country code

email•String

Email address

eori•String

EORI

formattedLines•String!

Formatted address

houseNumber•String

House number

id•ID!

Unique primary key.

name•String

Name

oss•String

One-Stop Shop (OSS) number

phone•String

Phone number

phoneE164•String

Phone number in E.164 format

postalCode•String

Postal code

stateCode•String

State code

vat•String

VAT number

address•String

Street / first address line

address2•String

Second address line

city•String

City

companyName•String

Company name

countryCode•String!

Country code

email•String

Email address

eori•String

EORI

formattedLines•String!

Formatted address

houseNumber•String

House number

id•ID!

Unique primary key.

name•String

Name

oss•String

One-Stop Shop (OSS) number

phone•String

Phone number

phoneE164•String

Phone number in E.164 format

postalCode•String

Postal code

stateCode•String

State code

vat•String

VAT number

updatedAt•DateTimeTz!

When the brand was last updated.

canceledAt•DateTimeTz

When the order was canceled.

createdAt•DateTimeTz!

When the order was created.

address•String

Street / first address line

address2•String

Second address line

city•String

City

companyName•String

Company name

countryCode•String!

Country code

email•String

Email address

eori•String

EORI

formattedLines•String!

Formatted address

houseNumber•String

House number

id•ID!

Unique primary key.

name•String

Name

oss•String

One-Stop Shop (OSS) number

phone•String

Phone number

phoneE164•String

Phone number in E.164 format

postalCode•String

Postal code

stateCode•String

State code

vat•String

VAT number

createdAt•DateTimeTz!

When the customer was created.

id•ID!

Unique primary key.

A list of Order edges.

pageInfo•PageInfo!

Pagination information about the list of edges.

ordersCount•Int!

Customer orders count

address•String

Street / first address line

address2•String

Second address line

city•String

City

companyName•String

Company name

countryCode•String!

Country code

email•String

Email address

eori•String

EORI

formattedLines•String!

Formatted address

houseNumber•String

House number

id•ID!

Unique primary key.

name•String

Name

oss•String

One-Stop Shop (OSS) number

phone•String

Phone number

phoneE164•String

Phone number in E.164 format

postalCode•String

Postal code

stateCode•String

State code

vat•String

VAT number

reference•String

Reference of the customer

A list of ReturnRequest edges.

pageInfo•PageInfo!

Pagination information about the list of edges.

returnRequestsCount•Int!

Customer return requests count

A list of Shipment edges.

pageInfo•PageInfo!

Pagination information about the list of edges.

shipmentsCount•Int!

Customer shipments count

updatedAt•DateTimeTz!

When the customer was last updated.

customsInvoiceNumber•String

Invoice number for customs

customsShipmentType•CustomsShipmentType

Shipment export type for customs

DOCUMENTSGIFTRETURNED_GOODSSALE_GOODSSAMPLE
cursor•String!

A unique cursor that can be used for pagination.

node•Event!

The Event node.

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.

cursor•String!

A unique cursor that can be used for pagination.

The OrderException node.

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.

allocationStrategy•OrderAllocationStrategy

Allocation strategy of the order fulfillment preferences.

BULK_NON_PICKABLEFEFOLEFO
fulfillmentMode•FulfillmentMode

Fulfillment mode of the order fulfillment preferences.

DELIVERYLOCAL_PICKUP
printPackingSlip•Boolean

Print packing slip of the order fulfillment preferences.

returnShippingServiceMethodId•ID

ID of the return shipping service method.

shippingServiceMethodId•ID

ID of the shipping service method.

cursor•String!

A unique cursor that can be used for pagination.

The Fulfillment node.

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.

id•ID!

Unique primary key.

Category of the integration

invoicingpaymentshippingshop
createdAt•DateTimeTz!

When the integration was created.

id•ID!

Unique primary key.

isEnabled•Boolean!

Synchronization enabled

isOrderSyncEnabled•Boolean!

Order sync enabled

isProductSyncEnabled•Boolean!

Product sync enabled

isStockSyncEnabled•Boolean!

Stock sync enabled

name•String!

Name of the integration

orderSyncUpdatedAt•DateTimeTz

When the last order was updated at the integration while syncing

integrationReference•String!

Reference provided by the integration

name•String!

Profile name

productSyncUpdatedAt•DateTimeTz

When the last product was updated at the integration while syncing

productsCount•Int!

Number of products linked to this integration.

updatedAt•DateTimeTz!

When the integration was last updated.

integrationReference•String

Integration reference of the order

isUpdatable•Boolean!

Whether this order can be updated.

cursor•String!

A unique cursor that can be used for pagination.

node•OrderLine!

The OrderLine node.

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.

locale•String

BCP-47 locale used for communication templates

cursor•String!

A unique cursor that can be used for pagination.

node•Metafield!

The Metafield node.

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.

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

address•String

Street / first address line

address2•String

Second address line

city•String

City

companyName•String

Company name

countryCode•String!

Country code

email•String

Email address

eori•String

EORI

formattedLines•String!

Formatted address

houseNumber•String

House number

id•ID!

Unique primary key.

name•String

Name

oss•String

One-Stop Shop (OSS) number

phone•String

Phone number

phoneE164•String

Phone number in E.164 format

postalCode•String

Postal code

stateCode•String

State code

vat•String

VAT number

reference•String

Reference of the order

cursor•String!

A unique cursor that can be used for pagination.

node•Shipment!

The Shipment node.

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.

shippedAt•DateTimeTz

When the order was shipped.

currency•String!

ISO 4217 currency code

value•String!

Amount

status•OrderStatus!

Status of the order

ALLOCATEDCANCELEDCREATEDEXPECTEDPARTIALLY_SHIPPEDSHIPPEDUNALLOCATED
cursor•String!

A unique cursor that can be used for pagination.

The SupportTicketAccess node.

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.

updatedAt•DateTimeTz!

When the order was last updated.