This API returns RMA information for the specified order. It can also return package information, if the packageInfoRequired element is set to true.

Action URI Template Transaction Type
POST /return-order-create/sellers/{sellerId/orders/{orderId}returns/lookupRMA Returns RMA if found.

Example Requests

Copy this code sample.

No Package Info Required

{
  "orderId": "2000009318",
  "orderType": "OMS",
  "store": "TMSUS",
  "storeType": "Channel",
  "sourceName": "ROMUI",
  "sourceLocationId": "TMS_NA-DC001",
  "packageInfoRequired": false
}
Copy this code sample.

Package Info Required

{
  "orderId": "2000026296",
  "orderType": "OMS",
  "store": "TMSUS",
  "storeType": "Store",
  "sourceName": "ROMUI",
  "sourceLocationId": "TMS_NA-DC001",
  "rmaid": "200002629620200719182546298",
  "packageInfoRequired": true
}

Example Responses

Copy this code sample.

RMA Found

{
    "orderId": "2000009318",
    "orderType": "OMS",
    "store": "TMSUS",
    "storeType": "Channel",
    "rmadetails": [
        {
            "items": {
                "item": [
                    {
                        "lineNumber": "1",
                        "itemId": "21-RITOCS004b",
                        "returnQuantity": 1,
                        "returnReasonCode": {
                            "value": "01",
                            "category": "Customer did not want"
                        }
                    }
                ]
            },
            "returnLocation": {
                "whsName": "100801",
                "whsStreet": "äÄéçï街名_®©street_name & \"Katanè\" <'Test'>Q & Rnullnull",
                "whsCity": "DEVON",
                "whsState": "PA",
                "whsPostalCode": "19333",
                "whsCountryCode": "US"
            },
            "isRMAActive": false,
            "creationDate": "2019-12-18T04:00:00+0000",
            "rmaid": "200000931820200512161141396"
        },
        {
            "items": {
                "item": [
                    {
                        "lineNumber": "1",
                        "itemId": "21-RITOCS004b",
                        "returnQuantity": 1,
                        "returnReasonCode": {
                            "value": "01",
                            "category": "Customer did not want"
                        }
                    }
                ]
            },
            "returnLocation": {
                "whsName": "100801",
                "whsStreet": "äÄéçï街名_®©street_name & \"Katanè\" <'Test'>Q & Rnullnull",
                "whsCity": "DEVON",
                "whsState": "PA",
                "whsPostalCode": "19333",
                "whsCountryCode": "US"
            },
            "isRMAActive": true,
            "creationDate": "2019-12-18T04:00:00+0000",
            "expiryDate": "2020-08-04T02:06:11+0000",
            "rmaid": "200000931820200512161218716"
        },
        {
            "items": {
                "item": [
                    {
                        "lineNumber": "1",
                        "itemId": "21-RITOCS004b",
                        "returnQuantity": 1,
                        "returnReasonCode": {
                            "value": "01",
                            "category": "Customer did not want"
                        }
                    }
                ]
            },
            "returnLocation": {
                "whsName": "100801",
                "whsStreet": "äÄéçï街名_®©street_name & \"Katanè\" <'Test'>Q & Rnullnull",
                "whsCity": "DEVON",
                "whsState": "PA",
                "whsPostalCode": "19333",
                "whsCountryCode": "US"
            },
            "isRMAActive": true,
            "creationDate": "2019-12-18T04:00:00+0000",
            "expiryDate": "2020-08-04T02:06:11+0000",
            "rmaid": "200000931820200512180219294"
        }
    ]
}
Copy this code sample.

RMA Found - with Package Info

{
    "orderId": "2000026296",
    "orderType": "OMS",
    "store": "TMSUS",
    "storeType": "Store",
    "packages": {
        "package": [
            {
                "items": {
                    "item": [
                        {
                            "lineNumber": "1",
                            "itemId": "21-RITOCS001a",
                            "returnQuantity": 1,
                            "itemDetails": {
                                "height": 1.5001,
                                "width": 5.00001,
                                "dimensionUOM": "INCHES",
                                "weight": 3.11001,
                                "weightUOM": "POUNDS"
                            }
                        }
                    ]
                },
                "returnApproved": true,
                "returnWarehouseId": "TMSNA-DC445",
                "returnWareHouseInfo": {
                    "name": "Martinsville Sellable DC (DLX)",
                    "address": {
                        "addressLine": [],
                        "city": "Martinsville",
                        "stateProvinceCode": "VA",
                        "postalCode": "24112",
                        "countryCode": "US"
                    }
                },
                "customerInfo": {
                    "name": "IndianaJones",
                    "address": {
                        "addressLine": [],
                        "city": "King of Prussia",
                        "stateProvinceCode": "PA",
                        "postalCode": "19406-0001",
                        "countryCode": "US"
                    },
                    "emailAddress": "RIT_E2E_1_OCS@dashboard.gsi"
                },
                "invoiceAmount": 10.0
            }
        ]
    },
    "rmadetails": []
}
Copy this code sample.

No RMAs Found

{
    "orderId": {
        "value": "2429",
        "type": "OMS"
    },
    "store": {
        "value": "TMSUS",
        "type": "STORE"
    },
    "packages": null,
    "errorResponse": {
        "errorCode": null,
        "errorDescription": "No RMAs exist for Order"
    },
    "rmadetails": []
}