Organization / Orders

order

Find a single order by an identifying attribute.

Arguments

idID

Search by primary key.

Returns

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 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

nameString!

Name of the brand

replyToEmailAddressString

Email address customer replies to brand emails go to; none when empty.

senderEmailAddressString

Email address customer emails are sent from once its domain is verified; until then they come from the brand portal domain.

updatedAtDateTimeTz!

When the brand was last updated.

canceledAtDateTimeTz

When the order was canceled.

checkoutShippingMethodNameString

Name of the shipping method the customer chose at checkout, as provided by the sales channel

createdAtDateTimeTz!

When the order was created.

createdAtDateTimeTz!

When the customer was created.

idID!

Unique primary key.

ordersCountInt!

Customer orders count

referenceString

Reference of the customer

returnRequestsCountInt!

Customer return requests count

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
fulfillmentMergeAllowedBoolean!

Whether the sales channel allows this order in a combined fulfillment.

fulfillmentMergePreferenceOrderFulfillmentMergePreference!

Combination preference for processing this order in a combined fulfillment. Orders remain separate.

AUTOMATICMANUAL_ONLYNEVER
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.

idID!

Unique primary key.

categoryConnectorCategory!

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

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.

localeString

BCP-47 locale used for communication templates

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

shippedAtDateTimeTz

When the order was shipped.

carrierCodeString

Preferred carrier code.

carrierServicePointCodeString

Carrier service point identifier.

deliveryDateString

Requested delivery date.

featuresMixed

Individual shipping feature requirements.

handoverDateString

Requested handover date.

integrationServicePointCodeString

Integration service point identifier.

integrationServicePointTypeString

Integration service point provider.

currencyString!

ISO 4217 currency code

valueString!

Amount

statusOrderStatus!

Status of the order

ALLOCATEDCANCELEDCREATEDEXPECTEDPARTIALLY_SHIPPEDSHIPPEDUNALLOCATED
updatedAtDateTimeTz!

When the order was last updated.