Process RMA
After submitting your return or replacement request to finalize the RMA submit this request. Please note, process this request if the item(s) have been returned back to the seller.
Resource URL
Newegg.com: https://api.newegg.com/marketplace/servicemgmt/rma/updaterma?sellerid={sellerid}&version={version} Neweggbusiness.com: https://api.newegg.com/marketplace/b2b/servicemgmt/rma/updaterma?sellerid={sellerid}&version={version} Newegg.ca: https://api.newegg.com/marketplace/can/servicemgmt/rma/updaterma?sellerid={sellerid}&version={version}
Note: Please make sure your request URL is all in lower case (except for Seller ID) and cannot contain any blank spaces or line breaks.
Parameters
Name | Required? | Description |
sellerid | Yes | Your seller ID on Newegg Marketplace |
version | Yes | Newegg.com
Neweggbusiness.com and Newegg.ca
|
Resource Information
HTTP Method | Authentication? | Request Formats | Response Formats | Rate Limited? |
POST | Required | XML, Json | XML, Json | 1000 request per hour |
Request Body
Attribute | Required? | Format | Description |
IssueUser | No | String | The RMA issuer’s registered Seller Portal email address. System will only accept Seller’s registered Seller Portal email addresses. If left blank, default value will be Seller ID. |
OperationType | Yes | String | Fixed value: ReceiveRMARequest |
RMANumber | Yes | Integer | Newegg’s assigned number for RMA for order |
Schema: UpdateRMARequest.xsd AND _RMAReceive.xsd
Example: XML, Request
POST https://api.newegg.com/marketplace/servicemgmt/rma/updaterma?sellerid={sellerid}&version={version} Authorization: 720ddc067f4d115bd544aff46bc75634 SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D Content-Type: application/xml Accept: application/xml <NeweggAPIRequest> <OperationType>ReceiveRMARequest</OperationType> <RequestBody> <ReceiveRMAInfo> <RMANumber>38873480</RMANumber> </ReceiveRMAInfo> </RequestBody> </NeweggAPIRequest>
Example: Json, Request
POST https://api.newegg.com/marketplace/servicemgmt/rma/updaterma?sellerid={sellerid}&version={version} Authorization: 720ddc067f4d115bd544aff46bc75634 SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D Content-Type: application/json Accept: application/json { "OperationType": "ReceiveRMARequest", "RequestBody": { "ReceiveRMAInfo": { "RMANumber": "38873480" } } }
Response Body
Attribute | Format | Description |
IsSuccess | String | Get feed status operation:
True: Successful |
OperationType | String | Fixed value: ReceiveRMAResponse |
SellerID | String | Your seller ID |
Memo | String | Additional notes |
ResponseDate | String | Response date (Pacific Standard Time) |
RMANumber | Integer | Newgg’s assigned number for RMA |
RMAType | Integer | Available values:
1:Replacement |
RMATypeDescription | String | Available values:
Replacement:RMAType value 1 |
SourceSONumber | Integer | The order number of the requested RMA. |
SellerRMANumber | String | Seller’s user defined RMA number
|
IssueUser | String | RMA Issue User or Seller ID (if RMA Issue User was not specified when RMA was created) |
RMADate | String | Date of RMA (Pacific Standard Time) |
RMAStatus | Integer | Available value:
6:Processing |
RMAStatusDescription | String | Available value: Processing (default) |
RMAShipMethod | Integer | The ship method if the RMA type = Replacement:
1: Super Saver(7-14 business days) If RMA type = Refund, this element will be blank Note: Newegg will apply the same ship method used in original order. |
RMAShipMethodDescription | String | The ship method if the RMA type = Replacement:
Super Saver(7-14 business days): If RMAShipMethod value = 1 If RMA type = Refund, this element will be blank. Note: Newegg will apply the same ship method used in original order. |
RMANote | String | Comment in this RMA if any noted |
SellerPartNumber | String | The seller part number to identify seller’s item |
ReturnQuantity | Integer | The return quantity of each item in RMA |
ReturnUnitPrice | Decimal | If RMA type = Refund:
If RMA type = replacement, this element will be blank |
RefundShippingPrice | Decimal | If RMA type = Refund:
If RMA type = replacement, this element will be blank |
RMAReason | Integer | The replacement/refund reason of each item’s in RMA
Available values: 1: Carrier damage |
RMAReasonDescription | String | The replacement/refund reason of each item’s in RMA
Available values: Carrier damage: If RMAReason value = 1 |
Schema: UpdateRMAResponse.xsd
Example: XML, Response
<?xml version=”1.0” encoding=”utf-8”?> <NeweggAPIResponse> <IsSuccess>true</IsSuccess> <OperationType>ReceiveRMAResponse</OperationType> <SellerID>A006</SellerID> <Memo /> <ResponseDate>2011-09-28 09:02:00</ResponseDate> <ResponseBody> <RMAInfo> <RMANumber>38875640</RMANumber> <RMAType>2</RMAType> <RMATypeDescription>Refund</RMATypeDescription> <SourceSONumber>88219202</SourceSONumber> <SellerRMANumber>E12345678</SellerRMANumber> <RMAShipMethod /> <RMAShipMethodDescription /> <RMANote>your note here</RMANote> <IssueUser>test@newegg.com</IssueUser> <RMATransactionList> <RMATransaction> <SellerPartNumber>Ben_item_12</SellerPartNumber> <ReturnQuantity>1</ReturnQuantity> <ReturnUnitPrice>200.00</ReturnUnitPrice> <RefundShippingPrice>10.00</RefundShippingPrice> <RMAReason>1</RMAReason> <RMAReasonDescription>Carrier damage</RMAReasonDescription> </RMATransaction> </RMATransactionList> </RMAInfo> </ResponseBody> </NeweggAPIResponse>
Example: Json, Reponse
{ "IsSuccess": "true", "OperationType": "ReceiveRMAResponse", "SellerID": "A006", "ResponseDate": "2011-09-28 09:02:00", "ResponseBody": { "RMAInfo": { "RMANumber": "38875640", "RMAType": "2", "RMATypeDescription": "Refund", "SourceSONumber": "88219202", "SellerRMANumber": "E12345678", "RMANote": "your note here", "IssueUser": "test@newegg.com", "RMATransactionList": { "RMATransaction": { "SellerPartNumber": "Ben_item_12", "ReturnQuantity": "1", "ReturnUnitPrice": "200.00", "RefundShippingPrice": "10.00", "RMAReason": "1", "RMAReasonDescription": "Carrier damage" } } } } }
Request Failure Errors
For common HTTP error responses, please refer to Failed Response Error Code List.
Error Code | Description |
SE014 | Item(s) has two fulfillment channels. Please use DiffShippedByPartyAction field to resolve this issue. |
SE017 | RMANumber is required. |
SE028 | Can’t update because RMA was not open. |
SE029 | Can’t update because RMA type = advanced. Please contact Newegg Marketplace Support. |
SE030 | Can’t update because international seller processing by Newegg. |
Example: XML, Response
<?xml version="1.0" encoding="utf-8"?> <Errors> <Error> <Code>SE004</Code> <Message>Cannot issue RMA because the order has not been invoiced</Message> </Error> </Errors>
Example: Json, Response
[ { "Code": "SE004", "Message": "Cannot issue RMA because the order has not been invoiced" } ]
Last updated: October 15, 2018