order
Find a single order by an identifying attribute.
Arguments
1 argumentid•IDSearch by primary key.
Possible return
address•StringStreet / first address line
address2•StringSecond address line
city•StringCity
companyName•StringCompany name
countryCode•String!Country code
email•StringEmail address
eori•StringEORI
formattedLines•String!Formatted address
houseNumber•StringHouse number
id•ID!Unique primary key.
name•StringName
oss•StringOne-Stop Shop (OSS) number
phone•StringPhone number
phoneE164•StringPhone number in E.164 format
postalCode•StringPostal code
stateCode•StringState code
vat•StringVAT number
createdAt•DateTimeTz!When the brand was created.
customsShipmentType•CustomsShipmentTypeDefault customs shipment to use for shipments
DOCUMENTSGIFTRETURNED_GOODSSALE_GOODSSAMPLEcustomsUseReferenceIfInvoiceNumberEmpty•Boolean!Use reference if invoice number is empty
id•ID!Unique primary key.
inboundGBEori•StringImport EORI for GB
inboundGBVat•StringImport VAT number for GB
name•String!Name of the brand
updatedAt•DateTimeTz!When the brand was last updated.
canceledAt•DateTimeTzWhen the order was canceled.
createdAt•DateTimeTz!When the order was created.
createdAt•DateTimeTz!When the customer was created.
id•ID!Unique primary key.
ordersCount•Int!Customer orders count
reference•StringReference of the customer
returnRequestsCount•Int!Customer return requests count
shipmentsCount•Int!Customer shipments count
updatedAt•DateTimeTz!When the customer was last updated.
customsInvoiceNumber•StringInvoice number for customs
customsShipmentType•CustomsShipmentTypeShipment export type for customs
DOCUMENTSGIFTRETURNED_GOODSSALE_GOODSSAMPLEallocationStrategy•OrderAllocationStrategyAllocation strategy of the order fulfillment preferences.
BULK_NON_PICKABLEFEFOLEFOfulfillmentMode•FulfillmentModeFulfillment mode of the order fulfillment preferences.
DELIVERYLOCAL_PICKUPprintPackingSlip•BooleanPrint packing slip of the order fulfillment preferences.
returnShippingServiceMethodId•IDID of the return shipping service method.
shippingServiceMethodId•IDID of the shipping service method.
id•ID!Unique primary key.
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•DateTimeTzWhen the last order was updated at the integration while syncing
productSyncUpdatedAt•DateTimeTzWhen 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•StringIntegration reference of the order
isUpdatable•Boolean!Whether this order can be updated.
locale•StringBCP-47 locale used for communication templates
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•StringStreet / first address line
address2•StringSecond address line
city•StringCity
companyName•StringCompany name
countryCode•String!Country code
email•StringEmail address
eori•StringEORI
formattedLines•String!Formatted address
houseNumber•StringHouse number
id•ID!Unique primary key.
name•StringName
oss•StringOne-Stop Shop (OSS) number
phone•StringPhone number
phoneE164•StringPhone number in E.164 format
postalCode•StringPostal code
stateCode•StringState code
vat•StringVAT number
reference•StringReference of the order
shippedAt•DateTimeTzWhen the order was shipped.
currency•String!ISO 4217 currency code
value•String!Amount
status•OrderStatus!Status of the order
ALLOCATEDCANCELEDCREATEDEXPECTEDPARTIALLY_SHIPPEDSHIPPEDUNALLOCATEDupdatedAt•DateTimeTz!When the order was last updated.