Skip to main content
GET
Get Warehouse Stock By Item Id

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

Path Parameters

warehouseId
string<uuid>
required

The ID of the warehouse in which the stock of the specified item is to be determined.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

itemId
string<uuid>
required

The ID of the item for which stock is to be determined within the specified warehouse.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

Response

Success.

An item's stock in a single warehouse.

totalQuantity
number<decimal>
required

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
number<decimal>
required

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.