Skip to content

Close a Return

About

The closeCustomerReturn mutation marks the customer's own return (RMA) request as Solved and adds a note to the conversation thread. The result carries the updated return. A return can only be closed when its canClose flag is true.

Authentication

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

Input Fields

FieldTypeRequiredDescription
idID!✅ YesThe return IRI, e.g. /api/shop/returns/12.

Possible Returns

FieldTypeDescription
customerReturn._idInt!Numeric return ID.
customerReturn.orderIdInt!Id of the order the item belongs to.
customerReturn.orderIncrementIdString!Human-readable order number.
customerReturn.statusIdInt!Numeric status id after closing — 3 (Solved).
customerReturn.statusTitleString!Status label, e.g. Solved.
customerReturn.statusColorString!Hex color for the status badge.
customerReturn.canCloseBooleanWhether the return can be closed.
customerReturn.canReopenBooleanWhether the return can be reopened.
customerReturn.isExpiredBooleanWhether the return is past its action window.
customerReturn.messagesCountInt!Number of conversation messages — incremented by the close note.
customerReturn.updatedAtDateTime!Return last update timestamp.

Released under the MIT License.