API Reference

Get a product's stock

get
https://api.smoothpos.net/product//inventory.json

Returns stock on hand for every item of a product, across all warehouses. You get one row per item per stock location.

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

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 product'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.

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

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

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

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

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

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

number

Minimum soh, inclusive.

number

Maximum soh, inclusive.

string

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

string

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

string

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

string

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

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

Updated 8 days ago

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

Updated 8 days ago

Did this page help you?