id
Type: string
Description: The (technical) unique identifier of the order item in this order.
Example Value(s): '123456789' or 'A-2344234230-B'
productName
Type: string
Description: Name of the product (model).
Example Value(s): 'Awesome Porridge - Cinamon' or 'Nike Air Max 90'
productId
Type: string
Description: The (technical) unique identifier of the product in your (shop) system.
Example Value(s): '123456789' or 'A-2344234230-B'
productVariantName
Type: string
Description: Title of the variant of the product (model).
Example Value(s): 'Awesome Porridge - Cinamon - 250g' or 'Nike Air Max 90 - Size 10'
productVariantId
Type: string
Description: The (technical) unique identifier of the product variant in your (shop) system.
Example Value(s): '123456790' or 'A-2344234230-B-10'
productBrand
Type: string
Description: The brand of the product.
Example Value(s): 'Awesome Foods'
productCollection
Type: string
Description: The product collection or category.
Example Value(s): 'Porridge' or 'Sneakers' or 'Shoes > Sneakers'
productCogs
Type: number
Description: The Cost of Goods Sold (COGS) for this product.
Example Value(s): 3.50 or 0.99
productGmv
Type: number
Description: The product's gross merchandise value or recomended retail price for one of the product items.
Example Value(s): 19.99 or 35
productShippingWeightInGrams
Type: number
Description: The weight of the product in grams.
Example Value(s): 120 (120 grams) or 2500 (2,5 kg = 2500 g)
sku
Type: string
Description: The product's Stock Keeping Unit (SKU).
Example Value(s): '123456789' or 'A-123-797-C'
quantity
Type: number
Description: The amount of this specific line item purchase in that order.
Example Value(s): 5 or 99
productTags
Type: [string]
Description: An array of tags, specifying the product further.
Example Value(s): ['food', 'beverages', 'with_deposit'] or ['free_item']
discounts
Type: [Discount]
Description: An array of Discount objects applied to the lineItem. Note that the values have to be supplied per item (as in 'not multiplied by quantity').
Example Value(s): See Discount.
taxes
Type: [Tax]
Description: An array of Tax objects applied to the lineItem. Note that the values have to be supplied per item (as in 'not multiplied by quantity').
Example Value(s): See Tax.
totalAmountBeforeTaxesAndDiscounts
Type: number
Description: The total amount for this lineItem (not the order) before taxes and discounts are applied. The formula is quantity * productGmv. Note: Although we could calculate that value by the already provided individual values, we recommend sending it so that we can validate the correctness of the calculation. In short: those values are internal check-sums to validate the correctness of the elements of the calculation formula.
Example Value(s): 37,50 (quantity 3 and productGmv of 12,50) or
totalAmountAfterTaxesAndDiscounts
Type: number
Description: The total amount for this lineItem (not the order) after the deduction of taxes and discounts. The formula is (quantity * productGmv) - (sum(taxes.taxAmount) * quantity) - (sum(discounts.discountAmount) * quantity). Note: Although we could calculate that value by the already provided individual values, we recommend sending it so that we can validate the correctness of the calculation. In short: those values are internal check-sums to validate the correctness of the elements of the calculation formula.
Example Value(s): 30,75 (quantity 3 and productGmv of 12,50) - 3.75 (10% voucher) - 7.13 (19% VAT)
totalLogisticsCosts
Type: number
Description: The amount of the total (additional) logistics costs that applies to this / those lineItems. E.g. if the order contained an item that needed to be shipped via freight forwarding because of its bulkiness or weight.
Example Value(s): 50.00 (additional fee for freight forwarder to deliver a washing machine)