Skip to main content

OrderItem

order
REQUIRED

Type: string (format: iri-reference)

The order reference to which the order item belongs.

Example: d20215c9-0691-4783-a2f0-fb56938e5a78

productName

Type: string|null

The name of the product.

Example: Black Leather Jacket

productSku

Type: string|null

The SKU of the product.

Example: JACKET-BLACK-LEATHER

productOptions

Type: array

The list of product custom options (size, color, weight, etc.) in the form OPTION_CODE => OPTION_VALUE.

Example: ['size'=>'L', 'color'=>'black', 'fabric'=>'leather']

qty

Type: integer|null

The number of items that were purchased. Default value is 0.

Example: 10

price

Type: string|null

The price of the item in the shop currency. Default value is 0.

Example: 19.99

rowTotal

Type: string|null

The amount of the purchased item in the shop currency. Calculated as qty * price.

Example: 199.90

externalProductId

Type: string|null

The id of the product in ecommerce store (WooCommerce, Shopify, etc.).

Example: wp_001245

externalSourceSyncId

Type: string|null

The id of the order item in ecommerce store (WooCommerce, Shopify, etc.).

Example: woi_123456

externalSourceIntegration

Type: string|null (format: iri-reference)

The workflow reference to integration for ecommerce store.

Example: /workflows/a0b97939-5aea-4b35-b7c6-64f56bff1721

product

Type: string|null (format: iri-reference)

The product reference to which this item is related.

Example: /products/1deec359-5c4c-46a5-81ed-95daa5cb47f3

productVariant

Type: string|null (format: iri-reference)

The product variant to which this item is related.

Example: /product_variants/c1f6ca51-bbde-46ca-941a-8032abc544c3

imageUrl

Type: string|null (format: URL)

The link to a product image in ecommerce store (WooCommerce, Shopify, etc.).

Example: http://my-store.com/media/catalog/black-leather-jacket.jpg

fulfilledQty

Type: integer|null

The number of items that were fulfilled. Calculated as the amount of all shipmentItem.qty

Example: 5

id
READ-ONLY

Type: string (format: uuid)

A version 4 UUID. A unique order item identifier is used in API requests.

Example: 5a1ce5d8-9525-4888-b96c-f6cb637bb7e6

externalProductLink
READ-ONLY

Type: string|null

currency
READ-ONLY

Type: string