Skip to main content

Download Export File

GET 
/api/export/download

Downloads a completed export file from the model-exports disk by filename (the file returned from create-download-file). Streams the file as a CSV download (Content-Type: text/csv).

Required scope: reports:read

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

Authentication: Requires Bearer token

Query parameters:

  • file (required): Filename of the completed export. Returns 404 if omitted.

Responses:

  • 200: File download (text/csv).
  • 404: The file param is missing, or the export file no longer exists / has expired / its metadata can't be read. Regenerate the export.

Note: Response is a file download, not JSON.

Serves only files written by the daily financials, inventory expiry, profitability drill-down, sales channel coverage and close pack exports. Any other name, or a name containing a path, returns 404.

Access: each file family needs the same access as starting that export — close packs need accounting.sync; daily financials, inventory expiry, profitability drill-down and sales channel coverage need access to that report (API tokens need the reports:read scope instead). A file someone else started returns the same 404 as a missing file; only the user who started the export, or an account admin, can download it.

Request​

Responses​

OK

Response Headers
    Content-Type
    Content-Disposition