Get a warehouse's stock

get

https://api.smoothpos.net/warehouse/{wh}/inventory.json

Returns stock on hand in a warehouse. You get one row per item per stock location, 50 at a time by default. Page through them with the X-Next-Page header.

See Filtering, sorting and search for how the filters, ranges and sort work.

Required permission (any one of these):

Group	Permission
Inventory	View stock on hand and inventory movements
Inventory	Set, adjust and move stock (includes view)

Path Params

integer

required

The warehouse's ID.

Query Params

limit

integer

1 to 250

Defaults to 50

How many records to return per page. Defaults to 50, maximum 250.

cursor

string

Opaque paging cursor. Don't build this yourself: follow the path in the X-Next-Page or X-Prev-Page response header.

soh_gt

number

Only return rows with stock on hand greater than this.

location

string

Only return rows for this stock location.

string

Free-text search, for example on the product name.

tagged

string

Only records with any of these tags. Send one tag or a comma-separated list, up to 50.

soh_lt

string

Less than (not including) the soh.

soh_ne

string

Ne soh.

product_id

string

^\d+(,\d+)*$

Matches one product id or a comma-separated list (up to 200).

item_id

string

^\d+(,\d+)*$

Matches one item id or a comma-separated list (up to 200).

location_id

string

^\d+(,\d+)*$

Matches one location id or a comma-separated list (up to 200).

min_soh

number

Minimum soh, inclusive.

max_soh

number

Maximum soh, inclusive.

vendor_in

string

Exact match on vendor. Send one value or a comma-separated list.

type_in

string

Exact match on type. Send one value or a comma-separated list.

barcode

string

Exact match on barcode. Send one value or a comma-separated list.

sku

string

Exact match on sku. Send one value or a comma-separated list.

sort

string

Sort order. Use sort=key for ascending or sort=-key for descending, for example sort=-created. Keys: id, name, style, type, vendor, created, updated, soh. The older sort_field=key&sort=asc|desc style still works. Every sort key works with paging, so you can follow the X-Next-Page links whichever one you pick.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success.

404Not found. Smooth POS also answers with a 404 when your token is missing or invalid, so check the error message. Possible error messages: not authorised no inventory found