Skip to content

List Refunds

Mirrors the admin Sales → Refunds datagrid. Every refund column plus the billing/shipping addresses are populated per row — only the line items (and payment info) are detail-only. Field reference is identical to Get Refund.

Endpoint

EndpointMethod
/api/admin/refundsGET

Query Parameters

ParameterTypeDescription
page, per_pageintegerPagination (default per_page=10, cap 50).
idstringFilter by refund id (int or comma-list).
order_idstringPartial match on orders.increment_id.
statestringRefund state.
base_grand_total_from / _tonumberRefund amount range.
billed_tostringPartial billing-address full-name match.
created_at_from / _todateCreated range.
sortstringid, order_id, state, base_grand_total, billed_to, created_at.
orderstringasc, desc.

Permission

sales.refunds.view

INFO

Refund detail, create, and preview live under Orders.

Released under the MIT License.