View Return

About

The customerReturn query returns a single return (RMA) request owned by the authenticated customer, with the full detail — the returned item, attached images, status and the action flags (canClose, canReopen, isExpired). If the return does not exist or belongs to a different customer, the query returns a not-found error.

Authentication

This query requires an authenticated customer — send the storefront key and a customer Bearer token. See the Authentication page.

Arguments

Argument	Type	Required	Description
id	ID!	✅ Yes	The return IRI, e.g. /api/shop/returns/12.

Possible Returns

Field	Type	Description
_id	Int!	Numeric return ID.
orderId	Int!	Id of the order the item belongs to.
orderIncrementId	String!	Human-readable order number.
statusId	Int!	Numeric status id.
statusTitle	String!	Status label, e.g. Pending.
statusColor	String!	Hex color for the status badge.
packageCondition	String	Reported package condition, e.g. opened.
information	String	Free-text note supplied when the return was raised.
canClose	Boolean	Whether the return can be closed (marked solved).
canReopen	Boolean	Whether the return can be reopened back to pending.
isExpired	Boolean	Whether the return is past its action window.
item	Object	The returned item — id, order_item_id, sku, name, quantity, resolution, reason_id, reason, variant_id. Query bare (a JSON object).
item.id	Int	Id of the return item row.
item.order_item_id	Int	Id of the source order item.
item.sku	String	Product SKU.
item.name	String	Product name.
item.quantity	Int	Quantity being returned/canceled.
item.resolution	String	Resolution type: return or cancel_items.
item.reason_id	Int	Id of the chosen return reason.
item.reason	String	Title of the chosen return reason.
item.variant_id	Int	Variant id for a configurable product, or null.
images	Array	Attached images. Query bare (a JSON array).
images[].id	Int	Image id.
images[].path	String	Stored file path.
images[].url	String	Public URL of the image.
messagesCount	Int!	Number of conversation messages on the return.
createdAt	DateTime!	Return creation timestamp.
updatedAt	DateTime!	Return last update timestamp.

Related Resources

• List Returns
• List Return Messages
• Cancel a Return
• Returns Overview