List Allocations
GET/api/v2/inventory-allocations
Returns a paginated list of inventory allocations.
inventory:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Simple filters (filter[status]): Sentinel values control the list scope:
active(default) — pending + released allocationsall— every statuspending,released,cancelled,fulfilled— specific status
Advanced filters (filter_groups): Tree-based GroupedFilterSupport filters on id, quantity, priority, status, warehouse_id, supplier_id, created_at, fulfilled_at, cancelled_at, product_sku, product_name. The filter[search] parameter is a cross-column search.
Sort options: id, quantity, priority, status, created_at. Default: -created_at.
The response also includes unfiltered_total, the count of rows in the base scope before any user filters are applied — used by the frontend to show export totals.
Request
Responses
- 200
- 401
- 403
- 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.
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.