List In-Stock Batches For Stock

Like listing batches for a stock, but only batches with quantity remaining, and not paginated — intended for pickers when selling or adjusting. Pass -1 as {id} with variant_id and location_id query params to resolve (or create) the stock record on the fly. Requires the Read Stock permission on the location.

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

Stock id, or -1 to resolve via variant_id + location_id

Query Params
integer

Variant id (required when {id} is -1)

integer

Location id (required when {id} is -1)

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