Export Product Inventory Movements

GET 
/api/v2/products/:product/inventory-movements/export

Exports a product's inventory movements as an XLSX or CSV file. Supports the same filters, search, and sort as the movements list, plus column selection via the columns parameter.

Required scope: products:read

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

Columns include: ID, Date, Type, Status, Quantity, Unit Cost, Layer Cost Now, Warehouse, FIFO Layer ID, Source, Reference, Link Type, Link ID, Created.

Unit Cost is the cost the movement was recorded at (what its cost-of-goods journal booked); Layer Cost Now is the FIFO layer's current per-unit cost. Layer Cost Now is always exported alongside Unit Cost when columns includes unit_cost.

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.

404

Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.

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.