Skip to content

Return Custom Fields

The Return Custom Fields menu is part of the store's RMA (Returns) settings. Extra fields the return form collects from the customer (for example a preferred-resolution dropdown). Each field has a code, label, input type, required flag, position and — for select / multiselect / checkbox / radio types — a list of options.

Operations in this menu

ActionOperation
ListadminRmaCustomFields query
GetadminRmaCustomField(id:) query
CreatecreateAdminRmaCustomField mutation
UpdateupdateAdminRmaCustomField mutation
DeletedeleteAdminRmaCustomField mutation
Mass deletecreateAdminRmaCustomFieldMassDelete mutation
Mass update statuscreateAdminRmaCustomFieldMassUpdateStatus mutation

List queries are cursor-paginated Relay connections.

Fields

FieldMeaning
codeUnique machine code for the field.
labelThe field label shown to the customer.
typeInput type: text, textarea, select, multiselect, checkbox, radio.
isRequired1 if the customer must fill it in, 0 otherwise.
positionSort order in the returns form.
inputValidationOptional validation rule name; null when none.
status1 active, 0 inactive.
optionsChoice list for select / multiselect / checkbox / radio types — an array of { id, name, value }. Empty/absent for text / textarea.
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.custom-fields.create
Update / mass update statussales.rma.custom-fields.edit
Delete / mass deletesales.rma.custom-fields.delete

All operations require an admin Bearer token — see Authentication.

Released under the MIT License.