GraphQL API
Organization API
Organization / Types/ object

OrderLine

An line of an order

Fields

11 fields
idID!

Unique primary key.

idID!

Unique primary key.

parentLineOrderLine

Parent order line (for bundles)

idID!

Unique primary key.

nameString

Name of the product

brandNameString

Brand name of the product

codeString

Article number of the product

costPriceMoney

Cost price of the product

priceMoney

Selling price of the product.

dimensionsDimensions

Dimensions of the product

weightWeight

Weight of the product

hsCodeString

HS code of the product

countryCodeOfOriginString

Country code of origin of the product

descriptionString

Goods description for customs in English

quantityAllocatedInt!

Quantity allocated to fulfillments

quantityOnHandInt!

Quantity on hand in warehouses

quantityAvailableInt!

Quantity available

quantityUnallocatedInt!

Total quantity unallocated (backorders) across all order lines

Type

STANDARDVIRTUAL_BUNDLEPHYSICAL_BUNDLE
createdAtDateTimeTz!

When the product was created.

updatedAtDateTimeTz!

When the product was last updated.

Barcodes linked to this product

Metafields attached to this product

integrationProductsIntegrationProductConnection!

The integration products associated with this product.

Order lines of the product.

productWarehousesProductWarehouseConnection!

The product warehouses associated with this product.

The suppliers associated with this product.

The media associated with this product.

List stocks

stockMutationsStockMutationConnection!

List stock mutations

partOfBundlesProductPartConnection!

List bundles

List parts

List linked tags

nameString!

Name of the ordered product

currencyString!

ISO 4217 currency code

valueString!

Amount

currencyString!

ISO 4217 currency code

valueString!

Amount

quantityOrderedInt!

Quantity ordered

quantityAllocatedInt!

Quantity allocated in to fulfillments

quantityShippedInt!

Quantity (already) shipped

quantityUnallocatedInt!

Quantity that is not (yet) allocated to a fulfillment

idID!

Unique primary key.

integrationReferenceString

Integration reference of the order

quantityOrderedInt!

Quantity ordered

quantityAllocatedInt!

Quantity allocated in to fulfillments

quantityShippedInt!

Quantity (already) shipped

quantityUnallocatedInt!

Quantity that is not (yet) allocated to a fulfillment

referenceString

Reference of the order

shippingPriceMoney

Shipping cost paid by the customer

statusOrderStatus!

Status of the order

CANCELEDCREATEDEXPECTEDALLOCATEDPARTIALLY_SHIPPEDSHIPPEDUNALLOCATED
customsInvoiceNumberString

Invoice number for customs

customsShipmentTypeCustomsShipmentType

Shipment export type for customs

DOCUMENTSGIFTRETURNED_GOODSSALE_GOODSSAMPLE
localeString

BCP-47 locale used for communication templates

canceledAtDateTimeTz

When the order was canceled.

shippedAtDateTimeTz

When the order was shipped.

createdAtDateTimeTz!

When the order was created.

updatedAtDateTimeTz!

When the order was last updated.

isUpdatableBoolean!

Whether this order can be updated.

brandBrand!

Brand of the order

billingAddressAddress

Billing address of the order

recipientAddressAddress

Recipient address of the order

customerCustomer

Customer of the order

integrationIntegration

Integration of the order

fulfillmentPreferencesOrderFulfillmentPreferences

Fulfillment preferences of the order.

fulfillmentsFulfillmentConnection!

Fulfillments of the order

Order lines

Events related to this order

Exceptions related to this order

Metafields attached to this order

Shipments

Support tickets linked to this order

idID!

Unique primary key.

nameString

Name of the product

brandNameString

Brand name of the product

codeString

Article number of the product

currencyString!

ISO 4217 currency code

valueString!

Amount

currencyString!

ISO 4217 currency code

valueString!

Amount

heightFloat!

Height

lengthFloat!

Length

widthFloat!

Width

Unit

CM
valueFloat!

Weight value

Weight unit

GKGOZLBS
hsCodeString

HS code of the product

countryCodeOfOriginString

Country code of origin of the product

descriptionString

Goods description for customs in English

quantityAllocatedInt!

Quantity allocated to fulfillments

quantityOnHandInt!

Quantity on hand in warehouses

quantityAvailableInt!

Quantity available

quantityUnallocatedInt!

Total quantity unallocated (backorders) across all order lines

Type

STANDARDVIRTUAL_BUNDLEPHYSICAL_BUNDLE
createdAtDateTimeTz!

When the product was created.

updatedAtDateTimeTz!

When the product was last updated.

idID!

Unique primary key.

barcodeString!

Barcode

quantityInt!

Quantity of items when scanned

pageInfoPageInfo!

Pagination information about the list of edges.

A list of Metafield edges.

pageInfoPageInfo!

Pagination information about the list of edges.

A list of IntegrationProduct edges.

pageInfoPageInfo!

Pagination information about the list of edges.

A list of OrderLine edges.

pageInfoPageInfo!

Pagination information about the list of edges.

A list of ProductWarehouse edges.

pageInfoPageInfo!

Pagination information about the list of edges.

A list of Supplier 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 Stock edges.

pageInfoPageInfo!

Pagination information about the list of edges.

A list of StockMutation 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.

edges[TagEdge!]!

A list of Tag edges.

nameString!

Name of the ordered product

currencyString!

ISO 4217 currency code

valueString!

Amount

currencyString!

ISO 4217 currency code

valueString!

Amount

quantityOrderedInt!

Quantity ordered

quantityAllocatedInt!

Quantity allocated in to fulfillments

quantityShippedInt!

Quantity (already) shipped

quantityUnallocatedInt!

Quantity that is not (yet) allocated to a fulfillment

idID!

Unique primary key.

integrationReferenceString

Integration reference of the order

quantityOrderedInt!

Quantity ordered

quantityAllocatedInt!

Quantity allocated in to fulfillments

quantityShippedInt!

Quantity (already) shipped

quantityUnallocatedInt!

Quantity that is not (yet) allocated to a fulfillment

referenceString

Reference of the order

currencyString!

ISO 4217 currency code

valueString!

Amount

statusOrderStatus!

Status of the order

CANCELEDCREATEDEXPECTEDALLOCATEDPARTIALLY_SHIPPEDSHIPPEDUNALLOCATED
customsInvoiceNumberString

Invoice number for customs

customsShipmentTypeCustomsShipmentType

Shipment export type for customs

DOCUMENTSGIFTRETURNED_GOODSSALE_GOODSSAMPLE
localeString

BCP-47 locale used for communication templates

canceledAtDateTimeTz

When the order was canceled.

shippedAtDateTimeTz

When the order was shipped.

createdAtDateTimeTz!

When the order was created.

updatedAtDateTimeTz!

When the order was last updated.

isUpdatableBoolean!

Whether this order can be updated.

idID!

Unique primary key.

nameString!

Name of the brand

customsShipmentTypeCustomsShipmentType

Default customs shipment to use for shipments

DOCUMENTSGIFTRETURNED_GOODSSALE_GOODSSAMPLE
customsUseReferenceIfInvoiceNumberEmptyBoolean!

Use reference if invoice number is empty

inboundGBEoriString

Import EORI for GB

inboundGBVatString

Import VAT number for GB

createdAtDateTimeTz!

When the brand was created.

updatedAtDateTimeTz!

When the brand was last updated.

avatarAvatar

Avatar of the brand.

logoPrintAvatar

Logo print of the brand.

logoScreenAvatar

Logo screen of the brand.

senderAddressAddress

Sender address of the brand.

returnAddressAddress

Return address of the brand.

brandPortalsBrandPortalConnection!

Brand portals configured for this brand

communicationTemplatesCommunicationTemplateConnection!

Sparse localized overrides configured for this brand.

idID!

Unique primary key.

companyNameString

Company name

nameString

Name

addressString

Street / first address line

address2String

Second address line

houseNumberString

House number

postalCodeString

Postal code

cityString

City

stateCodeString

State code

countryCodeString!

Country code

emailString

Email address

phoneString

Phone number

phoneE164String

Phone number in E.164 format

eoriString

EORI

vatString

VAT number

ossString

One-Stop Shop (OSS) number

formattedLinesString!

Formatted address

idID!

Unique primary key.

companyNameString

Company name

nameString

Name

addressString

Street / first address line

address2String

Second address line

houseNumberString

House number

postalCodeString

Postal code

cityString

City

stateCodeString

State code

countryCodeString!

Country code

emailString

Email address

phoneString

Phone number

phoneE164String

Phone number in E.164 format

eoriString

EORI

vatString

VAT number

ossString

One-Stop Shop (OSS) number

formattedLinesString!

Formatted address

idID!

Unique primary key.

referenceString

Reference of the customer

billingAddressAddress

Billing address of the customer

recipientAddressAddress

Recipient address of the customer

createdAtDateTimeTz!

When the customer was created.

updatedAtDateTimeTz!

When the customer was last updated.

ordersCountInt!

Customer orders count

returnRequestsCountInt!

Customer return requests count

shipmentsCountInt!

Customer shipments count

Customer orders

returnRequestsReturnRequestConnection!

Customer return requests

Customer shipments

idID!

Unique primary key.

isEnabledBoolean!

Synchronization enabled

Category of the integration

invoicingpaymentshopshipping
nameString!

Name of the integration

isOrderSyncEnabledBoolean!

Order sync enabled

orderSyncUpdatedAtDateTimeTz

When the last order was updated at the integration while syncing

isProductSyncEnabledBoolean!

Product sync enabled

productSyncUpdatedAtDateTimeTz

When the last product was updated at the integration while syncing

isStockSyncEnabledBoolean!

Stock sync enabled

Payment profiles exposed by the integration

createdAtDateTimeTz!

When the integration was created.

updatedAtDateTimeTz!

When the integration was last updated.

shippingServiceMethodIdID

ID of the shipping service method.

returnShippingServiceMethodIdID

ID of the return shipping service method.

printPackingSlipBoolean

Print packing slip of the order fulfillment preferences.

fulfillmentModeFulfillmentMode

Fulfillment mode of the order fulfillment preferences.

DELIVERYLOCAL_PICKUP
allocationStrategyOrderAllocationStrategy

Allocation strategy of the order fulfillment preferences.

FEFOLEFOBULK_NON_PICKABLE
pageInfoPageInfo!

Pagination information about the list of edges.

A list of Fulfillment edges.

pageInfoPageInfo!

Pagination information about the list of edges.

A list of OrderLine edges.

pageInfoPageInfo!

Pagination information about the list of edges.

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.

A list of Metafield edges.

pageInfoPageInfo!

Pagination information about the list of edges.

A list of Shipment edges.

pageInfoPageInfo!

Pagination information about the list of edges.

A list of SupportTicketAccess edges.