List Stocks At Location

Lists stock records (one row per variant per location), most recently updated first. {id} is a location id, or all for every location the caller can access. filter=lowStock narrows to rows at or below their reorder limit; filter=lowStockIgnored to rows opted out of the low-stock list. Requires the Read Stock permission on the location (company-wide for all). The response search object lists every supported q_<name> filter.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Location id, or all for all accessible locations

Query Params
integer

Page number (default 1)

integer

Rows per page (default 20)

string

Sort order, field or field:asc|desc. Allowed fields: id, count, current_cost_price, location, updated_at. Default updated_at:desc.

integer

Set to 1 to return all rows without pagination

string
enum

Low-stock filter

Allowed:
string

Filter by product name or barcode (partial match)

string

Filter by stock count; supports comparison prefixes, e.g. 500, <500, >10

Headers
string
required

The merchant install this request acts on (install.store_id from the app.installed webhook).

Response

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