Export Shipments
Downloads the shipments datagrid as a csv, xls or xlsx file — the same data the admin Sales → Shipments "Export" button produces. The response is a binary file attachment, not JSON. Requires the sales.shipments.view permission.
Endpoint
| Endpoint | Method |
|---|---|
/api/admin/shipments/export | GET |
Columns
The export carries the six datagrid columns, in order:
| Header | Value |
|---|---|
ID | Shipment id. |
Order ID | The parent order's number. |
Total Qty | Total quantity of items in the shipment. |
Inventory Source | The source the shipment was dispatched from. |
Shipped To | Name on the order's shipping address. |
Shipment Date | When the shipment 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, total_qty, inventory_source_name, shipped_to, order_date_from / _to, created_at_from / _to. (Pagination does not apply — the export returns every matching row.)
Permission
sales.shipments.view