Export Inventory Movements

GET 
/api/v2/inventory-movements/list/export

Exports inventory movements as an XLSX or CSV file download. Reuses the same Spatie QueryBuilder filters and sorts as the List Inventory Movements endpoint when scope=filtered.

Required scope: inventory:read

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

Scopes:

• all: ignore active filters/sort and export every record
• filtered (default): apply the current filter/sort/search query params
• current_page: export the rows on the current page (matches the visible table)
• selected: export only the IDs supplied via the ids query param

The response is a binary file (xlsx or csv); Content-Type is application/vnd.openxmlformats-officedocument.spreadsheetml.sheet or text/csv. Authentication: Requires Bearer token.

Requires permission: inventory.export

Request

Responses

200

Successful response

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.