Order
An order of the organization
Fields
addressStringStreet / first address line
address2StringSecond address line
cityStringCity
companyNameStringCompany name
countryCodeString!Country code
emailStringEmail address
eoriStringEORI
formattedLinesString!Formatted address
houseNumberStringHouse number
idID!Unique primary key.
nameStringName
ossStringOne-Stop Shop (OSS) number
phoneStringPhone number
phoneE164StringPhone number in E.164 format
postalCodeStringPostal code
stateCodeStringState code
vatStringVAT number
urlString!Url of the avatar
edges[BrandPortalEdge!]!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.
customsShipmentTypeCustomsShipmentTypeDefault customs shipment to use for shipments
DOCUMENTSGIFTRETURNED_GOODSSALE_GOODSSAMPLEcustomsUseReferenceIfInvoiceNumberEmptyBoolean!Use reference if invoice number is empty
idID!Unique primary key.
inboundGBEoriStringImport EORI for GB
inboundGBVatStringImport VAT number for GB
urlString!Url of the avatar
urlString!Url of the avatar
nameString!Name of the brand
replyToEmailAddressStringEmail address customer replies to brand emails go to; none when empty.
addressStringStreet / first address line
address2StringSecond address line
cityStringCity
companyNameStringCompany name
countryCodeString!Country code
emailStringEmail address
eoriStringEORI
formattedLinesString!Formatted address
houseNumberStringHouse number
idID!Unique primary key.
nameStringName
ossStringOne-Stop Shop (OSS) number
phoneStringPhone number
phoneE164StringPhone number in E.164 format
postalCodeStringPostal code
stateCodeStringState code
vatStringVAT number
addressStringStreet / first address line
address2StringSecond address line
cityStringCity
companyNameStringCompany name
countryCodeString!Country code
emailStringEmail address
eoriStringEORI
formattedLinesString!Formatted address
houseNumberStringHouse number
idID!Unique primary key.
nameStringName
ossStringOne-Stop Shop (OSS) number
phoneStringPhone number
phoneE164StringPhone number in E.164 format
postalCodeStringPostal code
stateCodeStringState code
vatStringVAT number
senderEmailAddressStringEmail address customer emails are sent from once its domain is verified; until then they come from the brand portal domain.
createdAtDateTimeTz!When the email domain was created.
dnsRecords[EmailDomainDnsRecord!]!DNS records to publish at the domain's DNS provider.
domainString!Domain name, e.g. `brand.com`.
idID!Unique primary key.
lastCheckedAtDateTimeTzWhen the DNS records were last checked.
statusEmailDomainStatus!Verified once every DNS record is verified; only then brands send from it.
FAILEDPENDINGVERIFIEDupdatedAtDateTimeTz!When the email domain was last updated.
updatedAtDateTimeTz!When the brand was last updated.
canceledAtDateTimeTzWhen the order was canceled.
checkoutShippingMethodNameStringName of the shipping method the customer chose at checkout, as provided by the sales channel
createdAtDateTimeTz!When the order was created.
addressStringStreet / first address line
address2StringSecond address line
cityStringCity
companyNameStringCompany name
countryCodeString!Country code
emailStringEmail address
eoriStringEORI
formattedLinesString!Formatted address
houseNumberStringHouse number
idID!Unique primary key.
nameStringName
ossStringOne-Stop Shop (OSS) number
phoneStringPhone number
phoneE164StringPhone number in E.164 format
postalCodeStringPostal code
stateCodeStringState code
vatStringVAT number
createdAtDateTimeTz!When the customer was created.
idID!Unique primary key.
edges[OrderEdge!]!A list of Order edges.
pageInfoPageInfo!Pagination information about the list of edges.
ordersCountInt!Customer orders count
addressStringStreet / first address line
address2StringSecond address line
cityStringCity
companyNameStringCompany name
countryCodeString!Country code
emailStringEmail address
eoriStringEORI
formattedLinesString!Formatted address
houseNumberStringHouse number
idID!Unique primary key.
nameStringName
ossStringOne-Stop Shop (OSS) number
phoneStringPhone number
phoneE164StringPhone number in E.164 format
postalCodeStringPostal code
stateCodeStringState code
vatStringVAT number
referenceStringReference of the customer
A list of ReturnRequest edges.
pageInfoPageInfo!Pagination information about the list of edges.
returnRequestsCountInt!Customer return requests count
edges[ShipmentEdge!]!A list of Shipment edges.
pageInfoPageInfo!Pagination information about the list of edges.
shipmentsCountInt!Customer shipments count
updatedAtDateTimeTz!When the customer was last updated.
customsInvoiceNumberStringInvoice number for customs
customsShipmentTypeCustomsShipmentTypeShipment export type for customs
DOCUMENTSGIFTRETURNED_GOODSSALE_GOODSSAMPLEcursorString!A unique cursor that can be used for pagination.
nodeEvent!The Event node.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
cursorString!A unique cursor that can be used for pagination.
nodeOrderException!The OrderException node.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
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_ONLYNEVERallocationStrategyOrderAllocationStrategyAllocation strategy of the order fulfillment preferences.
BULK_NON_PICKABLEFEFOLEFOfulfillmentModeFulfillmentModeFulfillment mode of the order fulfillment preferences.
DELIVERYLOCAL_PICKUPprintPackingSlipBooleanPrint packing slip of the order fulfillment preferences.
returnShippingServiceMethodIdIDID of the return shipping service method.
shippingServiceMethodIdIDID of the shipping service method.
cursorString!A unique cursor that can be used for pagination.
nodeFulfillment!The Fulfillment node.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
idID!Unique primary key.
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
orderSyncUpdatedAtDateTimeTzWhen the last order was updated at the integration while syncing
integrationReferenceString!Reference provided by the integration
nameString!Profile name
productSyncUpdatedAtDateTimeTzWhen 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.
integrationReferenceStringIntegration 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.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
localeStringBCP-47 locale used for communication templates
cursorString!A unique cursor that can be used for pagination.
nodeMetafield!The Metafield node.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe 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
addressStringStreet / first address line
address2StringSecond address line
cityStringCity
companyNameStringCompany name
countryCodeString!Country code
emailStringEmail address
eoriStringEORI
formattedLinesString!Formatted address
houseNumberStringHouse number
idID!Unique primary key.
nameStringName
ossStringOne-Stop Shop (OSS) number
phoneStringPhone number
phoneE164StringPhone number in E.164 format
postalCodeStringPostal code
stateCodeStringState code
vatStringVAT number
referenceStringReference of the order
cursorString!A unique cursor that can be used for pagination.
nodeShipment!The Shipment node.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
shippedAtDateTimeTzWhen the order was shipped.
carrierCodeStringPreferred carrier code.
carrierServicePointCodeStringCarrier service point identifier.
deliveryDateStringRequested delivery date.
featuresMixedIndividual shipping feature requirements.
handoverDateStringRequested handover date.
amountMoneyOptional minimum coverage, including its currency.
Minimum fixed coverage or the calculated contents value.
CONTENTS_VALUEMINIMUMintegrationServicePointCodeStringIntegration service point identifier.
integrationServicePointTypeStringIntegration service point provider.
currencyString!ISO 4217 currency code
valueString!Amount
statusOrderStatus!Status of the order
ALLOCATEDCANCELEDCREATEDEXPECTEDPARTIALLY_SHIPPEDSHIPPEDUNALLOCATEDcursorString!A unique cursor that can be used for pagination.
The SupportTicketAccess node.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
updatedAtDateTimeTz!When the order was last updated.