List Products For Location

Returns the products sold at a location as a paginated list, one row per product with its variants and stock counts. Pass all as the id to list every product in the company (stock counts are then company-wide). Requires the Read Products permission at the location (company-wide for all).

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

Location id, or the literal all for the whole company.

Query Params
integer
Defaults to 1

Page number.

integer
Defaults to 20

Page size.

string

Sort field, e.g. name, name:asc or name:desc.

string

Filter by product id, name, barcode or SKU.

string

Filter by brand name. The response's search object advertises further filter keys (q_Category, q_serial_number, q_created_at).

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