The Inventory Object
Inventory is associated with a Product and a Location.
A Product may have zero or more associated Inventory objects. In fact, a Product may have more than one Inventory object at the same Location where stock is found at different shelf locations (bin numbers).
Properties
createdOn
read-only
The datetime in ISO-8601 format when the Inventory entry was created (e.g. 2024-04-28T01:20:52+01:00). |
defaultReorderQuantity
An integer representing the default/preferred number of units to procure when quantityInStock reaches
the issueAlertAtQuantity.
|
id
read-only
An unsigned 64-bit integer unique to the Inventory object. |
isPreferred
A boolean value, which represents whether the Inventory is the preferred stock for the Product. |
issueAlertAtQuantity
An integer representing a low stock threshold for the quantityInStock.
|
locationId
An unsigned 64-bit integer representing the Location the Inventory is associated with. |
modifiedOn
read-only
The datetime in ISO-8601 format when the Inventory entry was last modified (e.g. 2024-04-28T01:20:52+01:00). |
productId
An unsigned 64-bit integer representing the Product the Inventory is associated with. |
quantityAvailable
read-only
The quantity of the Product available to order is dynamically calculated. |
quantityInStock
The quantity of the Product present at the Location. |
quantityReserved
read-only
The quantity of the Product reserved for outstanding orders is dynamically calculated. |
shelfLocation
A string containing a bin number or shelf location, which references where the inventory may be found within the Location. |