Generate Return Merchandise Authorization
This API produces a Return Merchandise Authorization (RMA) for the specified order.
| Action | URI Template | Transaction Type |
|---|---|---|
| POST | /return-order-create/sellers/{sellerId}/orders/{orderId}returns/generateRMA | Generates a Return Merchandise Authorization (RMA). |
Request Examples
Copy this code sample.
No RCR
{
"orderId": "2000009318",
"orderType": "OMS",
"store": "TMSUS",
"storeType": "Store",
"transactionId": "TransactionId-2000009318",
"sourceName": "ROMUI",
"sourceLocationId": "100801",
"requestTime": "2020-05-07T14:54:15+00:00",
"returnItemsReceived": true,
"returnType": "InStore",
"items": [
{
"lineNumber": "1",
"itemId": "21-RITOCS004b",
"returnQuantity": 1,
"returnReason": {
"code": "CDE",
"category": "CDE",
"description": "Cancelled Data Entry Error"
}
}
],
"representativeInfo": {
"id": "BURNSM@HIBNA",
"name": "MCKENZIE"
},
"comments": "Item not what i Ordered!!"
}
Copy this code sample.
With RCR
{
"orderId": "2000009318",
"orderType": "OMS",
"store": "TMSUS",
"storeType": "Store",
"transactionId": "TransactionId-2000009318",
"sourceName": "ROMUI",
"sourceLocationId": "100801",
"requestTime": "2020-05-07T14:54:15+00:00",
"returnItemsReceived": false,
"returnType": "InStore",
"items": [
{
"lineNumber": "1",
"itemId": "21-RITOCS004b",
"returnQuantity": 1,
"returnReason": {
"code": "CDE",
"category": "CDE",
"description": "Cancelled Data Entry Error"
}
}
],
"representativeInfo": {
"id": "BURNSM@HIBNA",
"name": "MCKENZIE"
},
"comments": "Item not what i Ordered!!"
}Example Responses
Copy this code sample.
No RCR
{
"orderId": "2000009318",
"orderType": "OMS",
"store": "TMSUS",
"storeType": "Store",
"expiryDate": "2020-08-04T14:06:11.297",
"items": {
"item": [
{
"lineNumber": "1",
"itemId": "21-RITOCS004b",
"returnQuantity": 1
}
]
},
"returnLocation": {
"whsName": "100801",
"whsStreet": "äÄéçï街名_®©street_name & \"Katanè\" <'Test'>Q & Rnullnull",
"whsCity": "DEVON",
"whsState": "PA",
"whsPostalCode": "19333",
"whsCountryCode": "US"
},
"rmaid": "200000931820200512233246696"
}
Copy this code sample.
With RCR
{
"store": "TMSUS",
"storeType": "Store",
"returnLocation": {
"id": "100801",
"address": {
"addressLine": [
"äÄéçï街名_®©street_name & \"Katanè\" <'Test'>",
"Q & R"
],
"city": "DEVON",
"state": "PA",
"zipCode": "19333",
"country": "US",
"dayPhone": "6105551212"
}
},
"billToAddress": {
"firstName": "Annetta",
"lastName": "Norris",
"addressLine": [
"4113 Morris Street"
],
"city": "Saginaw",
"state": "MI",
"zipCode": "48601",
"country": "US",
"dayPhone": "(989) 274-2233"
},
"webOrderNumber": "0002651087119054",
"documentNumber": "2000009450",
"totalRefundAmount": "27.64",
"totalChargesAmount": "0.00",
"totalDiscountAmount": "0.00",
"totalTaxAmount": "5.55",
"customAttributes": {
"attribute": [
{
"name": "sourceSystem"
},
{
"name": "transactionId",
"value": "TransactionId-2000009318"
},
{
"name": "createUserId",
"value": "BURNSM@HIBNA"
}
]
},
"orderAlreadyTaxed": "Y",
"orderLines": {
"orderLine": [
{
"lineNumber": "1",
"orderedQuantity": 1,
"returnedQuantity": 1,
"itemId": "21-RITOCS004b",
"itemColor": {},
"itemSize": {},
"itemDescription": "Sourcing rule testing",
"grossAmount": "27.64",
"discountAmount": "0.00",
"taxAmount": "5.55",
"refundAmount": "27.64",
"lineCharges": {
"lineCharge": [
{
"chargeName": "Price",
"chargeAmount": "19.22",
"linePrice": "",
"unitPrice": ""
},
{
"chargeName": "Shipping",
"chargeAmount": "2.87",
"linePrice": "",
"unitPrice": ""
}
]
},
"lineTaxes": {
"lineTax": []
},
"customAttributes": {
"attribute": [
{
"name": "originalLineNo",
"value": "1"
},
{
"name": "originalSubLineNo",
"value": "1"
}
]
}
}
]
},
"rmaid": "200000931820200512234132354"
}