Skip to content

Return Reasons

The Return Reasons menu is part of the store's RMA (Returns) settings. Return / cancel reasons the RMA form offers a customer when they open a return. Each reason has a title, a display position, an active status, an isAdmin flag, and a resolutionType — the set of return actions the reason allows.

Operations in this menu

ActionOperation
ListadminRmaReasons query
GetadminRmaReason(id:) query
CreatecreateAdminRmaReason mutation
UpdateupdateAdminRmaReason mutation
DeletedeleteAdminRmaReason mutation
Mass deletecreateAdminRmaReasonMassDelete mutation
Mass update statuscreateAdminRmaReasonMassUpdateStatus mutation

List queries are cursor-paginated Relay connections.

Fields

FieldMeaning
titleThe reason label shown to the customer.
status1 active, 0 inactive.
positionSort order in the returns form.
isAdmin1 if the reason was created by an admin, 0 if it is a seeded reason.
resolutionTypeThe return actions this reason allows — an array of return and/or cancel_items.
messagenull on create / update / read; populated only on the delete confirmation.

Select _id for the numeric id; id is the resource IRI.

How RMA settings fit together

Reasons, statuses and custom fields shape the returns form the customer fills in when opening a return; rules set the return window that decides whether a product is still eligible. Together they make up the store's RMA (Returns) settings.

Permissions

ActionPermission
Createsales.rma.reasons.create
Update / mass update statussales.rma.reasons.edit
Delete / mass deletesales.rma.reasons.delete

All operations require an admin Bearer token — see Authentication.

Released under the MIT License.