Admin Sales: Refunds
Export refunds as csv, xls or xlsx
Downloads the refunds datagrid as a csv, xls or xlsx file — the same data the admin Refunds "Export" button produces (ID, Order ID, Refunded Amount, Billed To, Refund Date). Honours the same filters as the listing (id, order_id, state, base_grand_total_from/_to, billed_to, created_at_from/_to). The response is a binary download, not JSON. Requires sales.refunds.view.
get/refunds/export
Request
- Base URLhttp://localhost:8000/api/admin
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
format'csv' | 'xls' | 'xlsx'
Export format: csv, xls or xlsx. Defaults to csv.
idstring
Filter by refund id (integer or comma-list).
order_idstring
Partial order increment_id match.
statestring
Refund state.
base_grand_total_fromnumber
Min refunded amount.
base_grand_total_tonumber
Max refunded amount.
billed_tostring
Partial billed-to name match.
created_at_fromstring date
Created after.
created_at_tostring date
Created before.
Response
The refunds export file is downloaded as an attachment.
Changes
No recorded changes to this operation across all 8 revisions of this API.