Get Breakdown
GET/api/v2/inventory-allocations/breakdown
Returns a breakdown of allocations grouped by relevant dimensions (warehouse, supplier, status) for dashboard widgets.
Required scope:
orders:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Request
Responses
- 200
- 401
- 403
- 429
OK
Response Headers
Content-Type
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.