Get an item's total stock in a warehouse

Returns an item's total stock in one warehouse, split into allocable, non_allocable and reserved.

Required permission (any one of these):

GroupPermission
InventoryView stock on hand and inventory movements
InventorySet, adjust and move stock (includes view)
Path Params
integer
required

The warehouse's ID.

integer
required

The product's ID.

integer
required

The item's (variant's) ID.

Query Params
string

Greater than (not including) the soh.

string

Less than (not including) the soh.

string

Ne soh.

string

Exact match on location.

string

Partial match on name; Partial match on style; Partial match on sku; Partial match on description; Partial match on type; Partial match on vendor; Partial match on location; Exact match on barcode.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json