GraphQL API
Organization API
Organization / Types/ object

OrderCreateLinePayload

The response for the mutation containing the result and user errors.

Fields

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

field[String!]
messageString!