Get Allocation
GET/api/v2/inventory-allocations/:allocation
Returns a single inventory allocation by ID.
inventory:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
warehouse_location_id and the nested warehouse_location object reflect the bin this allocation is pinned to (null when not pinned). warehouse.locations_enabled indicates whether the warehouse uses bin locations.
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
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.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
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.