Return Merchandise Authorization
Return Merchandise Authorization (RMA) enables customers to initiate returns on the webstore without involving Customer Care. The RMA is an API based service used primarily by customers / Customer Care agents / store associates through multiple customer touch points. The inclusion of an RMA service to the existing RLS service enables all the capabilities that exist now with RLS and provides functionality for returns.
Overview
RMA Service exposes unique operations to:
- RMA Eligibility - Perform return eligibility check for an order and return eligible / ineligible items.
- RMA Request - Create unique RMA ID and return / email RMA confirmation.
- RMA Lookup - Perform RMA look up / package eligibility and return RMA IDs / RMA details / package eligibility.
The above operations are exposed over HTTP. Clients should post XML requests to the RMA Service endpoint and will receive XML responses back.
Return Label Service (RLS) can be called to create return labels based on RMA information. Please refer to the RLS service documentation regarding how to use the RLS service.
Examples of typical requests and responses are provided later on this page.
Return Merchandise Authorization URI Summary
The Return Merchandise Authorization URI uses the service identifier rma.
Operation | Action | URI Template | URI Example | Transaction Type | Unique RequestID Needed for Duplicate Detection? | Non-URI Request / Payload |
---|---|---|---|---|---|---|
Determine eligibility for return | GET | vM.m/sellers/{sellerId}/orders/{orderId}/returns/checkEligibility/new |
/v1.0/seller/BB2US/return-order/create/3000151214/checkEligibility.json |
Checks eligibility of order and items for returns |
No |
XML |
Generate RMA | POST | /vM.m/return-order-create/sellers/{sellerId}/orders/{orderId}returns/generateRMA |
/v1.0/seller/TMSUS/return-order/create/3000179302/generateRMA.json |
Generates RMA ID for eligible items |
No |
XML |
Look up RMA | POST | /vM.m//return-order-create/sellers/{sellerId/orders/{orderId}returns/lookupRMA |
/v1.0/seller/TMSUS/return-order/create/3000179302/lookupRMA.json |
Looks up RMA information on the basis of the RMA ID or order ID. Also, performs package calculation for the RMA items and provides package eligibility. |
No |
XML |
URI domain name: Radial recommends using the new domain at apg.radial.com. To connect to production Radial APIs, use the following form of the URL:
https://apg.radial.com/v1.0/proxyname/storecode/function
You should have received the applicable information for proxyname, storecode, and function from your Radial representative.
Note: The old domain will still be in operation until further notice from Radial. For more information on Radial API URIs, see API Requests and Responses.
Error Codes
API | Override Ineligibility | RMA Error Code | RMA Error Description |
---|---|---|---|
RMA Eligibility |
False | RMA 1001 | Invalid XML Error |
RMA Eligibility RMA Request RMA Lookup |
False | RMA 1004 | Internal Server Error |
RMA Eligibility | True | RMA 1006 | Return Request is out of Return Window |
RMA Eligibility and RMA Lookup |
False | RMA 1002 | Store Not Found |
RMA Eligibility and RMA Lookup |
False | RMA 1003 | Order Id Not Found |
RMA Eligibility and RMA Lookup |
False | RMA 1008 | Current Order Status is not valid for Returns |
RMA Eligibility and RMA Lookup |
False | RMA 1004 | Internal Server Error |
RMA Lookup | False | RMA 1005 | Matching Item Not Found |
RMA Lookup | False | RMA 1007 | Requested return quantity allowed limit |
RMA Lookup | False | RMA 1004 | Internal Server Error |
RMA Lookup | False | RMA 1004 | Internal Server Error |
RMA Lookup | False | RMA 1004 | Internal Server Error |
RMA Lookup | False | RMA 1004 | Internal Server Error |
RMA Lookup | False | RMA 1004 | Internal Server Error |
RMA Lookup | False | RMA 1009 | RMA Id not found while lookup |
RMA Lookup | False | RMA 1018 | Invoice amount less than allowed amount |
RMA Lookup | False | RMA 1010 | Invoice amount more than allowed amount |
RMA Lookup | False | RMA 1011 | Weight can't be 0 or less than 0 |
RMA Lookup | False | RMA 1012 | Weight exceeds limitations |
RMA Lookup | False | RMA 1013 | Dimensions of the package exceeds limitations |
RMA Lookup | False | RMA 1014 | Dimensional Weight of the package exceeds limitations |
RMA Lookup | False | RMA 1015 | Not a valid county for Returns |
RMA Lookup | False | RMA 1016 | Hazmat Item(s) not allowed for returns |
RMA Lookup | False | RMA 1017 | Customer State excluded for returns |
RMA Eligibility | False | RMA 1019 | Item excluded for returns |
RMA Eligibility | False | RMA 1020 | Item department excluded from returns |
RMA Lookup | False | RMA 1021 | Order Id could not be found during lookup |