Edit RMA

Edit existing RMA.

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

  • Available version number: 307

Neweggbusiness.com and Newegg.ca

  • Available version number: 305

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: EditRMARequest
RMANumber Yes Integer Newegg’s assigned number for RMA for order
RMAType Yes Integer Available values:

1: Replacement
2: Refund
SellerRMANumber No String Seller’s user defined RMA number

  • An alphanumeric string, max 50 characters
  • Newegg.com use version number: 307
  • Neweggbusiness.com and Newegg.ca use version number: 305
RMANote Yes String Comment for this RMA, max 4000 characters.
SellerPartNumber Yes String The item’s seller part number. It will be used to identify the item.
ReturnQuantity Yes Integer The return quantity of each item in RMA.
ReturnUnitPrice Yes, if RMAtype =Refund Decimal The return unit price of each item in refund RMA. How much refund will be issued per unit of this item.

  • Newegg.com and Newggbusiness.com, all amounts are set in U.S. Dollars (USD)
  • Newegg.ca, all amounts are set in Can Dollars (CAD)
  • ReturnUnitPrice Exceptional Scenario1. Restocking fees will be waived if global orders meet following criteria.
    1.1 Item Condition is Used (Used_LikeNew, Used_VeryGood, Used_Good, Used_Acceptable)
    1.2 RMAReason = 1,2,5,7,9,10
    1.3 RMAReason = 3,4,6,8, Uopen = 1 and weight of individual item is less 50 lbs
    2. For non-Global order, RMA Type = 2, full refund.
RefundShippingPrice Yes if RMAtype =Refund Decimal The shipping amount of refund of each item in this RMA.

  • Newegg.com and Newggbusiness.com, all amounts are set in U.S. Dollars (USD)
  • Newegg.ca, all amounts are set in Can Dollars (CAD)
  • RefundShippingPrice Exceptional Scenario
  1. For any RMAReason = 1,2,5,7,9,10, respective shipping fee of returned product will be refunded.
  2. For NISP Order and RMAReason = 3,4,6,8, shipping fee will not be refunded.

For rest scenario, user can edit refunded shipping amount but cannot exceed total shipping fee of the order.
RMAReason Yes Integer The replacement/refund reason of each item in this RMA.

Available values:

1: Item damage
2: Item is defective of is not working
3: Incompatible
4: No longer needed

5: Inaccurate item description on website

6: Ordered wrong item
7: Sent wrong item
8: Product dissatisfaction

9: Extra Item Shipped (new item)

10. Item not received (new item)
UnOpen Yes when RMAReason =  3, 4, 6, 8 String The tracking number of shipment(s).

The parameter is only effective for USA , CAN
FileUrls Yes when RMAReason =  3, 4, 6, 8 String Attach files of RMA items.

Allowed file formats: *.JPG, *.JPEG, *.PNG, *.GIF, *.BMP, *.TIFF

Maximum size for each image is 5MB.

Maximum of 5 images is allowed.

The parameter is only effective for USA , CAN
Memo Yes when RMAReason =  3, 4, 6, 8 String Memo of your RMA.

Max 1,000 characters.

The parameter is only effective for USA , CAN

Schema: UpdateRMARequest.xsd AND _RMAEdit.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>EditRMARequest</OperationType>
    <RequestBody>
        <EditRMAInfo>
            <RMANumber>38875640</RMANumber>
            <RMAType>2</RMAType>
            <SellerRMANumberE12345678
            </SellerRMANumber>
            <RMANote>your note here</RMANote>
            <RMATransactionList>
                <RMATransaction>
                    <SellerPartNumber>Ben_item_12</SellerPartNumber>
                    <ReturnQuantity>1</ReturnQuantity>
                    <ReturnUnitPrice>200</ReturnUnitPrice>
                    <RefundShippingPrice>10</RefundShippingPrice>
                    <RMAReason>5</RMAReason>
                                   <UnOpen>1</UnOpen>
                                   <Memo>No CPU pin damage.</Memo>
                                   <FileUrls>
                                       <ImgUrl>https://10.1.24.143:4567/images/CPU1.jpg</ImgUrl>
                                       <ImgUrl>https://10.1.24.143:4567/images/CPU2.jpg</ImgUrl>
                                   </FileUrls>
                </RMATransaction>
            </RMATransactionList>
        </EditRMAInfo>
    </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": "EditRMARequest",
    "RequestBody": {
        "EditRMAInfo": {
            "RMANumber": "38875640",
            "RMAType": "2",
            "SellerRMANumber": "E12345678",
            "RMANote": "your note here",
            "RMATransactionList": {
                "RMATransaction": {
                    "SellerPartNumber": "Ben_item_12",
                    "ReturnQuantity": "1",
                    "ReturnUnitPrice": "200",
                    "RefundShippingPrice": "10",
                    "RMAReason": "5"
                         "UnOpen": "1",
                           “FileUrls": {
                             "ImgUrl": [
                                 "https://www.jst.org/articleimages/original/9c2c7a32bcfce285192e71e073f3f883.jpg"
                               ]
                              },
                              "Memo": "test 123 1"
                }
            }
        }
    }
}

Response Body

Attribute Format Description
IsSuccess String Get feed status operation:

True: Successful
False: Not successful
OperationType String Fixed value: EditRMAResponse
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
2:Refund
RMATypeDescription String Available values:

Replacement:RMAType value 1
Refund:RMAType value 2
SourceSONumber Integer The order number of the requested RMA.
SellerRMANumber String Seller’s user defined RMA number

  • An alphanumeric string, max 50 characters
  • Newegg.com, if seller defined, only available for version: 307
  • Neweggbusiness.com and Newegg.ca, if seller defined, only available for version: 305
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)
2: Standard Shipping(5-7 business days)
3: Expedited Shipping(3-5 business days)
4: Two-Day Shipping(2 business days)
5: One-Day Shipping(Next day)
6: International Economy Shipping(8-15 business days)
7: International Standard Shipping(5-7 business days)
8: International Expedited Shipping(3-5 business days)
9: International Two-Day Shipping(2 business days)
10: APO/FPO – Military ONLY
11: Newegg Premier 3 Days
12: Newegg Premier 2 Days
13: Newegg Premier Next Day

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
Standard Shipping(5-7 business days): If RMAShipMethod value = 2
Expedited Shipping(3-5 business days): If RMAShipMethod value = 3
Two-Day Shipping(2 business days): If RMAShipMethod value = 4
One-Day Shipping(Next day): If RMAShipMethod value = 5
International Economy Shipping(8-15 business days): If RMAShipMethod value = 6
International Standard Shipping(5-7 business days): If RMAShipMethod value = 7
International Expedited Shipping (3-5 business days): If RMAShipMethod value = 8
International Two-Day Shipping(2 business days): If RMAShipMethod value = 9
APO/FPO – Military: If RMAShipMethod value = 10
Newegg Premier 3 Days: If RMAShipMethod value = 11
Newegg Premier 2 Days: If RMAShipMethod value = 12
Newegg Premier Next Day: If RMAShipMethod value = 13

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:

  • The return unit price of each item in refund RMA. How much refund will be issued per unit of this item
  • Newegg.com and Newggbusiness.com, all amounts are set in U.S. Dollars (USD)
  • Newegg.ca, all amounts are set in Can Dollars (CAD)

If RMA type = replacement, this element will be blank
RefundShippingPrice Decimal If RMA type = Refund:

  • The shipping amount of refund of each item in this RMA
  • Newegg.com and Newggbusiness.com, all amounts are set in U.S. Dollars (USD)
  • Newegg.ca, all amounts are set in Can Dollars (CAD)

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
2: Defective
3: Incompatible
4: No longer needed
5: Not match what we show
6: Ordered wrong item
7: Sent wrong item
8: Unsatisfied
9: Other Reason {0}
RMAReasonDescription String The replacement/refund reason of each item’s in RMA

Available values:

Carrier damage: If RMAReason value = 1
Defective: If RMAReason value = 2
Incompatible: If RMAReason value = 3
No longer needed: If RMAReason value = 4
Not match what we show: If RMAReason value = 5
Ordered wrong item: If RMAReason value = 6
Sent wrong item: If RMAReason value = 7
Unsatisfied: If RMAReason value = 8
Other Reason {0}: If RMAReason value = 9

Schema: UpdateRMAResponse.xsd

Example: XML, Response

<?xml version=”1.0” encoding=”utf-8”?>
<NeweggAPIResponse>
    <IsSuccess>true</IsSuccess>
    <OperationType>EditRMAResponse</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": "EditRMAResponse",
    "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
SE001 Invalid SellerPartNumber.
SE004 Cannot issue RMA because the order has not been invoiced.
SE005 ShipMethodCode is required when RMAType is replacement.
SE006 RMATransaction is required in RMATransactionList.
SE009 [Seller Part #] Return Qty has to be equal to or less than Max Return Qty – Prior Returned Qty, currently the
available return qty = {0}.
SE010 Refund per Qty must be greater than zero.
SE011 {Seller Part #} refund price per Qty cannot be greater than item unit price, which = {0.00}.
SE012 Order Shipping Refund cannot be greater than Order Shipping Charge, which = {0.00}.
SE013 Replacement RMA Order Qty cannot be greater than item available inventory.
SE014 Item(s) has two fulfillment channels. Please use DiffShippedByPartyAction field to resolve this issue.
SE017 RMANumber is required.
SE020 The following item(s) must return with the current item(s) since they are in a same Combo or Auto Add to Cart
promotion :{ Seller Part # List}.
SE021 The following item(s) must return with the current item(s) since they are in a same Combo or Auto Add to Cart
promotion :{ Seller Part # List}.
SE023 Total refund amount cannot exceed total order amount, which = {0.00}.
SE024 Item does not exist.
SE028 Can’t update because RMA was not open.
SE029 Can’t update because RMA type = advanced. Please contact Newegg Marketplace Support.
SE034 Refund cannot exceed order total minus previous refunded amount[{0}].
SE035 This seller account currently does not support the selected shipping method {0}. Please setup this shipping setting in Seller Portal or select another shipping method.
SE038 International seller covered by Newegg Buy-out policy cannot request return or refund directly. Please contact MarketplaceSupport@newegg.com for assistance.
SE040 This seller RMA number must be a text of number and/or letters.

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