User Guide - RMA for Magento 2

General Configuration

Admin can configure the RMA settings under the Stores > Configuration > Dolphin > RMA.

Easy To Config

Module Status: The admin can Enable/Disable extension for the specific store where this extension is not needed.
Allow Guest RMA: Admin can set to ‘Yes’ when an RMA request allows for the guest.
Allowed Order Statuses for RMA: Admin can allow the request for specific order status.
Ask Customers to Leave Feedback: Admin can set it to ‘Yes’ when the admin needs feedback from the customers. Customers can send feedback when the item return is resolved.
Max Message Attachment File Size (KB): Admin can set the maximum file size for the message attachment.
Super Admin: Admin must be select a particular super admin to see all requests.
Send Email to Super Admin: Admin can set it to ‘Yes’ if send all requested emails to super admin.
RMA Manager: Admin can select RMA manager for managing customer requests.
Default RMA Manager: Admin can set the default RMA manager for the managed customer request.
RMA Note for Customer: Admin can set the RMA note for the customer and its display during the new return requests on the frontend.
Customer Can Cancel Request: If the admin sets it to Yes, the customer can cancel the request.
Status When Customer Cancel Request: Admin sets any one option from its list, and when the customer cancels the request then that selected option displays on the frontend.
Customer Can Reopen Request: Admin can set to Yes of the reopen request for the customer.
Status When Customer Reopen Request: Admin can set a different status when the customer reopen the request.

RMA Policy

Enable Return Policy: Admin can enable the return policy for the customer.
Return Policy CMS Page: Admin can set the specific cms page for the return policy.

Shipping

Carriers: Admin can set the multiple carrier code and labels.

RMA Email Notification

Send Email to Customer: Select Yes to send an email to the customer.
Email Sender for Customer: Set email sender for the customer.
Request Generate Customer Email Template: Select customer email template for request generate.
Status Change Customer Email Template: Select customer email template for status change.
Message From Admin Email Template: Select the admin email template for the messages.
Send Email to Admin: Select Yes to send an email to the admin.
Email Sender for Admin: Set email sender for the admin.
Request Generate Admin Email Template: Select admin email template for request generate.
Status Change Admin Email Template: Select admin email template for status change.
Assign Request Admin Email Template: Select admin email template for assign request.
Message From Customer Email Template: Select the customer email template for the messages.

Chat Settings

Enable Chat on the Frontend: Select Yes to chat on the frontend.
Quick Replies: Admin can add multiple quick replies for the customer or internal discussion.

Manage Return Request

Admin can manage all requests under the Sales > Manage Return Request.
See all requests of all users in the grid.
Admin can delete multiple requests using mass actions and also delete specific requests from the grid.

Create Return Request By Admin

Select Customer: After selecting the customer, the admin can select the order id.
Select Order: Select the customer order and submit the form.

Now, you can see the item to return and RMA information. If a return request has been created then displays a message “Already applied” in RMA Details.

Items to Return: Select the item whose to want to return and select the RMA details with return resolution and item condition.
RMA Information: Admin can manage the RMA status and RMA manager.

Update Return Request By Admin

RMA Information: Admin can see the RMA information with customer feedback.
Items to Return: Admin can set the status Pending, Approved, Delivered, Completed, and Reject.
Tracking Information: Admin can add the carrier label for tracking information and its display to the customer.
Customer Discussion: Admin can communicate with the customer and file attachments optionally. And also use the quick reply.
Internal Discussion: Admin can communicate internally also using quick reply. Admin can change the RMA status and RMA manager.

Create Return Request By Registered and Guest Customers

Go to the footer and select Return Request for guest customers. Now, add order email and order id for the return request.
Select order id for the create a new request for registered customer.
If a return request has been created then displays a message “Already applied” in RMA Details otherwise you can process further.
Customers must select items for the select reason and item conditions.
Customers can send the message to an admin if any issues and attach a file if necessary.
Customers must select Return Policy.

Manage Return Attributes

Admin can manage all return attributes under the Sales > Manage Return Attributes.
See all return type attributes in the grid.
Admin can delete multiple return attributes or specific return attributes.

Add/Edit Return Attributes

Enabled: Set Yes for the enable attribute.
Label: Set the label attribute.
Input Type: Select the input type as required with Drop Down, Multiselect Option, Radio Button, Check Box, Text Box, and Text area.
Is Require: Set Yes if return attribute is set to required for the customers.
Store View: Set the return attribute with a different store view.
User Group: Set the return attribute with a different customer group.
Priority: Set priority for the return attribute.
Return Reasons and Item Conditions: Set multiple reasons and conditions for the return items.

Manage Status

Admin can manage all status under the Sales > Manage Status.
See all status in the grid.
Admin can edit status directly from the grid with multiple edits and specific edit status.
Admin can delete multiple statuses or specific statuses.

Add/Edit Status

Enabled: Set Yes for the enable status.
Title: Set the title for the status.
Is Initial Status: Set initial status Yes. It can have only one initial status.
Request State: Select the state from the drop-down selection Processing, Approved, Delivered, Completed, Canceled, and Reopen.
Label Color: Admin can set the color label for the status.
Position: Admin can set the position for the status.
Message for Customer: Admin can set the message for the customer.
Send Email to Customer: Set Yes when the status change from the admin then sends an email to the customer.

Manage Return Rules

Admin can manage all rules under the Sales > Manage Return Rules.
See all return rules in the grid.
Admin can delete multiple return rules or specific return rules.

Add/Edit Return Rules

Enabled: Set Yes for the enable return rule.
Rule Name: Set the name for the return rule.
Store View: Set the return rule for the specific rule.
User Group: Set the return rule for the specific customer group.
Priority: Set the priority for the return rule.
Return Period (Days): Set the return period in days for the return rule. After entered days particular conditions matched products do not create a return request.
Conditions: Admin can set the different conditions for the products.

GraphQL

Use the RMA query/mutation to retrieve information about the RMA request.

Get RMA Return Attributes with Options

It will return RMA return attributes with options.

{
  GetRmaReturnAttributes {
    id
    status
    is_require
    type
    validation_type
    input_type
    user_group
    storeview
    priority
    options {
      id
      attributeid
      title
      record_id
      position
      show_status
    }
  }
}

Get RMA Store Configuration

It will return the RMA store configuration.

{
  storeConfig {
    rma_module_status
    rma_super_admin_list
    rma_manager_admin_list
    rma_default_manager_admin
    rma_send_email_to_super_admin
    rma_send_email_to_customer
    rma_send_email_to_manager
    rma_email_sender_for_customer
    rma_email_sender_for_admin
    rma_guest_status
    rma_show_policy
    rma_get_policy_page
    rma_allow_order_status_list
    rma_note_for_customer
    rma_max_file_size_allow
    rma_enable_chat_on_the_frontend
    rma_ask_customers_to_leave_feedback
    rma_customers_can_cancel_request
    rma_customers_cancel_label
    rma_customers_can_reopen_request
    rma_customers_reopen_label
    rma_shipping_carriers
  }
}

Get Order List data

It will return the order list data.

{
  GetRMAOrderList(email: "test@gmail.com") {
    label
    value
  }
}

Get New RMA and Find Guest Order by Email

It will return the new RMA and find guest orders by email.

{
  NewRmaProcess(orderId: "000000013",email:"test@gmail.com") {
    order_id
    order_entity_id
    customer_name
    customer_email
    can_cancel
    customer_address {
      firstname
      middlename
      lastname
      email
      prefix
      suffix
      city
      street_name
      region
      country_name
      postcode
      telephone
      company
    }
    items {
        item_id
        product_id
        name
        sku
        qty
        image_url
        is_return
        error_msg
        options {
        label
        value
      }
    }
  }
}

Get RMA History Data

It will return RMA history data.

{
  GetRMAHistory(currentPage:1,pageSize:1,email:"test@gmail.com") {
      id
      qty
      order_id
      date
      status{
      label
      color
    }
    product{
      name
      image
    }
  }
}

Cancel RMA Request

It will return the cancel RMA request.

mutation {
  CancelRMARequest(
    requestId: "4"
  ) {
    status
    message
  }
}

Reopen RMA Request

It will return the reopen RMA request.

mutation {
  ReopenRMARequest(
    requestId: "4"
  ) {
    status
    message
  }
}

View RMA Request

It will return the view RMA request.

{
  ViewRmaRequest(requestId: "15",email:"test@gmail.com") {
    request_id
    status{
      label
      color
    }
    order_id
    customer_name
    customer_email
    created_at
    customer_address{
      firstname
      middlename
      lastname
      email
      prefix
      suffix
      city
      street_name
      region
      country_name
      postcode
      telephone
      company
    }
    items{
      product{
        name
        url
        sku
      }
      options{
        label
        value
      }
      return_qty
      return_attributes{
        label
        value
      }
    }
    tracking_information{
      carrier
      tracking_number
    }
    messages{
        message
        message_from
        attachments{
        attachment_url
      }
      created_at
    }
  }
}

New RMA Request

It will return a new RMA request.

mutation NewReturn($input: NewReturnData!) {
  NewReturn(
    email:"test@gmail.com",
    input: $input
  ) {
    status,
    message
  }
}

$input: You need to set variables according to your data.

For example: Set Variables

{
  "input": {
    "order_id": "000000025",
    "product_details":[{
      "item_id":42,
      "product_qty":1,
        "return_attributes":[{
        "label":"Return Resolution",
        "value": "Return"
      }]
    },
    {
      "item_id":43,
      "product_qty":1,
      "return_attributes":[{
        "label":"Reason",
        "array_value":[{
          "key":"0",
          "value":"First"
        },{
          "key":"1",
          "value":"Fourth"
        }]
      }]
    }],
    "message":"Hello",
    "filedata":
    {
      "name1":"test12322.jpg",
      "name2":"test12322.jpg",
      "filecontent1":"content1",
      "filecontent2":"content2"
    }
  }
}

For dropdown, radio, text, and textarea you must use the following array.

"return_attributes":[{
      "label":"Return Resolution",
      "value": "Return"
 }]

For checkbox must use the following array.

"return_attributes":[{
      "label":"Reason",
      "array_value":[{
        "key":"First",
        "value":"0"
      },{
        "key":"Second",
        "value":"1"
      }]
}]

For multi-select must use the following array.

"return_attributes":[{
      "label":"Reason",
      "array_value":[{
        "key":"0",
        "value":"First"
      },{
        "key":"1",
        "value":"Second"
      }]
}]

RMA Feedback Submit

It will return the RMA return for feedback.

mutation Feedback($input: FeedbackData!) {
  Feedback(
    email:"test@gmail.com",
    input: $input
  ) {
    status,
    message
  }
}

$input: You need to set variables according to data.

For example: Set Variables

{
  "input": {
    "request_id": "15",
    "message":"good"
  }
}

Send Message

It will return the RMA return for message.

mutation SendMessage($input: MessageData!) {
  SendMessage(
    email:"test@gmail.com",
    input: $input
  ) {
    status,
    message
  }
}

$input: You need to set variables according to data.

For example: Set Variables

{
  "input": {
  "request_id": "18",
  "message":"Hello",
  "filedata":
    {
    "name1":"test12322.jpg",
    "name2":"test12322.jpg",
    "filecontent1":"content1",
    "filecontent2":"content2"
    }
  }
}

Customer Block

It will return the RMA return for the customer block.

{
customer{
    block_for_returns
  }
}

REST API

Please check the following example for RMA return information.

Note: You must use customer token for the registered customer return data.

Get RMA Return Attributes with Options

Method: GET

Request URL: yourdomain.com/rest/V1/rma/getattributetype

Get RMA Store Configuration

Method: GET

Request URL:

yourdomain.com/rest/default/V1/rma/configuration

yourdomain.com/rest/{storeName}/V1/rma/configuration

Show RMA History Data (Customer Token)

Method: GET

Request URL for Guest: yourdomain.com/rest/V1/rma/historydata?email=test@gmail.com

Request URL for Registered Customer: yourdomain.com/rest/V1/rma/historydata

Get Order List

Method: GET

Request URL for Guest: yourdomain.com/rest/default/V1/rma/orderlist?email=test@gmail.com

Request URL for Registered Customer: yourdomain.com/rest/default/V1/rma/orderlist

Show RMA History Data

Method: GET

Request URL for Guest: yourdomain.com/rest/V1/rma/historydata?email=test@gmail.com

Request URL for Registered Customer: yourdomain.com/rest/V1/rma/historydata

Get New RMA process and Find Guest Order By Email

Method: GET

Request URL for Guest: yourdomain.com/rest/default/V1/rma/newrequest/orderid/000000007?email=test@gmail.com

Request URL for Registered Customer: yourdomain.com/rest/default/V1/rma/newrequest/orderid/000000007

Cancel RMA Request

Method: GET

Request URL for Guest: yourdomain.com/rest/V1/rma/cancelrequest?request_id=000000017

Request URL for Registered Customer: yourdomain.com/rest/V1/rma/cancelrequest?request_id=000000017

Reopen RMA Request

Method: GET

Request URL for Guest: yourdomain.com/rest/V1/rma/reopenrequest?request_id=000000024

Request URL for Registered Customer: yourdomain.com/rest/V1/rma/reopenrequest?request_id=000000024

View RMA Request

Method: GET

Request URL for Guest: yourdomain.com/rest/default/V1/rma/viewrequest/requestid/15?email=test@gmail.com

Request URL for Registered Customer: yourdomain.com/rest/default/V1/rma/viewrequest/requestid/15

RMA Feedback Submit

Method: POST

Request URL for Guest: yourdomain.com/rest/default/V1/rma/submitfeedback?email=test@gmail.com

Request URL for Registered Customer: yourdomain.com/rest/default/V1/rma/submitfeedback

Send Message

Method: POST

Request URL for Guest: yourdomain.com/rest/default/V1/rma/sendmessages/requestid/18?email=test@gmail.com

Request URL for Registered Customer: yourdomain.com/rest/default/V1/rma/sendmessages/requestid/18

Body:

{
      "filedata":
          {
          "name1":"test12322.jpg",
          "filecontent1":"filecontent1",
          "name2":"test123.jpg",
          "filecontent2":"filecontent2"
          },
      "message":"This is sample message"
}

New RMA Request

Method: POST

Request URL for Guest: yourdomain.com/rest/default/V1/rma/newreturn?email=test@gmail.com

Request URL for Registered Customer: yourdomain.com/rest/default/V1/rma/newreturn

Body:

{
  "message": "Hello",
  "orderid": "000000025",
  "filedata": {
      "name1": "test.jpg",
      "filecontent1": "filecontent"
  },
  "productdetails": [
    {
      "item_id": 42,
      "product_qty": 1,
      "return_attributes": [
        {
          "label": "Return Resolution",
          "value": "Return"
        }
      ]
    },
    {
      "item_id": 43,
      "product_qty": 1,
      "return_attributes": [
        {
          "label": "Return",
          "array_value": [
            {
              "key": "0",
              "value": "First"
            },
            {
              "key": "1",
              "value": "Fourth"
            }
          ]
        }
      ]
    }
  ]
}

For dropdown, radio, text, and textarea you must use the following array.

"return_attributes":[{
      "label":"Return Resolution",
      "value": "Return"
 }]

For checkbox must use the following array.

"return_attributes":[{
  "label":"Reason",
  "array_value":[{
    "key":"First",
    "value":"0"
  },{
    "key":"Second",
    "value":"1"
  }]
}]

For multi-select must use the following array.

"return_attributes":[{
  "label":"Reason",
  "array_value":[{
    "key":"0",
    "value":"First"
  },{
    "key":"1",
    "value":"Second"
  }]
}]

Live Demo

Frontend

Admin Panel

Contact Us

If you want customization or more functionality in our Extension, feel free to contact us. We are eager to shape your system with our effective solutions.!!!