Cancel a Return

About

The cancelCustomerReturn mutation cancels the customer's own return (RMA) request, unless it is already canceled. The result carries the updated return with its new status and action flags.

Authentication

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

Input Fields

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

Possible Returns

Field	Type	Description
customerReturn._id	Int!	Numeric return ID.
customerReturn.orderId	Int!	Id of the order the item belongs to.
customerReturn.orderIncrementId	String!	Human-readable order number.
customerReturn.statusId	Int!	Numeric status id after the cancel.
customerReturn.statusTitle	String!	Status label, e.g. Canceled.
customerReturn.statusColor	String!	Hex color for the status badge.
customerReturn.canClose	Boolean	Whether the return can be closed.
customerReturn.canReopen	Boolean	Whether the return can be reopened.
customerReturn.isExpired	Boolean	Whether the return is past its action window.
customerReturn.messagesCount	Int!	Number of conversation messages on the return.
customerReturn.updatedAt	DateTime!	Return last update timestamp.

Related Resources

• Reopen a Return
• View Return
• Returns Overview