OrderItem
order | Type: string (format: iri-reference) The order reference to which the order item belongs. Example: |
productName | Type: string|null The name of the product. Example: |
productSku | Type: string|null The SKU of the product. Example: |
productOptions | Type: object The list of product custom options (size, color, weight, etc.) in the form OPTION_CODE => OPTION_VALUE. Example: |
qty | Type: integer|null The number of items that were purchased. Default value is 0. Example: |
price | Type: string|null The price of the item in the shop currency. Default value is 0. Example: |
rowTotal | Type: string|null The amount of the purchased item in the shop currency. Calculated as qty * price. Example: |
externalProductId | Type: string|null The id of the product in ecommerce store (WooCommerce, Shopify, etc.). Example: |
externalSourceSyncId | Type: string|null The id of the order item in ecommerce store (WooCommerce, Shopify, etc.). Example: |
externalSourceIntegration | Type: string|null (format: iri-reference) The workflow reference to integration for ecommerce store. Example: |
product | Type: string|null (format: iri-reference) The product reference to which this item is related. Example: |
productVariant | Type: string|null (format: iri-reference) The product variant to which this item is related. Example: |
imageUrl | Type: string|null (format: URL) The link to a product image in ecommerce store (WooCommerce, Shopify, etc.). Example: |
fulfilledQty | Type: integer|null The number of items that were fulfilled. Calculated as the amount of all shipmentItem.qty Example: |
id | Type: string (format: uuid) A version 4 UUID. A unique order item identifier is used in API requests. Example: |
externalProductLink | Type: string|null |
currency | Type: string |