Skip to content

Get Refund

GraphQL counterpart of GET /api/admin/refunds/{id}. Returns a single refund with the full totals/adjustment breakdown, order/customer context, payment info, billing & shipping addresses, and the refunded line items. Requires the sales.refunds.view permission. All admin endpoints require an admin Bearer token — see Authentication.

Operation

OperationType
adminRefund(id: ID!)Query

Pass the refund IRI (/api/admin/refunds/{id}) as id.

Identifier vs IRI

id is the resource IRI; _id is the plain numeric id. Use the IRI for the id argument.

Objects & lists are returned whole

billingAddress, shippingAddress, and items are returned as JSON — query them bare, without a sub-selection (items, not items { … }). The whole object/array comes back. items is not a cursor connection.

Fields

Same field set as the REST Get Refund — every refund column (in order + base currency, with formatted* and incl-tax variants), the adjustment refund/fee, order/customer context, payment info, the two address objects, and the line items.

Released under the MIT License.