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.

availableQuantity
number<decimal>
required

The disposable quantity of the item in the specified warehouse: its physical stock there minus the part of that stock which is locked from availability, for example stock held on a locked bin location. Quantities committed to open sales orders are not deducted, and neither virtual nor supplier stock is added - so this is not a per-warehouse share of the availableQuantity returned by GET items/{itemId}/stocks, which is aggregated over all warehouses and built from different terms.