Admin Sales: EU Withdrawal
Export EU withdrawals as csv, xls or xlsx
Changed onDownloads the EU withdrawals datagrid — the same columns the admin Export button produces (Received At, Order, Customer Email, Status, Channel, Confirmation Sent, Reference). Honours the same filters as the listing and exports every matching row. Binary download, not JSON. Requires sales.eu_withdrawals.
get/eu-withdrawals/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.
order_increment_idstring
Partial order number match.
customer_emailstring
Partial customer email match.
statusstring
Status: received, refunded or declined.
channel_codestring
Channel code.
received_at_fromstring
Received on or after (YYYY-MM-DD).
received_at_tostring
Received on or before (YYYY-MM-DD).
confirmation_sent_at_fromstring
Confirmation sent on or after (YYYY-MM-DD).
confirmation_sent_at_tostring
Confirmation sent on or before (YYYY-MM-DD).
Response
Export file downloaded as an attachment.
Changes
- info
endpoint added
- info