API Reference

Line items are variants added in documents (purchase, purchase receipt, order, shipping order, product return, stock adjustment).

Available queries

No direct query for line items. Line items are available as subqueries of documents (orders, purchases, stock adjustments, ...)


Available fields

id - Int
Id of the line item
sku - String
SKU of the variant
label - String
Label of the variant
description - String
The line item can be a custom product (not created from a variant). The description is the title of the custom product.
type - String
Type of the variant (kit, assembly, packaging, normal)
is_kit - Boolean
True if the variant of the line item is a kit or a packaging
barcode - String
Barcode of the variant
variant - Variant
Variant of the line item
location - Location
Location
quantity - Float
Quantity of variant for the line item
cost - Float
Unit cost of the variant of the line item
weight - Int
Position of the line item in the document
parent_id - Int
When an order is transformed into a shipping order for example, all line items of the order are duplicated. Their parent_id is the Id of the linked line item in the order
kit_line_item_id - Int
If the line item is a kit / packaging component, the kit_line_item_id is the id of the kit's line item
delivered - Float
Quantity delivered for the line item
committed - Float
Quantity committed for the line item
shipped - Float
Quantity shipped for the line item
on_hand - Float
On hand quantity for the variant of the line item
available - Float
Available quantity for the variant of the line item
incoming - Float
Incoming quantity for the variant of the line item
reserved - Float
Reserved quantity for the variant of the line item
batch_numbers - Array of BatchNumber
List of the batch numbers for this line item