GraphQL API
Organization API
Organization / Types/ object

OrderLine

An line of an order

Fields

11 fields
idID!

Unique primary key.

nameString!

Name of the ordered product

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

avatarAvatar

Avatar of the brand.

brandPortalsBrandPortalConnection!

Brand portals configured for this brand

communicationTemplatesCommunicationTemplateConnection!

Sparse localized overrides configured for this brand.

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

logoPrintAvatar

Logo print of the brand.

logoScreenAvatar

Logo screen of the brand.

nameString!

Name of the brand

returnAddressAddress

Return address of the brand.

senderAddressAddress

Sender address of the brand.

updatedAtDateTimeTz!

When the brand was last updated.

canceledAtDateTimeTz

When the order was canceled.

createdAtDateTimeTz!

When the order was created.

billingAddressAddress

Billing address of the customer

createdAtDateTimeTz!

When the customer was created.

idID!

Unique primary key.

Customer orders

ordersCountInt!

Customer orders count

recipientAddressAddress

Recipient address of the customer

referenceString

Reference of the customer

returnRequestsReturnRequestConnection!

Customer return requests

returnRequestsCountInt!

Customer return requests count

Customer shipments

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

A list of Event edges.

pageInfoPageInfo!

Pagination information about the list of edges.

A list of OrderException edges.

pageInfoPageInfo!

Pagination information about the list of edges.

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.

A list of Fulfillment edges.

pageInfoPageInfo!

Pagination information about the list of edges.

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

Payment profiles exposed by the integration

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.

A list of OrderLine edges.

pageInfoPageInfo!

Pagination information about the list of edges.

localeString

BCP-47 locale used for communication templates

A list of Metafield edges.

pageInfoPageInfo!

Pagination information about the list of edges.

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

A list of Shipment edges.

pageInfoPageInfo!

Pagination information about the list of edges.

shippedAtDateTimeTz

When the order was shipped.

currencyString!

ISO 4217 currency code

valueString!

Amount

statusOrderStatus!

Status of the order

ALLOCATEDCANCELEDCREATEDEXPECTEDPARTIALLY_SHIPPEDSHIPPEDUNALLOCATED

A list of SupportTicketAccess edges.

pageInfoPageInfo!

Pagination information about the list of edges.

updatedAtDateTimeTz!

When the order was last updated.

idID!

Unique primary key.

nameString!

Name of the ordered product

billingAddressAddress

Billing address of the order

brandBrand!

Brand of the order

canceledAtDateTimeTz

When the order was canceled.

createdAtDateTimeTz!

When the order was created.

customerCustomer

Customer of the order

customsInvoiceNumberString

Invoice number for customs

customsShipmentTypeCustomsShipmentType

Shipment export type for customs

DOCUMENTSGIFTRETURNED_GOODSSALE_GOODSSAMPLE

Events related to this order

Exceptions related to this order

fulfillmentPreferencesOrderFulfillmentPreferences

Fulfillment preferences of the order.

fulfillmentsFulfillmentConnection!

Fulfillments of the order

idID!

Unique primary key.

integrationIntegration

Integration of the order

integrationReferenceString

Integration reference of the order

isUpdatableBoolean!

Whether this order can be updated.

Order lines

localeString

BCP-47 locale used for communication templates

Metafields attached to this order

quantityAllocatedInt!

Quantity allocated in to fulfillments

quantityOrderedInt!

Quantity ordered

quantityShippedInt!

Quantity (already) shipped

quantityUnallocatedInt!

Quantity that is not (yet) allocated to a fulfillment

recipientAddressAddress

Recipient address of the order

referenceString

Reference of the order

Shipments

shippedAtDateTimeTz

When the order was shipped.

shippingPriceMoney

Shipping cost paid by the customer

statusOrderStatus!

Status of the order

ALLOCATEDCANCELEDCREATEDEXPECTEDPARTIALLY_SHIPPEDSHIPPEDUNALLOCATED

Support tickets linked to this order

updatedAtDateTimeTz!

When the order was last updated.

parentLineOrderLine

Parent order line (for bundles)

currencyString!

ISO 4217 currency code

valueString!

Amount

currencyString!

ISO 4217 currency code

valueString!

Amount

Barcodes linked to this product

brandNameString

Brand name of the product

codeString

Article number of the product

costPriceMoney

Cost price of the product

countryCodeOfOriginString

Country code of origin of the product

createdAtDateTimeTz!

When the product was created.

descriptionString

Goods description for customs in English

dimensionsDimensions

Dimensions of the product

hsCodeString

HS code of the product

idID!

Unique primary key.

integrationProductsIntegrationProductConnection!

The integration products associated with this product.

The media associated with this product.

Metafields attached to this product

nameString

Name of the product

Order lines of the product.

partOfBundlesProductPartConnection!

List bundles

List parts

priceMoney

Selling price of the product.

productSuppliersProductSupplierConnection!

Purchasing configuration for suppliers linked to this product.

productWarehousesProductWarehouseConnection!

The product warehouses associated with this product.

purchaseAdviceModePurchaseAdviceMode!

How purchasing advice is calculated for this product.

BACKORDERS_ONLYTARGET_STOCK
quantityAllocatedInt!

Quantity allocated to fulfillments

quantityAvailableInt!

Quantity available

quantityIncomingInt!

Quantity incoming on open purchase orders.

quantityOnHandInt!

Quantity on hand in warehouses

quantityUnallocatedInt!

Total quantity unallocated (backorders) across all order lines

stockMutationsStockMutationConnection!

List stock mutations

List stocks

The suppliers associated with this product.

List linked tags

Type

PHYSICAL_BUNDLESTANDARDVIRTUAL_BUNDLE
updatedAtDateTimeTz!

When the product was last updated.

weightWeight

Weight of the product

quantityAllocatedInt!

Quantity allocated in to fulfillments

quantityOrderedInt!

Quantity ordered

quantityShippedInt!

Quantity (already) shipped

quantityUnallocatedInt!

Quantity that is not (yet) allocated to a fulfillment

currencyString!

ISO 4217 currency code

valueString!

Amount

currencyString!

ISO 4217 currency code

valueString!

Amount

barcodeString!

Barcode

idID!

Unique primary key.

quantityInt!

Quantity of items when scanned

brandNameString

Brand name of the product

codeString

Article number of the product

currencyString!

ISO 4217 currency code

valueString!

Amount

countryCodeOfOriginString

Country code of origin of the product

createdAtDateTimeTz!

When the product was created.

descriptionString

Goods description for customs in English

heightFloat!

Height

lengthFloat!

Length

Unit

CM
widthFloat!

Width

hsCodeString

HS code of the product

idID!

Unique primary key.

A list of IntegrationProduct edges.

pageInfoPageInfo!

Pagination information about the list of edges.

A list of ProductMedia edges.

pageInfoPageInfo!

Pagination information about the list of edges.

A list of Metafield edges.

pageInfoPageInfo!

Pagination information about the list of edges.

nameString

Name of the product

A list of OrderLine edges.

pageInfoPageInfo!

Pagination information about the list of edges.

A list of ProductPart edges.

pageInfoPageInfo!

Pagination information about the list of edges.

A list of ProductPart edges.

pageInfoPageInfo!

Pagination information about the list of edges.

currencyString!

ISO 4217 currency code

valueString!

Amount

A list of ProductSupplier edges.

pageInfoPageInfo!

Pagination information about the list of edges.

A list of ProductWarehouse edges.

pageInfoPageInfo!

Pagination information about the list of edges.

purchaseAdviceModePurchaseAdviceMode!

How purchasing advice is calculated for this product.

BACKORDERS_ONLYTARGET_STOCK
quantityAllocatedInt!

Quantity allocated to fulfillments

quantityAvailableInt!

Quantity available

quantityIncomingInt!

Quantity incoming on open purchase orders.

quantityOnHandInt!

Quantity on hand in warehouses

quantityUnallocatedInt!

Total quantity unallocated (backorders) across all order lines

A list of StockMutation edges.

pageInfoPageInfo!

Pagination information about the list of edges.

A list of Stock edges.

pageInfoPageInfo!

Pagination information about the list of edges.

A list of Supplier edges.

pageInfoPageInfo!

Pagination information about the list of edges.

edges[TagEdge!]!

A list of Tag edges.

pageInfoPageInfo!

Pagination information about the list of edges.

Type

PHYSICAL_BUNDLESTANDARDVIRTUAL_BUNDLE
updatedAtDateTimeTz!

When the product was last updated.

Weight unit

GKGLBSOZ
valueFloat!

Weight value

quantityAllocatedInt!

Quantity allocated in to fulfillments

quantityOrderedInt!

Quantity ordered

quantityShippedInt!

Quantity (already) shipped

quantityUnallocatedInt!

Quantity that is not (yet) allocated to a fulfillment