ROLineItem
| Field | Type | Required | Description |
|---|---|---|---|
code |
string |
Identifier for the line item. Needs to be unique within the return order. | |
salesOrderLineItemCode |
string |
Reference to the sales order line item being returned. | |
status |
ROLineItemStatus | one of: open, inProgress, rejected, canceled, completed |
|
quantity |
number |
min 0 | |
returnReason |
object |
||
productCondition |
object |
||
product |
LineItemProduct | ||
currencyCode |
CurrencyCode | max length 3 · min length 3 | |
price |
number |
format: float |
|
shippingAmount |
number |
format: float |
|
taxAmount |
number |
format: float |
|
tax2Amount |
number |
format: float |
|
taxExempt |
boolean |
||
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 |
|
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 |
|
note |
string |
||
possibleFulfillmentLocations |
array[string] |
Example
Section titled “Example”{ "code": "R386", "salesOrderLineItemCode": "386", "status": "inProgress", "quantity": 5, "returnReason": { "code": "string", "name": "string" }, "productCondition": { "code": "string", "name": "string" }, "product": { "code": "24-MB02", "name": "Fusion Backpack", "image": "https://myawesomeshop.com/images/img1.jpg", "price": 59.99, "salePrice": 39.99, "currencyCode": "EUR", "identifiers": {}, "options": [ {} ] }, "currencyCode": "EUR", "price": 0, "shippingAmount": 0, "taxAmount": 0, "tax2Amount": 0}
