List Offline Products For Location

Returns the flat variant list for one location in the offline/POS-cache shape — one row per variant, with modifiers, batches and taxes inline. Requires the Read Products permission at the location by default; permission_type switches the check for transfer/sell flows. Not paginated; responses can be large.

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

Location id.

Query Params
boolean

Set 1 to include stock count per variant.

boolean

Set 1 to include cost_price and standard_cost per variant.

integer

A second location id — adds a count2 field with that location's stock next to count (use with show_counts=1).

boolean

Set 1 to include in-stock serial numbers for serialized variants.

boolean

Set 1 to include variant image URLs.

boolean

Set 1 to restrict to variants in for-sale categories.

string
enum

Alternative permission check: transfer (caller can create transfer requests anywhere or issue from this location), direct-transfer (issue-transfer permission at the location) or sell (create-bill permission at the location).

Allowed:
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