Lookup Warehouse Locations
GET/api/lookup/warehouse-locations
Decorated location options for select/autocomplete components. Returns active (non-deprecated) locations of a warehouse in pick-path order (sort_order nulls-last, then code). Returns an empty list when the warehouse does not have locations enabled.
When product_id is supplied each option is decorated with the live available_quantity from the location-quantity cache and a display_text ("CODE (Type) — N units").
Authentication: Requires Bearer token.
Query params:
- warehouse_id (required, integer, exists)
- capability (optional: receivable | pickable | put-away-to | put-away-from) — filters types via the capability matrix
- type / type[] (optional, comma-separated or array) — explicit type filter, intersected with capability
- search (optional, string max 255) — matches code, name or barcode
- product_id (optional, integer, exists) — decorate options with available_quantity + display_text
- limit (optional, integer 1-500, default 50)
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.