Skip to content

Return Statuses

The Return Statuses menu is part of the store's RMA (Returns) settings. Custom return statuses used to track a return through your workflow. Each status has a title, a color badge and an active flag. Built-in (default) statuses cannot be deleted.

Operations in this menu

ActionOperation
ListadminRmaStatuses query
GetadminRmaStatus(id:) query
CreatecreateAdminRmaStatus mutation
UpdateupdateAdminRmaStatus mutation
DeletedeleteAdminRmaStatus mutation
Mass deletecreateAdminRmaStatusMassDelete mutation
Mass update statuscreateAdminRmaStatusMassUpdateStatus mutation

List queries are cursor-paginated Relay connections.

Fields

FieldMeaning
titleThe status label.
status1 active, 0 inactive.
colorHex color of the status badge (e.g. #FDB022).
default1 for a built-in system status (cannot be deleted), 0 for a custom one.
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.statuses.create
Update / mass update statussales.rma.statuses.edit
Delete / mass deletesales.rma.statuses.delete

All operations require an admin Bearer token — see Authentication.

Released under the MIT License.