Export Inventory Holds

GET 
/api/v2/inventory/holds/export

Exports inventory holds as XLSX or CSV file. Columns include: ID, SKU, Product Name, Warehouse, Quantity, Reason, Notes, Created By, Created At, Expires At, Released At, Archived At.

Required scope: inventory:read

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

Authentication: Requires Bearer token.

Response: File download (binary), not JSON.

Requires permission: inventory.export

Request

Responses

200

OK

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.