returns — module reference
Rendered from the module's own manifest, and from nothing written by hand. What the module does is its own page.
| Module id | returns |
| Name | Returns |
| Version | 1.0.0 |
| Ships from | @endora-commerce/mod-returns |
| Licence | MIT |
Activation
An operator switches this module on and off on /platform/modules. The choice is the setting returns.enabled, and it defaults to on.
Dependencies
| Module | Binding | What it means |
|---|---|---|
auth | yes | installs and migrates after it, and an operator cannot switch it off underneath this module |
customer_accounts | yes | installs and migrates after it, and an operator cannot switch it off underneath this module |
orders | yes | installs and migrates after it, and an operator cannot switch it off underneath this module |
settings | yes | installs and migrates after it, and an operator cannot switch it off underneath this module |
transactional_emails | yes | installs and migrates after it, and an operator cannot switch it off underneath this module |
credit_limits | no | refuses-without creditTopupPort — a return cannot be settled as store credit — the credit resolution refuses; refunds, replacements and repairs are unaffected |
invoices | no | refuses-without correctiveInvoicePort — no return that moves money can be settled while a corrective invoice is requested — clearing that box on the settlement lets it through, and a replacement or a repair is unaffected either way |
payments | no | refuses-without paymentRefundPort — a return cannot be settled as a refund — the money-back resolution refuses and the case stays where it was, retryable; every other resolution, and the rest of the returns flow, is unaffected |
Permissions
| Code | Label | Also needs |
|---|---|---|
returns:read | View returns / RMA cases | — |
returns:write | Manage returns / RMA cases, settlement, and configuration | — |
Command palette
| Action | Opens | Permission |
|---|---|---|
open-returns | /returns | returns:read |
return-statuses | /returns/statuses | returns:read |
Settings
| Code | Name | Type |
|---|---|---|
returns.default_cost_bearer_outside_window | Return cost bearer outside the free-return window | string |
returns.enabled | Returns enabled | boolean |
returns.free_return_days | Free-return window (days) | number |
returns.rma_number_prefix | RMA number prefix | string |
returns.rma_number_suffix | RMA number suffix | string |
Translations
Bundles at i18n inside the module, one file per shipped language.
Operator commands
None.