Order line items
An order includes one or more line items, representing the goods or services involved. Each line item includes essential information:
Property | Definition |
|---|---|
id | Unique identifier for the line item. |
type | Specifies if the line item is a Purchase or Return. Defaults to Purchase if omitted. |
externalStatus | Status of the line item in external systems (e.g., Reserved, Picked). |
*quantity | Quantity of the item in the order. |
*article | Details about the item, including SKU, name, description, and optional links to images or product pages.
|
discounts | Optional discounts applied to the line item, with details like "type", "description", and "amount" |
returnDetails | Optional details about returns for this line item, such as:
|
pricePerUnit | Net amount per unit, discounts applied, taxes included. |
originalPricePerUnit | Net amount per unit before discounts were applied, taxes included. |
*totalPrice | Total net amount, discounts applied, taxes included. Required. |
originalTotalPrice | Total net amount before discounts were applied, taxes included. |
taxes | Breakdown of taxes for the line item, including amounts, percentages, and descriptions (e.g., VAT). |
group | Optional grouping information for categorizing line items. |
*Required fields are quantity, article, totalPrice
Additional fields:
Sub-total: The sum of totalPrice values for all line items in the order. Represented at the order level as lineItems.subTotal
Article data
When specifying articles on the line items of an order, only the SKU (Stock Keeping Unit) code is mandatory. The referred SKUs should be registered in advance in the Article register for the segmentation on order data to work.
Important
The SKU normally represents the item variant level of an article, used by retailers to identify and track its inventory, or stock. A SKU is a unique code consisting of letters and numbers that identify characteristics about each product, such as manufacturer, brand, style, color, and size.