List Location Quantities
GET/api/v2/inventory/location-quantities
Paginated per-(product, warehouse, location) on-hand balances from the incrementally-maintained inventory_location_quantities cache (stock by location).
Authentication: Requires Bearer token. Scope: inventory (read/write). Requires the tenant to have warehouse locations enabled.
Filters (Spatie QueryBuilder filter[...]):
- warehouse_id (exact)
- warehouse_location_id (exact)
- product_id (exact)
- location_type (exact or comma-separated; one of: staging, primary_pick, reserve, storage, shipping, returns, quarantine, damaged)
- search (product sku/name + location code)
Available sorts: id, quantity, product_id, warehouse_id, warehouse_location_id, updated_at (default: -quantity). per_page is clamped to a max of 100 (default 10).
Request
Responses
- 200
- 401
- 403
- 429
OK
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.