GraphQL API
Organization API
Organization / Types/ object

OrderLineUpdatePayload

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

Fields

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

messageString!
field[String!]