Child pages
  • RMA - Magento 2
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

Thank you for choosing aheadWorks!


Installing RMA

To install the extension follow the instructions below:

1. Backup your web directory and store database

2. Download RMA installation package

 3. Upload contents of the RMA installation package to your store root directory.

 4. In SSH console of your server navigate to your store root folder:

cd path_to_the_store_root_folder


php -f bin/magento module:enable Aheadworks_Rma

and then:

php -f bin/magento setup:upgrade

5. Flush store cache; log out from the backend and log in again.


In case you are running different from Magento recommended server configuration, it may be required, in addition to step 4 of the Installation instructions, to run the following:

php -f bin/magento setup:static-content:deploy



Getting Around

RMA extension comes ready for work right after installation.

Once installed RMA extension introduces My Returns section to the customer account page and Create New Return link to the store footer. Both links lead to creating new RMA request.



Along with My Returns section and Create New Return link customers can request an RMA from order details page of My Orders account section.


If you allow guest customer checkouts, with the help of RMA extension you can also allows your guest customers to ask for a return.

Guest customers can ask for an RMA by clicking Create New Return link in the store footer.

To ask for an RMA guest customers need to specify an email address with which they have placed an order at your store and specify the order number.

 Click here to see how guest RMA form looks like...


Let's request an RMA from the My Returns section. To do this click button.



At the Select order to create RMA screen specify the order you want to request an RMA for, select order item(s) and specify the item quantity (if several).

Once done, click button to proceed to the next step.



At this step specify an RMA Resolution - Refund or Replacement - and select Package Condition. These are the Custom Fields that come with RMA extension by default.


Later you can add other Custom Fields or edit existing ones at the corresponding section of your store backend



Below RMA Resolution and Package Conditions specify an RMA Reason for order item(s) and leave a message to the store representatives if necessary.


Both customer and store administrator messages are combined in a chat that can later be seen under an RMA request.

 Click here to see how chat looks like...

Once done, click button.

RMA request has been submitted.

All the RMA request information allong with the messages thread can later be found under My Returns section.


Managing RMA requests

RMA extension introduces its sections to the Sales admin dashboard section of your Magento 2 store.

Manage RMA

This is the main section of the extension. Here you are suggested to approve, cancel and manage all the RMA requests submitted by the store customers.



You may want to start with adjusting the RMA grid according to your requirements:

  • Click button to see though the columns available and customize the RMA grid, some columns may be excessive and some relevant to your current tasks;
  • Click button to look for the RMA requests matching a set of attributes;
  • Click button to save the perfect RMA grid look you found to quickly load it whenever required.

With the RMA grid configured you may want to start managing RMA requests.

Let's approve the RMA we have submitted in the Getting Around section.

Replying to the RMA

Click RMA Request ID to proceed to the Manage Request screen.



At Manage Request screen you are suggested to:

  • Approve cancel customer request with the appropriate buttons;
  • Reply to the customer's message or update customer on the request status or come back with other information necessary;
  • Edit the request Custom Fields.

Step 1

Let's leave a message as per screenshot and approve the request by clicking button.

Now the email notifying customer of a new reply and a request status update will be send.

Customer will now have options to print shipping label (to be included in the RMA package) and confirm that the package has been sent back to your store.

 Click here to see how the Shipping Label looks like...

Step 2

After the request has been approved and customer confirms that the package has been sent back to your store you will need to confirm that the package has been received.

Do that by clicking button.

Step 3

Now, depending on the customer's request type, you can either the RMA or .

The original request was for a replacement, let us consider receiving a package from customer and sending a Tee of a correct size back and resolve the RMA by closing it.

That's it. The RMA request has been sucessfully resolved and customer received a replacement. Let's proceed to the RMA extensions settings.



RMA extension for Magento 2 doesn't offer any refunding or postal services.

The refunds are processed manually by the any means necessary.


Adjusting RMA options and settings


Statuses and Email Templates

As it has been mentioned previously RMA extension comes set up and ready for work right after the installation. However, if it is required you can always adjust RMA request statuses and edit the notification emails sent to both customer and store administrator to correspond your requirements.




There are seven RMA request statuses, each defining particular stage of the RMA process.

Pending ApprovalAssigned to the new return request automatically
ApprovedAssigned upon store administrator approving an RMA request
Package SentAssigned upon customer confirming package sending
Package ReceivedAssigned upon store administrator confirming package has been received
Issue RefundAssigned upon store administrator issuing a refund
ClosedAssigned upon closing a request either by customer or store administrator
CanceledAssigned upon store administrator cancelling the request

Email Templates

Depending on the request type it is also possible to send an email notification to customer, store administrator or both.

Along with defining email templates for the email notifications it is also possible to edit the request thread message to be displayed upon RMA obtaining particular status.

Custom Fields

In the Getting Around section when submitting an RMA request you have been suggested to fill in RMA Resolution, Package Condition and Reason for asking RMA.

These are all pre-defined Custom Fileds that come with the RMA extension by default and can be edited here at Custom Fields section.



Along with editing the Custom Fields that come with the extension by default you can also create additional Custom Fields depending on the products or services you are offering.

To create a Custom Field click button:

  • Define name (for internal identification purposes) of the Custom Field and the field type: text field, text area, dropdown, multiselect;
  • Decide if the Custom Field should refer to the RMA request on the whole (as Resolution in the example) or to the order item (as Reason in the example);
  • Set the RMA status at which store administrator and customer can edit/view the Custom Field;
  • Make the Custom Field required if necessary (customers will not be able to submit a request without filling the Custom Field);
  • Add the Custom Field to the Shipping Label (this may help identifying the parcel);
  • Chose a website the Custom Field should be displayed at.
  • Adjust Custom Field frontend label (name of the Custom Field customers will see).
  • Add options if you want customer to select from the pre-defined set of attiributes.

Once done with the Custom Attribute click button.

The Custom Field has been created and can now be found at the set area of the RMA request page.


RMA text blocks and Policy




You can always find the latest version of the software, full documentation, demos, screenshots and reviews at
License agreement:
Contact Us:
Copyright © 2015 aheadWorks Co.

  • No labels