Export Invoices
Downloads the invoices datagrid as a csv, xls or xlsx file — the same data the admin Sales → Invoices "Export" button produces. The response is a binary file attachment, not JSON. Requires the sales.invoices.view permission.
Endpoint
| Endpoint | Method |
|---|---|
/api/admin/invoices/export | GET |
Columns
The export carries the five datagrid columns, in order:
| Header | Value |
|---|---|
ID | Invoice number. |
Order ID | The parent order's number. |
Status | The invoice state (e.g. paid, pending). |
Grand Total | The invoice's total, in the store's base currency, formatted (e.g. $554.00). |
Invoice Date | When the invoice was created. |
Query parameters
format selects the export format — csv (the default), xls or xlsx; any other value returns 422. Send an Accept header matching the format: text/csv, application/vnd.ms-excel or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet.
The export honours the same filters as the listing, so you export exactly the rows you're viewing: id, order_id, state, base_grand_total_from / _to, created_at_from / _to. (Pagination does not apply — the export returns every matching row.)
Permission
sales.invoices.view