Skip to main content

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 idreturns
NameReturns
Version1.0.0
Ships from@endora-commerce/mod-returns
LicenceMIT

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​

ModuleBindingWhat it means
authyesinstalls and migrates after it, and an operator cannot switch it off underneath this module
customer_accountsyesinstalls and migrates after it, and an operator cannot switch it off underneath this module
ordersyesinstalls and migrates after it, and an operator cannot switch it off underneath this module
settingsyesinstalls and migrates after it, and an operator cannot switch it off underneath this module
transactional_emailsyesinstalls and migrates after it, and an operator cannot switch it off underneath this module
credit_limitsnorefuses-without creditTopupPort — a return cannot be settled as store credit — the credit resolution refuses; refunds, replacements and repairs are unaffected
invoicesnorefuses-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
paymentsnorefuses-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​

CodeLabelAlso needs
returns:readView returns / RMA cases—
returns:writeManage returns / RMA cases, settlement, and configuration—

Command palette​

ActionOpensPermission
open-returns/returnsreturns:read
return-statuses/returns/statusesreturns:read

Settings​

CodeNameType
returns.default_cost_bearer_outside_windowReturn cost bearer outside the free-return windowstring
returns.enabledReturns enabledboolean
returns.free_return_daysFree-return window (days)number
returns.rma_number_prefixRMA number prefixstring
returns.rma_number_suffixRMA number suffixstring

Translations​

Bundles at i18n inside the module, one file per shipped language.

Operator commands​

None.