Export Allocations

GET 
/api/v2/inventory-allocations/export

Downloads an export of inventory allocations.

Required scope: inventory:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Query Parameters:

• format — xlsx (default)
• scope — filtered (apply current filters), selected (specific IDs), all
• ids — Required when scope=selected. Comma-separated allocation IDs.

Returns a binary file download response.

Request

Responses

200

OK

Response Headers

Content-Type
Content-Disposition

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.