List Warehouse Locations

GET 
/api/v2/warehouse-locations

Paginated warehouse locations (bins) with the cached per-location on-hand units (on_hand). Deprecated locations are hidden unless include_deprecated (top-level or inside filter[]) is truthy.

Authentication: Requires Bearer token. Scope: warehouses (read/write). Requires the tenant to have warehouse locations enabled (warehouse.locations middleware).

Location types: staging, primary_pick, reserve, storage, shipping, returns, quarantine, damaged. Available sorts: code (default), type, created_at (prefix with - for descending).

Request

Responses

200

OK

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

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.

429

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.