Skip to main content

Export Sales Orders

GET 
/api/sales-orders/list/export

Exports the sales order datatable as an XLSX or CSV file download.

Accepts the same filter, filter_groups, and sort query params as the List endpoint (the active datatable filters). The Hold Until Date column is included in the export (alongside Ship By Date and Deliver By Date); date columns are converted from UTC to the tenant timezone.

Response: a binary file download (Content-Type application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for xlsx, text/csv for csv) — not JSON.

Authentication: Requires Bearer token. Scope: orders (read).

Request​

Responses​

Successful response