Getting Started

Welcome to the RMA Documentation.

Here you will find everything you need to set up Return Merchandise Authorization (RMA) and create a flexible policy for product returns and refunding.

Our extension allows customers to submit request for return, after his order is complete. This request can result either in Exchange Order, or in Refund, making return process easy and flexible.

Go ahead, dive in!

Firstly, please, find our extension in My Downloadable Products section of our store. Learn how to install extension, and proceed with Quick Start, which will guide you to setup your return policy.

How to install extension

How to install extension Backup your store's database and web directory. Login to the SSH console on your server and navigate to the root directory of the Magento 2 store. Copy installation instructions from page My Downloadable Products to SSH console...

Quick Start

Quick Start Our Return Merchandise Authorization (RMA) extension for M2 is a simple, yet powerful tool for managing products returns. Most of its functions are quite intuitive, and work just out-of-box. However, it also features rich configuration, which...

RMA Settings

RMA Settings This section describes the most of settings, that you can use for configuring your returns policy, except of Email Notification Settings, which is included in other section: General Settings Customer Account Settings RMA Policy RMA Number ...

Email Notifications

Email Notifications RMA extension sends emails with different types of notifications to the customer and store agents. You can customize the templates of those emails. In this section, you will find: How to Configure Email Notifications How to Disable E...

Statuses

Statuses Each RMA request proceeds through a set of stages, on which data are gathered, goes communication with customers, and performed some actions. Each of these stages corresponds with Status, which is crucial part of RMA. By default RMA can have the...

Reasons

Reasons Each product, returned by customer, can be supplied with Reason, why did customer choose to return this particular product. It is extremely useful for monitoring return statistics (refer to Report by Reason), and can be used for improving your sa...

Conditions

Conditions Each product, returned by customer, can be supplied with description of its current (or on arrival - depending on your police) Condition. Our extension provides you with basic conditions set, but you're free to create your own. How to create ...

Resolutions

Resolutions When customer submits an RMA, it can mark, which service he would select - for example, Exchange or Refund. Typically, these two are enough to create reliable return service, but sometimes you need an extended resolutions - different kinds of...

Custom Fields

Custom Fields Custom fields are poweful instrument to boost your return services, especially when you had defined additional Resolutions. You can use them to store additional information about RMA. For example, when a customer confirms the shipment of RM...

Quick Responses

Quick Responses While communicating with your customers, you might encounter typical situations, which need typical answers. This can be resolved by many ways. Some of them you may resolve by establishing a special Status or even Workflow Rule, with autom...

Workflow Rules

Workflow Rules Workflow Rules are powerful tool for automating standard situation, that can occur during RMA submission, or processing. Each rule is binded to certain event, which will trigger their execution. When rule is triggered, it validates its cond...

Return Adresses

Return Adresses RMA extension allows you to create a list of return addresses for RMA. How to create a new return address Go to the Sales > RMA > Return Addresses. Press the button Add New. You'll see following edit page: General information Titl...

GraphQL Objects Reference

GraphQL Objects Reference Query object The Query object can contain the following attributes: Attribute Data Type Description customerRmas CustomerRmas List of customer RMAs rmaDictionary RmaDictionary List of RMA dictionaries CustomerRma obje...

Guide for Store Agents

Guide for Store Agents This section is divided into following subsections: RMA Listing Overview of RMA Workflow RMA Workflow Explained RMA Listing Go to the Sales -> RMA. There all RMAs are located, and there they can be managed, edited and removed...

Processing RMA

Processing RMA RMA Edit Page has the following layout: On top of RMA Edit page Action Ribbon is located, which allows the following functions: To apply changes the agent should press the button Update. To apply changes and send a message to the customer...

Reports

Reports Our extension allows you to observe your RMA flow, and gather statistics of returns, based on different parameters. Currently, we support the following types of Reports: Report By Product Report By Attribute Report By Status Report By Reasons Re...

How-To

How-To This section contains resolution advices for a most common problems, that you can notice. How can I disable guest RMA How can I prevent product from being returned? How shall I create auto-reply messages to customer? How shall I use "Template...

Migration from Magento 1 to Magento 2

Migration from Magento 1 to Magento 2 Below are examples of scripts, which may be used for transferring data from Mirasvit RMA for Magento 1 to Mirasvit RMA for Magento 2. To use scripts you need a help of PHP developer. Scripts may contain bugs and may n...

How to upgrade the extension

How to upgrade the extension To upgrade the extension follow these steps: Backup your store's database and web directory. Login to the SSH console of your server and navigate to the root directory of the Magento 2 store. Run the command composer require ...

Disabling Extension

Disabling Extension Temporarily Disable To temporarily disable the extension please follow these steps: Login to the SSH console on your server and navigate to the root directory of the Magento 2 store. Run command php -f bin/magento module:disable Miras...

Change Log

Change Log 2.1.26 (2021-02-08) Fixed Error "Too few arguments to function ..., 0 passed" Issue when status fields display the 'default storeview' scope value for 'All Storeviews' scope 2.1.25 (2021-01-13) Fixed RMA message status read/unread...