BAbagisto
Customer Order

List refunds for the authenticated customer

Changed on

Returns the refund documents issued against the authenticated customer's orders, newest first, each with its refunded items and totals. Use ?order_id=N to scope to one order.

get/customer-refunds

Request

Query parameters

order_idinteger
Example:5

Return only refunds for this order ID. Accepts orderId as an alias.

pageinteger

Page number (1-based).

per_pageinteger

Refunds per page (default 10, maximum 50).

Headers

X-STOREFRONT-KEYstring required

Storefront API Key for authentication. Required for all shop/storefront API requests.

X-Localestring
Example:en

Locale code for localized data (e.g. "en", "fr", "ar"). Defaults to channel's default locale.

X-Channelstring
Example:default

Channel code (e.g. "default"). Defaults to the current channel.

X-Currencystring
Example:USD

Currency code (e.g. "USD", "EUR", "INR"). Defaults to channel's base currency.

Response

CustomerRefund collection

idinteger nullable
orderIdinteger nullable
orderIncrementIdstring nullable
incrementIdstring nullable
statestring nullable
totalQtyinteger nullable
baseCurrencyCodestring nullable
channelCurrencyCodestring nullable
orderCurrencyCodestring nullable
subTotalnumber nullable
baseSubTotalnumber nullable
subTotalInclTaxnumber nullable
baseSubTotalInclTaxnumber nullable
shippingAmountnumber nullable
baseShippingAmountnumber nullable
shippingAmountInclTaxnumber nullable
baseShippingAmountInclTaxnumber nullable
shippingTaxAmountnumber nullable
baseShippingTaxAmountnumber nullable
taxAmountnumber nullable
baseTaxAmountnumber nullable
discountPercentnumber nullable
discountAmountnumber nullable
baseDiscountAmountnumber nullable
adjustmentRefundnumber nullable
baseAdjustmentRefundnumber nullable
adjustmentFeenumber nullable
baseAdjustmentFeenumber nullable
grandTotalnumber nullable
baseGrandTotalnumber nullable
formattedSubTotalstring nullable
formattedSubTotalInclTaxstring nullable
formattedShippingAmountstring nullable
formattedShippingAmountInclTaxstring nullable
formattedTaxAmountstring nullable
formattedDiscountAmountstring nullable
formattedAdjustmentRefundstring nullable
formattedAdjustmentFeestring nullable
formattedGrandTotalstring nullable
formattedBaseGrandTotalstring nullable
createdAtstring nullable
updatedAtstring nullable

Changes