BAbagisto
Admin Sales: Refunds

List refunds (datagrid parity)

Paginated refunds listing. Every refund column + billing/shipping addresses are populated per row (line items are detail-only). Returns a { data, meta } envelope. Requires sales.refunds.view.

get/refunds

Request

Query parameters

pageinteger

Page number.

per_pageinteger

Items per page (default 10, max 50).

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.

sort'id' | 'order_id' | 'state' | 'base_grand_total' | 'billed_to' | 'created_at'

Sort column.

order'asc' | 'desc'

Sort direction.

Response

AdminRefund collection

idinteger nullable
orderIdinteger nullable
orderIncrementIdstring nullable
statestring nullable
emailSentboolean nullable
totalQtyinteger nullable
orderCurrencyCodestring nullable
baseCurrencyCodestring nullable
channelCurrencyCodestring nullable
subTotalnumber nullable
formattedSubTotalstring nullable
baseSubTotalnumber nullable
formattedBaseSubTotalstring nullable
subTotalInclTaxnumber nullable
formattedSubTotalInclTaxstring nullable
baseSubTotalInclTaxnumber nullable
formattedBaseSubTotalInclTaxstring nullable
grandTotalnumber nullable
formattedGrandTotalstring nullable
baseGrandTotalnumber nullable
formattedBaseGrandTotalstring nullable
taxAmountnumber nullable
formattedTaxAmountstring nullable
baseTaxAmountnumber nullable
formattedBaseTaxAmountstring nullable
discountAmountnumber nullable
formattedDiscountAmountstring nullable
baseDiscountAmountnumber nullable
formattedBaseDiscountAmountstring nullable
shippingAmountnumber nullable
formattedShippingAmountstring nullable
baseShippingAmountnumber nullable
formattedBaseShippingAmountstring nullable
shippingAmountInclTaxnumber nullable
formattedShippingAmountInclTaxstring nullable
baseShippingAmountInclTaxnumber nullable
formattedBaseShippingAmountInclTaxstring nullable
shippingTaxAmountnumber nullable
formattedShippingTaxAmountstring nullable
baseShippingTaxAmountnumber nullable
formattedBaseShippingTaxAmountstring nullable
adjustmentRefundnumber nullable
formattedAdjustmentRefundstring nullable
baseAdjustmentRefundnumber nullable
formattedBaseAdjustmentRefundstring nullable
adjustmentFeenumber nullable
formattedAdjustmentFeestring nullable
baseAdjustmentFeenumber nullable
formattedBaseAdjustmentFeestring nullable
createdAtstring nullable
updatedAtstring nullable
billedTostring nullable
orderStatusstring nullable
orderStatusLabelstring nullable
orderDatestring nullable
channelNamestring nullable
customerNamestring nullable
customerEmailstring nullable
paymentMethodstring nullable
paymentTitlestring nullable
shippingMethodstring nullable
shippingTitlestring nullable

Changes

No recorded changes to this operation across all 8 revisions of this API.