return manager - magento · that, go to magento 2 root folder, open terminal there and run...
Post on 15-Aug-2020
8 Views
Preview:
TRANSCRIPT
Velocity Software Solutions Pvt. Ltd. E-23, Sector 63, Noida – 201301, India.
Ph:+91-120-4243310. Velocity Software Solutions Pvt. Ltd.
Reg. Office: E23, Sector 63, Noida – 201 301 , U.P. (India) P a g e | http://www.velsof.com
1
Return Manager
User Manual v1.0.0
Prepared by
Velocity Software Solutions Pvt. Ltd.
Website: www.velsof.com,
E-mail: inquiry@ velsof.com
E-23, Sector-63, Noida. Phone: +91-120-4243310
Velocity Software Solutions Pvt. Ltd. E-23, Sector 63, Noida – 201301, India.
Ph:+91-120-4243310. Velocity Software Solutions Pvt. Ltd.
Reg. Office: E23, Sector 63, Noida – 201 301 , U.P. (India) P a g e | http://www.velsof.com
2
Contents
Contents ................................................................................................................................... 2
Introduction ............................................................................................................................... 2
Technology for Development ................................................................................................ 3
Installation Guide ..................................................................................................................... 3
Admin Module .......................................................................................................................... 5
General Settings .................................................................................................................... 6
Return Slip Settings ............................................................................................................... 7
Return Policies ....................................................................................................................... 8
Return Reasons ................................................................................................................... 10
Return Statuses ................................................................................................................... 11
Create a Return .................................................................................................................... 13
Email Templates .................................................................................................................. 15
Pending Returns List ........................................................................................................... 17
Active Returns List ............................................................................................................... 18
Archives List ......................................................................................................................... 19
Front End Module .................................................................................................................. 21
Velocity Software Solutions Pvt. Ltd. E-23, Sector 63, Noida – 201301, India.
Ph:+91-120-4243310. Velocity Software Solutions Pvt. Ltd.
Reg. Office: E23, Sector 63, Noida – 201 301 , U.P. (India) P a g e | http://www.velsof.com
3
Introduction
Return Manager for Magenrto 2 adds the functionality to manage return requests for
any order placed by a customer as well as a guest customer. The plugin adds a link to
the front-end through which any customer/guest customer can apply for return of any
product contained in a order placed earlier.
This is a very flexible plugin and the customer can return any product in a order
completely or partially, that means the customer can also return half or less quantity of
any product in the order.
For a logged in user (if the module is enabled from backend) the Return Manager link
appears in Account options list (near the cart link) and in the quick links shown in the
footer and opens a page containing the list of all the orders placed by that particular
customer and the products that are eligible for return have a link to apply for return.
This page also contains history of returns applied by the logged in customer.
In case the user is not logged in the Return Manager link opens a page containing a
form to find any order. After finding a order using the form the order detail appear and
the products from that particular order that are eligible for return have a link to apply
for return. This page also contains history of returns applied by the customer who has
placed this particular order.
Technology for Development
Language: PHP
Frame Work: Magento
Installation Guide
1. Folder structure of the Return Manager plugin folder.
Velocity Software Solutions Pvt. Ltd. E-23, Sector 63, Noida – 201301, India.
Ph:+91-120-4243310. Velocity Software Solutions Pvt. Ltd.
Reg. Office: E23, Sector 63, Noida – 201 301 , U.P. (India) P a g e | http://www.velsof.com
4
2. Copy all the folders into magento root directory and clear the cash (if enabled).
3. You will be able find the “RMA” option inside the “Knowband” option.
4. Now you need to install tcpdf library (Only if not already installed). TCPDF is a
library to generate pdf.
5. Make sure that composer is installed on your device.
6. To install tcpdf library, go to the Magento 2 installation directory root and run
following command from the terminal:
7. Sudo composer require tecnickcom/tcpdf
8. After this command, it will ask for credentials.
9. If you don‟t have credentials then go to following site and create new account.
“https://www.magentocommerce.com/magento-connect/customer/account/login/”
Velocity Software Solutions Pvt. Ltd. E-23, Sector 63, Noida – 201301, India.
Ph:+91-120-4243310. Velocity Software Solutions Pvt. Ltd.
Reg. Office: E23, Sector 63, Noida – 201 301 , U.P. (India) P a g e | http://www.velsof.com
5
After logging in, go to Connect tab and click on Developers, then click on “Secure
Keys”option and generate a new key.
10. Now use public key as username and private key as password (look step 7).
These are the credentials you have to enter.
11. Sit back and relax. TCPDF library will be installed on your device soon.
12. It may ask you to run upgrade command when any page is opened. To do
that, go to magento 2 root folder, open terminal there and run following command
sudo bin/magento setup:upgrade
After this command run next command
sudo bin/magento setup: static-content:deploy
And then provide permissions (read, write, execute) to the all magento directories.
Eg. chmod -R 777 <root_installation_directory>
12. Now you are ready to go.
Admin Module
After installing Return Manager into store, the plug-in will provide following interfaces
inside “RMA” option:
1. General Settings
2. Return Slip Settings
3. Email Templates
4. Return Policies
5. Return Reasons
6. Return Statuses
7. Create a RMA
8. Pendin Requests
9. Approved Requests
10. Archived Requests
Velocity Software Solutions Pvt. Ltd. E-23, Sector 63, Noida – 201301, India.
Ph:+91-120-4243310. Velocity Software Solutions Pvt. Ltd.
Reg. Office: E23, Sector 63, Noida – 201 301 , U.P. (India) P a g e | http://www.velsof.com
6
11. Success Messsages
Each interface is in form of a tab and each tab contains some specific
settings/functionality that can be changed according to the need. Each tab is
explained below.
General Settings
After clicking on RMA tab , system will open general settings tabs by default as shown
in screen below:
Initially fields in above form will be already filled with their default values.
1. Enable/Disable: Initially, this will be “OFF”. Admin can enable/disable plug-in by
turning ON/OFF this setting.
2. Allow Guest RMA: This drop down contains “Yes” and “No” options. Set this as
“Yes” to enable the return feature for those users also who are not logged in.
3. Allowed File Extensions: This option accepts the comma (,) seperated file
extensions (without space) which can be uploaded when customer uploads file
related to the return request.
Velocity Software Solutions Pvt. Ltd. E-23, Sector 63, Noida – 201301, India.
Ph:+91-120-4243310. Velocity Software Solutions Pvt. Ltd.
Reg. Office: E23, Sector 63, Noida – 201 301 , U.P. (India) P a g e | http://www.velsof.com
7
4. Max Attachment Size: In this field maximum allowed file size is accepted. The
file size will be in KB. Eg- To allow files upto 1MB set this field as 1024.
To save the settings, click on the “Save” button shown at right upper area.
Return Slip
In this tab, the admin can alter the settings and content of the Return Slip. This return
slip is generated automatically when the admin approves any return request (if the
feature is enabled). The return slip is generated in „.pdf‟ format and the link is mailed
to the customer in the mail for Return Request Approval Notification.
1. Enable/Disable Return Slip: Initially, this will be “OFF”. Admin can enable/disable
Return Slip feature by turning ON/OFF this setting. Return slips are only generated
when the feature is turned ON.
Velocity Software Solutions Pvt. Ltd. E-23, Sector 63, Noida – 201301, India.
Ph:+91-120-4243310. Velocity Software Solutions Pvt. Ltd.
Reg. Office: E23, Sector 63, Noida – 201 301 , U.P. (India) P a g e | http://www.velsof.com
8
2. Return Address: This address will be printed on the return slip and will also be
displayed on the return request form.
3. Return Guidelines: These guidelines will be printed on the return slip.
Return Policies
In this tab, the admin can add new return policies for the plugin and can also edit or
delete a existing return policy for the Return Manager for Magento 2.
There is also a option to map the return policies to products.
Note: A product can only be mapped to a maximum of one return policy.
This tab contains a list of existing return policies for the plugin. The admin can also
create a new return policy using the „ Add New ‟ button shown near to the “Save
Settings” button.
After clicking on the add new button a pop-up appears containing the form to create
the return policy.
Velocity Software Solutions Pvt. Ltd. E-23, Sector 63, Noida – 201301, India.
Ph:+91-120-4243310. Velocity Software Solutions Pvt. Ltd.
Reg. Office: E23, Sector 63, Noida – 201 301 , U.P. (India) P a g e | http://www.velsof.com
9
The form contains several input fields to enter the data of the policy like name of the
policy, terms and condition of the policy and the option to choose the parameters i.e.
Credit, Return and Replacement.
The admin can also enter the days applicable for this return policy for different options
as shown in the form below.
The add new policy form will look as shown in the screen below:
Actions
1. The admin can edit any policy using the first link in the Action column from the
policy listing table. On clicking this link a modal containing the form for the policy will
appear and the data for that policy is already filled in the fields. The admin can edit
any data and can save the changes made.
2. The second link in the actions column is for mapping products to the policy. On
clicking this link a modal will appear containing the options to map the products to that
particular policy.
Velocity Software Solutions Pvt. Ltd. E-23, Sector 63, Noida – 201301, India.
Ph:+91-120-4243310. Velocity Software Solutions Pvt. Ltd.
Reg. Office: E23, Sector 63, Noida – 201 301 , U.P. (India) P a g e | http://www.velsof.com
10
Return Reasons
In this tab, a list of return reasons will appear in the form of a table. By default there
are 2 reasons already added in to the system.
In Action column there is a link to edit the reason in front of every row.
Velocity Software Solutions Pvt. Ltd. E-23, Sector 63, Noida – 201301, India.
Ph:+91-120-4243310. Velocity Software Solutions Pvt. Ltd.
Reg. Office: E23, Sector 63, Noida – 201 301 , U.P. (India) P a g e | http://www.velsof.com
11
The admin can add as many reasons as required to the system using the „Add New‟
button. On clicking on the button a form will appear to add new Return Reason into
the system. The form is shown below:
Admin can edit any reason as well by clicking on edit icon shown in front of every
reason.
Return Statuses
This tab contains a list of return statuses in the form of a table. By default there are 4
statuses already added into the system. The admin can further add any numbers of
statuses into the system. The tab also contains a option to choose default status of
any return request. This default status will be assigned to the all the new return
requests.
The links below the action column in the statuses list is for editing the existing return
statuses.
Velocity Software Solutions Pvt. Ltd. E-23, Sector 63, Noida – 201301, India.
Ph:+91-120-4243310. Velocity Software Solutions Pvt. Ltd.
Reg. Office: E23, Sector 63, Noida – 201 301 , U.P. (India) P a g e | http://www.velsof.com
12
The admin can add as many statuses as required to the system using the „Add New‟
button. On clicking on the button a form will appear in a modal to add new Return
Reason into the system. The form is shown below:
Admin can also select the default status for the request by using the select box.
Velocity Software Solutions Pvt. Ltd. E-23, Sector 63, Noida – 201301, India.
Ph:+91-120-4243310. Velocity Software Solutions Pvt. Ltd.
Reg. Office: E23, Sector 63, Noida – 201 301 , U.P. (India) P a g e | http://www.velsof.com
13
Create a Return
This tab is used to generate a return request from the admin panel itself. The tab
contains a form through which the admin can find any order by simply providing the
reference number and the corresponding e-mail and then apply for return accordingly.
Note:
1. Any return request whether is created by admin or customer is moved to the
pending returns and the admin has to approve it first to further change the status of
the return request or to take any further action.
2. The orders that are delivered or completed are only eligible for return.
3. By default the status of the return request is set to default return status set by the
admin in the „ Return Statuses ‟ tab.
When the admin finds an order using the find order form then the order detail for the
respective order will appear containing the list of products and a return button in front
of products eligible for return. When the admin clicks on the return button a pop-up will
appear containing the return from and enter specific data for the return request.
Velocity Software Solutions Pvt. Ltd. E-23, Sector 63, Noida – 201301, India.
Ph:+91-120-4243310. Velocity Software Solutions Pvt. Ltd.
Reg. Office: E23, Sector 63, Noida – 201 301 , U.P. (India) P a g e | http://www.velsof.com
14
The admin has to fill the above form and then click on submit then a success form will
appear showing the successful submission of the return request as shown below :
Velocity Software Solutions Pvt. Ltd. E-23, Sector 63, Noida – 201301, India.
Ph:+91-120-4243310. Velocity Software Solutions Pvt. Ltd.
Reg. Office: E23, Sector 63, Noida – 201 301 , U.P. (India) P a g e | http://www.velsof.com
15
Email Templates
This tab contains a interface through which the admin can edit any email template that
is used in this system.
Velocity Software Solutions Pvt. Ltd. E-23, Sector 63, Noida – 201301, India.
Ph:+91-120-4243310. Velocity Software Solutions Pvt. Ltd.
Reg. Office: E23, Sector 63, Noida – 201 301 , U.P. (India) P a g e | http://www.velsof.com
16
There are 6 email templates available that are used by this plugin:
1. New Return Request Notice (Customer)
This mail template is used to notify the customer regarding the new Return Request
generated by the customer itself. The customer who has created return request will
only receive this mail.
2. New Return Request Notice (Admin)
This mail template is used to notify the Store Owner regarding the new Return
Request generated by any customer.
3. Return Request Approved
This mail template is used to notify the customer regarding the Approval of the Return
Request that is created by the customer earlier.
4. Return Request Dis-Approved
Velocity Software Solutions Pvt. Ltd. E-23, Sector 63, Noida – 201301, India.
Ph:+91-120-4243310. Velocity Software Solutions Pvt. Ltd.
Reg. Office: E23, Sector 63, Noida – 201 301 , U.P. (India) P a g e | http://www.velsof.com
17
This mail template is used to notify the customer regarding the Dis-Approval of the
Return Request that is created by the customer earlier.
5. Return Request Status Change
This mail template is used to notify the customer regarding the update in status of the
Return Request that is created by the customer earlier.
6. Return Request Completed
This mail template is used to notify the customer regarding the completion of the
Return Request that is created by the customer earlier.
To edit any email template the admin has to choose the desired email template. On
doing the same the email template data will appear in a form below, to save the
changes made the admin has to click on the „Save‟ button.
Pending Requests
This tab contains a list of all the returns that are pending i.e. are not approved by the
admin. The admin has to approve a return request in order to perform several
operations on the return request like approve and dis-approve the request or
download/view the file uploaded by the customer.
The admin can approve or deny a return request using the actions available in front of
the list.
Admin can also download or view the file uploaded by the customer. View option is
only available if the customer has uploaded the file.
Once the admin approves a return request then it is moved to the Active Returns List.
On the other hand if the admin denies a return request that it is removed from the list
and this action can not be undone.
Velocity Software Solutions Pvt. Ltd. E-23, Sector 63, Noida – 201301, India.
Ph:+91-120-4243310. Velocity Software Solutions Pvt. Ltd.
Reg. Office: E23, Sector 63, Noida – 201 301 , U.P. (India) P a g e | http://www.velsof.com
18
Active Returns List
This tab contains a list of all the returns that are approved by the admin. The admin
can proceed with the return process after approving the return request using this tab.
The admin can change the status of the return request and can also deny a request
form this tab and can archive the request as well.
Velocity Software Solutions Pvt. Ltd. E-23, Sector 63, Noida – 201301, India.
Ph:+91-120-4243310. Velocity Software Solutions Pvt. Ltd.
Reg. Office: E23, Sector 63, Noida – 201 301 , U.P. (India) P a g e | http://www.velsof.com
19
The actions that can be performed from this tab for the active returns are:
1. Deny the return request.
2. Change the status of the return request by clicking on the edit icon.
3. Mark the return request as complete / add to archive.
When the admin marks a return request as complete then it is moved to the archives
list.
Archived Requests
This tab contains all the return requests that are complete. The tab also contains a
form through which the admin can filter the archives list.
Velocity Software Solutions Pvt. Ltd. E-23, Sector 63, Noida – 201301, India.
Ph:+91-120-4243310. Velocity Software Solutions Pvt. Ltd.
Reg. Office: E23, Sector 63, Noida – 201 301 , U.P. (India) P a g e | http://www.velsof.com
20
There are options to export the data into csv file.
Single row can be exported and the whole data can also be exported using mass
export option.
Success Messages
This tab contains three textareas having html editors. Using the editors, admin can set
the style of the success message to be shown in the pop-up whenever the request is
successful.
Velocity Software Solutions Pvt. Ltd. E-23, Sector 63, Noida – 201301, India.
Ph:+91-120-4243310. Velocity Software Solutions Pvt. Ltd.
Reg. Office: E23, Sector 63, Noida – 201 301 , U.P. (India) P a g e | http://www.velsof.com
21
There are three messages.
1. Credit
2. Refund
3. Replacement
Front End Module
After enabling the plugin the front-end user will see a link in the header of the
front-end through which the user can navigate to a new page.
The link in the header of the front-end will appear as follows:
When the customer clicks on this link than a new page will open on the basis of
logged in status of the customer.
- In case the user is a guest and is not logged into the website then the page will
contain a form to find the order as follows:
Velocity Software Solutions Pvt. Ltd. E-23, Sector 63, Noida – 201301, India.
Ph:+91-120-4243310. Velocity Software Solutions Pvt. Ltd.
Reg. Office: E23, Sector 63, Noida – 201 301 , U.P. (India) P a g e | http://www.velsof.com
22
After proving the order reference number and the respective email the details of that
order will appear including the return history on the basis of the email provided by the
customer. The order details will appear as follows:
The products that are eligible for return in that particular order will have a return
button. Through this button the customer can apply for return of that particular
product.
By clicking on the „Return‟ button a pop-up will appear containing the form for return of
that particular order. The form will appear as follows:
Velocity Software Solutions Pvt. Ltd. E-23, Sector 63, Noida – 201301, India.
Ph:+91-120-4243310. Velocity Software Solutions Pvt. Ltd.
Reg. Office: E23, Sector 63, Noida – 201 301 , U.P. (India) P a g e | http://www.velsof.com
23
The customer has to fill the above form and then click on submit then a success form
will appear showing the successful submission of the return request as shown below :
Velocity Software Solutions Pvt. Ltd. E-23, Sector 63, Noida – 201301, India.
Ph:+91-120-4243310. Velocity Software Solutions Pvt. Ltd.
Reg. Office: E23, Sector 63, Noida – 201 301 , U.P. (India) P a g e | http://www.velsof.com
24
There is as option to upload files in the success page. From where you can upload file
and admin can view/download that file from aamin panel. File limitations are set from
admin panel.
- In case the user is a registered customer and is logged into the website then the
page will contain a list of all the orders placed by the customer. The page will appear
as follows:
There will be the details of every order. We can expand any of the order division (will have
to click where the arrows are pointed). On click the respective order division will be
expended.
Velocity Software Solutions Pvt. Ltd. E-23, Sector 63, Noida – 201301, India.
Ph:+91-120-4243310. Velocity Software Solutions Pvt. Ltd.
Reg. Office: E23, Sector 63, Noida – 201 301 , U.P. (India) P a g e | http://www.velsof.com
25
To view all the history of the return requests, user will have to expand the “Return History”
tab.
Additional Notes: Please make sure that there is a folder in you magento root directory
named VssFiles. Inside VssFiles, one folder called “vss_rma” should exist and two more
folders should be created (if not exist) inside “vss_rma” folder. Names of the folders inside
“vss_rma” are “return_slips” and “userfiles”.
“magento_2_root_folder” is the same folder (directory) in which other folders like “app”,
“bin” etc exist. “return_slips” folder contains all the slips generated during return process
and customers can download return slip and the “userfiles” folder is the folder where files
uploaded by users are stored.
After creating folders please give all of these folders full permissions. If folders exist already,
then also give full permissions (-w-r-x).
Velocity Software Solutions Pvt. Ltd. E-23, Sector 63, Noida – 201301, India.
Ph:+91-120-4243310. Velocity Software Solutions Pvt. Ltd.
Reg. Office: E23, Sector 63, Noida – 201 301 , U.P. (India) P a g e | http://www.velsof.com
26
top related