PostFOLineItem
| Field | Type | Required | Description |
|---|---|---|---|
salesOrderLineItemCode |
string |
yes | |
lineItemGroupId |
`null | string` | |
sku |
`string | null` | |
quantity |
number |
yes | format: float · min 0 |
status |
LineItemStatus | one of: new, requested, accepted, rejected, canceled, picked, packed, ready, hold, fulfilled |
|
currencyCode |
CurrencyCode | yes | max length 3 · min length 3 |
price |
number |
yes | format: float |
salePrice |
number |
format: float |
|
shippingAmount |
number |
format: float |
|
unitPromoAmount |
UnitPromoAmount | Amount of all applied promotions for a single unit (single quantity). format: float · default: 0 |
|
unitDiscountAmount |
UnitDiscountAmount | Amount of all applied discounts (promotions with coupons) for a single unit (single quantity). format: float · default: 0 |
|
taxAmount |
number |
format: float |
|
tax2Amount |
number |
format: float |
|
taxExempt |
boolean |
default: false |
|
discountAmount |
DiscountAmount | Total amount of all applied promotions with coupons for the line item. (Formula: lineItem.unitDiscountAmount * lineItem.quantity) format: float · default: 0 |
|
promoAmount |
PromoAmount | Total amount of all applied promotions for the line item. (Formula: lineItem.unitPromoAmount * lineItem.quantity) format: float · default: 0 |
|
overrideAmount |
number |
format: float |
|
extendedPrice |
ExtendedPrice | The extended Price is the final price of the line item, including all discounts & promotions that apply to this line item, and also already multiplied with the quantity. Formula: (product.price or product.salePrice if not empty) * quantity + promoAmount + discountAmount. Example: A product original price is 60€ (product.price), but it is on sale for 40€ (product.salePrice). Ordered quantity is 2, there is no discount but there is a promotion that applies to this product and gives 10% additional discount (unitPromoAmount = 4€, promoAmount = 8€). The extended price of this line item should be (40€ * 2) + (-8€) = 72€. format: float |
|
product |
LineItemProduct | yes | |
substitutionAllowed |
boolean |
Determines if a substitution is allowed for this line item. default: true |
Example
Section titled “Example”{ "salesOrderLineItemCode": "386", "lineItemGroupId": "386-1", "sku": "1337-hoodie-dark-green", "quantity": 0, "status": "new", "currencyCode": "EUR", "price": 79.99, "salePrice": 65.99, "shippingAmount": 0, "unitPromoAmount": -4, "unitDiscountAmount": -3, "taxAmount": 0}
