Submit RMA

Issue a Refund or Replacement RMA for an invoiced order.

Resource URL

Newegg.com: https://api.newegg.com/marketplace/servicemgmt/rma/newrma?sellerid={sellerid}&version={version}
Neweggbusiness.com: https://api.newegg.com/marketplace/b2b/servicemgmt/rma/newrma?sellerid={sellerid}&version={version}
Newegg.ca: https://api.newegg.com/marketplace/can/servicemgmt/rma/newrma?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 100 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: IssueRMARequest
RMAType Yes Integer Available values:

1: Replacement
2: Refund

For Courtesy Refund, please refer to Issue Courtesy Refund.

SourceSONumber Yes Integer The order number which the RMA is issued for.
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
DiffShippedByPartyAction Yes if:

  • RMA type =
    Replacement
  • The original order
    has items currently fulfilled by SBS and SBN
Integer The RMA replacement Order you are submitting currently has items SBS (Shipped by Seller) and SBN (Shipped by Newegg). In order to process the RMA replacement request, please choose one of the following actions:

1: Convert to Refund with Restocking Fee
2: Convert to Refund without Restocking Fee
3: Split into Two RMAs

AutoReceiveMark No Integer This mark is used to:

  • Receive the RMA automatically once the RMA has been created successfully. Seller
    would not need to “receive” RMA as a separate action to proceed with refund.
    Otherwise, seller will need to “receive”RMA after RMA created to proceed with
    refund.
  • Auto match with existing open RMA’s for the same order.

Available values:

0: Don’t receive the RMA automatically (default). Do not proceed with refund until RMA
is marked as received.
1: Receive the RMA automatically after RMA creation and proceed with refund.

  • Restriction: Currently this mark only applies to the order shipped by seller and is only available for RMA type = refund.
  • If the RMA didn’t create successfully, the RMA will not be automatically received, even if you specified the mark as 1.

Note: if you are not sure how to use this, please consult with datafeeds@newegg.com.

RMANote No 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)
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)
RMAReason Yes Integer The replacement/refund reason of each item in this 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

Schema: SubmitRMARequest.xsd

Example: XML, Request

POST https://api.newegg.com/marketplace/servicemgmt/rma/newrma?sellerid={sellerid}&version={version}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml

<NeweggAPIRequest>
    <OperationType>IssueRMARequest</OperationType>
    <RequestBody>
        <IssueRMA>
            <RMAType>2</RMAType>
            <SourceSONumber>123456789</SourceSONumber>
            <SellerRMANumber>E12345678</SellerRMANumber>
            <AutoReceiveMark>1</AutoReceiveMark>
            <RMANote>This is a test RMA</RMANote>
            <RMATransactionList>
                <RMATransaction>
                    <SellerPartNumber>test001</SellerPartNumber>
                    <ReturnQuantity>1</ReturnQuantity>
                    <ReturnUnitPrice>1.00</ReturnUnitPrice>
                    <RefundShippingPrice>1.00</RefundShippingPrice>
                    <RMAReason>2</RMAReason>
                </RMATransaction>
            </RMATransactionList>
        </IssueRMA>
    </RequestBody>
</NeweggAPIRequest>

Example: Json, Request

POST https://api.newegg.com/marketplace/servicemgmt/rma/newrma?sellerid={sellerid}&version={version}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json

{
    "OperationType": "IssueRMARequest",
    "RequestBody": {
        "IssueRMA": {
            "RMAType": "2",
            "SourceSONumber": "123456789",
            "SellerRMANumber": "E12345678",
            "AutoReceiveMark": "1",
            "RMANote": "This is a test RMA",
            "RMATransactionList": {
                "RMATransaction": {
                    "SellerPartNumber": "test001",
                    "ReturnQuantity": "1",
                    "ReturnUnitPrice": "1.00",
                    "RefundShippingPrice": "1.00",
                    "RMAReason": "2"
                }
            }
        }
    }
}

Response Body

Attribute Format Description
IsSuccess String Get feed status operation:

True: Successful
False: Not successful

OperationType String Fixed value: IssueRMAResponse
SellerID String Your seller ID
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

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.

OrderNumber Integer Order Number of the RMA requested order
OrderDate String Order Date (Pacific Standard Time)
InvoiceNumber Integer Invoice Number of the order RMA requested order
OrderAmount Decimal Order Amount

  • Newegg.com and Newggbusiness.com, all amounts are set in U.S. Dollars (USD)
  • Newegg.ca, all amounts are set in Can Dollars (CAD)
AvailableRefundAmount Decimal Available Refund Amount

  • Newegg.com and Newggbusiness.com, all amounts are set in U.S. Dollars (USD)
  • Newegg.ca, all amounts are set in Can Dollars (CAD)
RMAProcessedBy String Available values: “Newegg” or “Seller”
RMAReceiveDate String RMA shipment received date (Pacific Standard Time)
RMANote String Comment in this RMA if any noted
PriorRefundAmount Decimal Previous Refund Amount if any

  • Newegg.com and Newggbusiness.com, all amounts are set in U.S. Dollars (USD)
  • Newegg.ca, all amounts are set in Can Dollars (CAD)
CustomerName String Customer Name
CustomerPhoneNumber String Customer Phone Number
CustomerEmailAddress String Newegg’s masked customer email address, you can reach to the customer through this email address.

For example: gdv6l0viwo4l7j1d@marketplace.newegg.com

ShipToAddress1 String The order’s ship to address 1
ShipToAddress2 String The order’s ship to address 2
ShipToCityName String The order’s ship to city name
ShipToStateCode String The order’s ship to state code
ShipToZipCode String The order’s ship to zip code
ShipToCountryCode String The order’s ship to country code
ShipToLastName String The order’s ship to last name
ShipToFirstName String The order’s ship to first name
ShipToCompany String The order’s ship to company
SellerPartNumber String The seller part number to identify seller’s item
MfrPartNumber String Manufacturer Part Number assigned to item
NeweggItemNumber String Newegg’s assigned number to item
Description String The item’s website short title
UnitPrice Decimal The item’s selling price

  • Newegg.com and Newggbusiness.com, all amounts are set in U.S. Dollars (USD)
  • Newegg.ca, all amounts are set in Can Dollars (CAD)
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

ShippedBy Integer If RMA type = Replacement, available values to indicate who will ship replacement:

0: SBS (Shipped by Seller)
1: SBN (Shipped by Newegg)

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

Memo String Additional notes
ResponseDate String Response date (Pacific Standard Time)

Schema: SubmitRMAResponse.xsd

Example: XML, Response

<?xml version="1.0" encoding="utf-8"?>
<NeweggAPIResponse>
    <IsSuccess>true</IsSuccess>
    <OperationType>IssueRMAResponse</OperationType>
    <SellerID>A006</SellerID>
    <ResponseDate>2012-02-22 20:59:50</ResponseDate>
    <Memo />
    <ResponseBody>
        <RMAInfo>
            <RMANumber>20103389</RMANumber>
            <RMAType>2</RMAType>
            <RMATypeDescription>Refund</RMATypeDescription>
            <IssueUser>A004</IssueUser>
            <RMADate>2012-02-22</RMADate>
            <RMAStatus>6</RMAStatus>
            <RMAStatusDescription>Processing</RMAStatusDescription>
            <RMAShipMethod />
            <RMAShipMethodDescription />
            <OrderNumber>41473422</OrderNumber>
            <OrderDate>2012-01-11</OrderDate>
            <InvoiceNumber>82868509</InvoiceNumber>
            <OrderAmount>15.00</OrderAmount>
            <AvailableRefundAmount>12000</AvailableRefundAmount>
            <RMAProcessedBy>newegg</RMAProcessedBy>
            <RMAReceiveDate />
            <RMANote>This is a test RMA</RMANote>
            <PriorRefundAmount>2.00</PriorRefundAmount>
            <CustomerName>abc Roosevelt</CustomerName>
            <CustomerPhoneNumber>626-271-9700</CustomerPhoneNumber>
            <CustomerEmailAddress>gdv6l0viwo4l7j1d@marketplace.newegg.com</CustomerEmailAddress>
            <ShipToAddress1>1941 E. Cedar Loop Drive</ShipToAddress1>
            <ShipToAddress2>9A</ShipToAddress2>
            <ShipToCityName>South Weber</ShipToCityName>
            <ShipToStateCode>UT</ShipToStateCode>
            <ShipToZipCode>884405</ShipToZipCode>
            <ShipToLastName>Roosevelt</ShipToLastName>
            <ShipToFirstName>abc</ShipToFirstName>
            <ShipToCompany />
            <RMATransactionList>
                <RMATransaction>
                    <SellerPartNumber>201112310900</SellerPartNumber>
                    <MfrPartNumber>201112310900</MfrPartNumber>
                    <NeweggItemNumber>9SIA0040286987</NeweggItemNumber>
                    <Description>ICYTEST201112310900</Description>
                    <UnitPrice>600.00</UnitPrice>
                    <ReturnQuantity>1</ReturnQuantity>
                    <ReturnUnitPrice>1.00</ReturnUnitPrice>
                    <RefundShippingPrice>1.00</RefundShippingPrice>
                    <RMAReason>2</RMAReason>
                    <RMAReasonDescription>Defective</RMAReasonDescription>
                </RMATransaction>
            </RMATransactionList>
        </RMAInfo>
    </ResponseBody>
</NeweggAPIResponse>

Example: Json, Response

{
    "IsSuccess": "true",
    "OperationType": "IssueRMAResponse",
    "SellerID": "A006",
    "ResponseDate": "2012-02-22 20:59:50",
    "ResponseBody": {
        "RMAInfo": {
            "RMANumber": "20103389",
            "RMAType": "2",
            "RMATypeDescription": "Refund",
            "IssueUser": "A004",
            "RMADate": "2012-02-22",
            "RMAStatus": "6",
            "RMAStatusDescription": "Processing",
            "OrderNumber": "41473422",
            "OrderDate": "2012-01-11",
            "InvoiceNumber": "82868509",
            "OrderAmount": "15.00",
            "AvailableRefundAmount": "12000",
            "RMANote": "This is a test RMA",
            "PriorRefundAmount": "2.00",
            "CustomerName": "abc Roosevelt",
            "CustomerPhoneNumber": "626-271-9700",
            "CustomerEmailAddress": "gdv6l0viwo4l7j1d@marketplace.newegg.com",
            "ShipToAddress1": "1941 E. Cedar Loop Drive",
            "ShipToAddress2": "9A",
            "ShipToCityName": "South Weber",
            "ShipToStateCode": "UT",
            "ShipToZipCode": "884405",
            "ShipToLastName": "Roosevelt",
            "ShipToFirstName": "abc",
            "RMATransactionList": {
                "RMATransaction": {
                    "SellerPartNumber": "201112310900",
                    "MfrPartNumber": "201112310900",
                    "NeweggItemNumber": "9SIA0040286987",
                    "Description": "ICYTEST201112310900",
                    "UnitPrice": "600.00",
                    "ReturnQuantity": "1",
                    "ReturnUnitPrice": "1.00",
                    "RefundShippingPrice": "1.00",
                    "RMAReason": "2",
                    "RMAReasonDescription": "Defective"
                }
            }
        }
    }
}

Request Failure Errors

For common HTTP error responses, please refer to Failed Response Error Code List.

Error Code Description
SE001 Invalid SellerPartNumber.
SE003 OrderNumber is required.
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.
SE007 ReasonCode is required.
SE008 Return Qty must be greater than zero.
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.
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.
SE025 Cannot issue RMA because the order type is invalid.
SE026 Cannot issue RMA because the order is a replacement order.
SE027 Cannot issue RMA because the order has been voided.
SE031 Auto Receive is not available for order returns processed by Newegg.
SE032 Cannot issue RMA as Auto Receive because the RMA type is not refund.
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.
SE036 The item:{seller part #} unit product refund cannot be less than {minimum refund amount} per account
restocking fee setting: {seller restocking fee rate}.
SE038 International seller covered by Newegg Buy-out policy cannot request return or refund directly. Please contact MarketplaceSupport@newegg.com for assistance.
SE039 This item is not eligible for {refund |replacement}.
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