Skip to main content
objectWarehouseItemStock

Fields

totalQuantity
Decimal!

The item's total physical stock in the specified warehouse: the quantity on hand there, including quantities that are locked or committed to orders. Reported as 0 for a bill-of-materials item or a variation parent, which hold no physical stock of their own - unlike GET items/{itemId}/stocks, this endpoint does not roll their stock up from components or variations.

lockedQuantity
Decimal!

The part of totalQuantity that is locked from availability in the specified warehouse, reported as stored rather than computed. Two cases produce it: stock lying on a locked bin location, where the entire quantity on that bin counts, and otherwise stock committed to open production pick lists. Quantities committed to open sales orders are NOT part of this figure - neither before nor after picking - because a sales order carries no warehouse assignment in the database; a warehouse-specific share of it therefore does not exist. Deduct this value from totalQuantity to obtain the disposable quantity in this warehouse. Never negative - the underlying column is constrained to be at or above 0 - but it can exceed totalQuantity, because no constraint relates the two; the deduction can therefore yield a negative disposable quantity. Reported as 0 for a bill-of-materials item or a variation parent, for the same reason as totalQuantity.