Get Refund

Returns a single refund with the full totals breakdown (including the adjustment refund/fee), the order/customer context, payment info, the billing & shipping addresses, and the refunded line items — no follow-up calls required. Requires the sales.refunds.view permission.

Endpoint

Endpoint	Method
/api/admin/refunds/{id}	GET

Response fields

Field	Type	Description
id	Integer	Refund id.
orderId	Integer	Parent order id.
orderIncrementId	String	Human-facing order number.
state	String	Refund state (e.g. refunded).
emailSent	Boolean	Whether the refund email was sent.
totalQty	Integer	Total quantity refunded.

Currency codes

orderCurrencyCode, baseCurrencyCode, channelCurrencyCode.

Totals

Each money total is provided in the order currency and the store's base currency with a formatted* string; sub-total and shipping also expose incl-tax variants.

Field	Type	Description
subTotal / formattedSubTotal (+ base*, *InclTax, base*InclTax)	Number / String	Refunded line-items subtotal.
grandTotal / formattedGrandTotal (+ base*)	Number / String	Refund grand total.
taxAmount (+ base*, formatted*)	Number / String	Tax refunded.
discountAmount (+ base*, formatted*)	Number / String	Discount refunded.
shippingAmount (+ base*, *InclTax, base*InclTax, formatted*)	Number / String	Shipping refunded.
shippingTaxAmount (+ base*, formatted*)	Number / String	Tax on refunded shipping.
adjustmentRefund (+ base*, formatted*)	Number / String	Extra amount refunded beyond line items.
adjustmentFee (+ base*, formatted*)	Number / String	Amount withheld from the refund.

Status, timestamps & order/customer context

createdAt, updatedAt, billedTo, orderStatus, orderStatusLabel, orderDate, channelName, customerName, customerEmail.

Payment info

Field	Type	Description
paymentMethod	String	Payment method code of the order.
paymentTitle	String	Human-readable payment method title.
shippingMethod	String	Shipping method code.
shippingTitle	String	Human-readable shipping method title.

Addresses (billingAddress, shippingAddress)

Objects with: id, addressType, firstName, lastName, companyName (nullable), address, city, state, country, postcode, email, phone.

Line items (items)

Array of objects, each with: id, orderItemId, sku, name, qty, price/formattedPrice, basePrice, basePriceInclTax, total/formattedTotal, baseTotal, baseTotalInclTax, taxAmount/formattedTaxAmount, discountAmount/formattedDiscountAmount, productId, productType, baseImageUrl, additional.