Queries

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 BatchNumber
List of the batch numbers for this line item

---

Input data types

LineItemInput data type

id ID
Unique identifier of the line item

location_id String
Id of the location of the line item

location Location - Subquery
Location of the line item

variant_id String
Id of the variant of the line item

variant Variant - Subquery
Variant of the line item

quantity Float
Quantity of the line item

price Float
Unit price of the line item

drop_shipping Int
True if the line item is drop shipped directly from the supplier to the customer

parent_id Int
Id of the parent line item (set when a document is duplicated or transformed into another)

weight Int
Position of the line item in the document

description String
Description of the line item (used as the title when the line item is a custom product)

temporary_id ID
Temporary identifier used to link the kit or packaging components to their kit line item

kit_line_item_id ID
Id of the kit's line item this line item is a component of

type String
Type of the variant (kit, assembly, packaging, normal)

batch_numbers BatchNumberLineItemInput - Subquery
List of the batch numbers allocated to the line item

customer_id Int
Id of the customer of the line item

LineItemOrderInput data type

id ID
Unique identifier of the line item

location_id String
Id of the location of the line item

location Location - Subquery
Location of the line item

variant_id String
Id of the variant of the line item

variant Variant - Subquery
Variant of the line item

quantity Float
Quantity of the line item

price Float
Unit price of the line item

drop_shipping Int
True if the line item is drop shipped directly from the supplier to the customer

parent_id Int
Id of the parent line item (set when a document is duplicated or transformed into another)

weight Int
Position of the line item in the document

description String
Description of the line item (used as the title when the line item is a custom product)

temporary_id ID
Temporary identifier used to link the kit or packaging components to their kit line item

kit_line_item_id ID
Id of the kit's line item this line item is a component of

type String
Type of the variant (kit, assembly, packaging, normal)

batch_numbers BatchNumberLineItemInput - Subquery
List of the batch numbers allocated to the line item

LineItemPurchaseInput data type

id ID
Unique identifier of the line item

location_id String
Id of the location of the line item

location Location - Subquery
Location of the line item

variant_id String
Id of the variant of the line item

variant Variant - Subquery
Variant of the line item

quantity Float
Quantity of the line item

price Float
Unit price of the line item

drop_shipping Int
True if the line item is drop shipped directly from the supplier to the customer

parent_id Int
Id of the parent line item (set when a document is duplicated or transformed into another)

weight Int
Position of the line item in the document

description String
Description of the line item (used as the title when the line item is a custom product)

temporary_id ID
Temporary identifier used to link the kit or packaging components to their kit line item

kit_line_item_id ID
Id of the kit's line item this line item is a component of

type String
Type of the variant (kit, assembly, packaging, normal)

batch_numbers BatchNumberLineItemInput - Subquery
List of the batch numbers allocated to the line item

LineItemProductReturnInput data type

id ID
Unique identifier of the line item

location_id String
Id of the location of the line item

location Location - Subquery
Location of the line item

variant_id String
Id of the variant of the line item

variant Variant - Subquery
Variant of the line item

quantity Float
Quantity of the line item

price Float
Unit price of the line item

drop_shipping Int
True if the line item is drop shipped directly from the supplier to the customer

parent_id Int
Id of the parent line item (set when a document is duplicated or transformed into another)

weight Int
Position of the line item in the document

description String
Description of the line item (used as the title when the line item is a custom product)

temporary_id ID
Temporary identifier used to link the kit or packaging components to their kit line item

kit_line_item_id ID
Id of the kit's line item this line item is a component of

type String
Type of the variant (kit, assembly, packaging, normal)

batch_numbers BatchNumberLineItemInput - Subquery
List of the batch numbers allocated to the line item

LineItemShippingOrderInput data type

id ID
Unique identifier of the line item

location_id String
Id of the location of the line item

location Location - Subquery
Location of the line item

variant_id String
Id of the variant of the line item

variant Variant - Subquery
Variant of the line item

quantity Float
Quantity of the line item

price Float
Unit price of the line item

drop_shipping Int
True if the line item is drop shipped directly from the supplier to the customer

parent_id Int
Id of the parent line item (set when a document is duplicated or transformed into another)

weight Int
Position of the line item in the document

description String
Description of the line item (used as the title when the line item is a custom product)

temporary_id ID
Temporary identifier used to link the kit or packaging components to their kit line item

kit_line_item_id ID
Id of the kit's line item this line item is a component of

type String
Type of the variant (kit, assembly, packaging, normal)

batch_numbers BatchNumberLineItemInput - Subquery
List of the batch numbers allocated to the line item

LineItemStockAdjustmentInput data type

id ID
Unique identifier of the line item

location_id String
Id of the location of the line item

location Location - Subquery
Location of the line item

variant_id String
Id of the variant of the line item

variant Variant - Subquery
Variant of the line item

quantity Float
Quantity of the line item

price Float
Unit price of the line item

drop_shipping Int
True if the line item is drop shipped directly from the supplier to the customer

parent Int
Parent of the line item

weight Int
Position of the line item in the document

description String
Description of the line item (used as the title when the line item is a custom product)

parent_id Int
Id of the parent line item (set when a document is duplicated or transformed into another)

kit_line_item_id ID
Id of the kit's line item this line item is a component of

temporary_id ID
Temporary identifier used to link the kit or packaging components to their kit line item

type String
Type of the variant (kit, assembly, packaging, normal)

batch_numbers BatchNumberLineItemInput - Subquery
List of the batch numbers allocated to the line item

LineItemPurchaseReceiptInput data type

id ID
Unique identifier of the line item

location_id String
Id of the location of the line item

location Location - Subquery
Location of the line item

variant_id String
Id of the variant of the line item

variant Variant - Subquery
Variant of the line item

quantity Float
Quantity of the line item

price Float
Unit price of the line item

drop_shipping Int
True if the line item is drop shipped directly from the supplier to the customer

parent_id Int
Id of the parent line item (set when a document is duplicated or transformed into another)

weight Int
Position of the line item in the document

description String
Description of the line item (used as the title when the line item is a custom product)

temporary_id ID
Temporary identifier used to link the kit or packaging components to their kit line item

kit_line_item_id ID
Id of the kit's line item this line item is a component of

type String
Type of the variant (kit, assembly, packaging, normal)

batch_numbers BatchNumberLineItemInput - Subquery
List of the batch numbers allocated to the line item