Skip to content

Return Rules ​

The Return Rules menu is part of the store's RMA (Returns) settings. Return rules set the return window (in days) for matching products. Each rule has a name, description, active status and a returnPeriod — the number of days after purchase a customer may still open a return.

Operations in this menu ​

ActionOperation
ListadminRmaRules query
GetadminRmaRule(id:) query
CreatecreateAdminRmaRule mutation
UpdateupdateAdminRmaRule mutation
DeletedeleteAdminRmaRule mutation
Mass deletecreateAdminRmaRuleMassDelete mutation
Mass update statuscreateAdminRmaRuleMassUpdateStatus mutation

List queries are cursor-paginated Relay connections.

Fields ​

FieldMeaning
nameThe rule label.
descriptionFree-text description of the rule.
status1 active, 0 inactive.
returnPeriodThe return window in days for products this rule matches.
default1 if this is the default rule, 0 otherwise.
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.rules.create
Update / mass update statussales.rma.rules.edit
Delete / mass deletesales.rma.rules.delete

Released under the MIT License.