Skip to content

Return Detail (GraphQL)

Returns a single RMA request by IRI, with the returned item, proof images, status, order/customer context, the canReopen flag, and the availableStatuses transitions the admin may set next.

The id argument is the request IRI (/api/admin/rma/requests/{id}).

Field notes

  • item is the returned line: id, order_item_id, sku, name, quantity, resolution (return or cancel_items), reason_id, reason, and variant_id. Select it bare (it is a JSON value).
  • images is a list of { id, path, url }.
  • availableStatuses is a list of { id, title } — the status ids you may pass to Update Status.

TIP

See the Returns overview for the status workflow and action semantics.

Permission: sales.rma.requests.

All admin operations require an admin Bearer token — see Authentication.

Released under the MIT License.