The inventory available object

Each row represents an available quantity for a variant on an inventory location, optionally split by batch. Rows with type inventory / inventory_bundle are physical stock. Rows with type incoming / incoming_bundle are expected quantities from production orders and carry a production_order_id and an expected_delivery date.

Inventory available

Parameter	Data type	Default	Description
id	int
variant_id	int		The variant
product_id	int		The product
type	string		Possible values: inventory, inventory_bundle, incoming, incoming_bundle
inventory_location_id	int		The inventory location of the quantity
batch_id	int	NULL	The batch of the quantity. NULL when the quantity is not batch tracked
batch	string	NULL	The name of the batch
quantity	int		The available quantity
b2c_quantity	int	NULL	The available quantity for B2C channels. NULL when no B2C reserve is configured
production_order_id	int	NULL	The production order the quantity is incoming from. Only set on incoming and incoming_bundle rows
production_order_delivery_note_id	int	NULL	The production order delivery note the quantity is incoming on
expected_delivery	date	NULL	When the incoming quantity is expected to arrive. Only set on incoming and incoming_bundle rows
created_at	datetime
updated_at	datetime
inventory_location	If eager loaded		An object inventory location
product	If eager loaded		An object product
variant	If eager loaded		An object variant

Inventory location

Parameter	Data type	Default	Description
id	int
name	string		The name of the inventory location
code	string	NULL	The code of the inventory location
default	boolean	false	Is this the default inventory location?
location_type	string	normal	Possible values: normal, consignment, virtual
active	boolean	true	Is the inventory location active?

Product

Parameter	Data type	Default	Description
id	int
item_number	string		The item number of the product. This is unique accross your account
name	string		The name of the product
attributes	object		An object with {"key": "value"} with the attributes of the product
meta	object	{}	An object with {"key": "value"} with custom meta data of the product. This is used for storing custom fields

Variant

Parameter	Data type	Default	Description
id	int
sku	string		The SKU of the variant. This is unique accross your account
ean	string	NULL	The barcode for this variant
attributes	object		An object with {"key": "value"} with the attributes of the variant. This will be Colors, Sizes, etc.
meta	object	{}	An object with {"key": "value"} with custom meta data of the variant. This is used for storing custom fields