Get RMA Information

Get RMA information by specified query conditions.

Resource URL

Newegg.com: https://api.newegg.com/marketplace/servicemgmt/rma/rmainfo?sellerid={sellerid}&version={version}
Neweggbusiness.com: https://api.newegg.com/marketplace/b2b/servicemgmt/rma/rmainfo?sellerid={sellerid}&version={version}
Newegg.ca: https://api.newegg.com/marketplace/can/servicemgmt/rma/rmainfo?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, 309, 320

Neweggbusiness.com and Newegg.ca

  • Available version number: 305, 309, 320

Note:

  • 309 response includes:
    • Seller’s own RMA number for reference
    • Replacement order number for related RMA
  • 320 response includes:
    • Return shipping label related information

Resource Information

HTTP Method Authentication? Request Formats Response Formats Rate Limited?
PUT 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: GetRMAInfoRequest
PageSize No Integer How many records in a page

  • Max is 100 per page
  • If left blank, default is 1
PageIndex No Integer Current page index

  • Default is 1
  • If left blank, default is 100
KeywordsType No Integer Available values:

  • 1: RMANumber
  • 2: OrderNumber
  • 3: CustomerName
  • 4: SellerRMANumber

Note: For SellerRMANumber:

  • Newegg.com use version 307
  • Newggbusiness.com and Newegg.ca use version 305
KeywordsValue No String The keywords value of the specified type
Status No Integer  

Available
values:		 RMA Status Description Visible in
Seller Portal?
0: All (Default) All Accepted Any order status is shown All that state ‘Yes’
1: Open Open Return was opened by Customer, Seller or Internal users Yes  / “Open”
2: Received Received Received by Seller or Internal users No
3: Rejected Rejected Rejected by Customer or Internal users Yes / “Rejected”
4: Voided Voided Voided by Customer or Internal users Yes / “Canceled”
5: Closed Closed Closed in the system Yes / “Closed”
6: Processing Processing System Currently Processing Yes / “Processing”

 
RMADateFrom No String Search RMA by date range (Pacific Standard Time)

Please refer to the Acceptable Date Format
RMADateTo No String Search RMA by date range (Pacific Standard Time)

Please refer to the Acceptable Date Format
RMAType No Integer Available values:

  • 0: All (Default)
  • 1: Replacement
  • 2: Refund
ProcessedBy No Integer Available values:

  • 0: All (Default)
  • 1: Seller
  • 2: Newegg

Schema: RMAInfoRequest.xsd

Example: XML, Request

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

<NeweggAPIRequest>
    <OperationType>GetRMAInfoRequest</OperationType>
    <RequestBody>
        <PageInfo>
            <PageIndex>1</PageIndex>
            <PageSize>10</PageSize>
        </PageInfo>
        <KeywordsType>1</KeywordsType>
        <KeywordsValue>2135422</KeywordsValue>
        <Status>0</Status>
        <RMADateFrom>2012-01-11</RMADateFrom>
        <RMADateTo>2012-01-12</RMADateTo>
        <RMAType>0</RMAType>
        <ProcessedBy>0</ProcessedBy>
    </RequestBody>
</NeweggAPIRequest>

Example: Json, Request

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

{
    "OperationType": "GetRMAInfoRequest",
    "RequestBody": {
        "PageInfo": {
            "PageIndex": "1",
            "PageSize": "10"
        },
        "KeywordsType": "1",
        "KeywordsValue": "2135422",
        "Status": "0",
        "RMADateFrom": "2012-01-11",
        "RMADateTo": "2012-01-12",
        "RMAType": "0",
        "ProcessedBy": "0"
    }
}

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
TotalCount Integer How many record(s) in request
TotalPageCount Integer How many page(s) return
PageIndex Integer Current page index (Default is 1)
PageSize Integer How many record(s) in a page (Max 100 per page)
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, 309
  • Neweggbusiness.com and Newegg.ca, if seller defined, only available for version: 305, 309
ReplacementOrderNumber String The Order Number of the replacement order. After confirming the return item is received, Newegg will create a replacement order for you to process.

Note: Newegg.com, Neweggbusiness.com, Newegg.ca, available for RMA type: Replacement (RMAType value= 1) and the request version=309
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 values:

  • 1: Open
  • 2: Received
  • 3: Rejected
  • 4: Voided
  • 5: Closed
  • 6: Processing
RMAStatusDescription String Available values:

  • Open: If RMAStatus value = 1
  • Received: If RMAStatus value = 2
  • Rejected: If RMAStatus value = 3
  • Voided: If RMAStatus value = 4
  • Closed: If RMAStatus value = 5
  • Processing: If RMAStatus value = 6
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.
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.
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 The Available Refund Amount = Total Order amount – Refunded Total Amount (Including current 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)
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
TrackingNumber String Return shipping label related information.

  • Newegg.com, Neweggbusiness.com and Newegg.ca: available for version: 320
TrackingURL String
LabelEstimateCost Decimal
PaidBy String
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: Item damage
  • 2: Item is defective or 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: Other Reason {0}

 
UnOpen String Has the item been unboxed.
The parameter is only effective for USA , CAN
FileUrls String Attach files of RMA items.
The parameter is only effective for USA , CAN
Memo String Memo of your RMA.
The parameter is only effective for USA , CAN
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
ResponseDate String Response date (Pacific Standard Time)

Schema: RMAInfoResponse.xsd

Example: XML, Response

<?xml version="1.0" encoding="utf-8"?>
<NeweggAPIResponse>
    <IsSuccess>true</IsSuccess>
    <OperationType>GetRMAInfo</OperationType>
    <SellerID>A006</SellerID>
    <ResponseDate>05/16/2013 14:57:25</ResponseDate>
    <Memo></Memo>
    <ResponseBody>
        <PageInfo>
            <TotalCount>1</TotalCount>
            <TotalPageCount>1</TotalPageCount>
            <PageIndex>1</PageIndex>
            <PageSize>50</PageSize>
        </PageInfo>
        <RMAInfoList>
            <RMAInfo>
                <RMANumber>53424440</RMANumber>
                <RMAType>2</RMAType>
                <RMATypeDescription>Refund</RMATypeDescription>
                <SellerRMANumber>E12345678</SellerRMANumber>
                <IssueUser>A006</IssueUser>
                <RMADate>12/19/2012 00:06:30</RMADate>
                <RMAStatus>5</RMAStatus>
                <RMAStatusDescription>Closed</RMAStatusDescription>
                <RMAShipMethod></RMAShipMethod>
                <RMAShipMethodDescription></RMAShipMethodDescription>
                <OrderNumber>153985075</OrderNumber>
                <OrderDate>12/18/2012 23:00:09</OrderDate>
                <InvoiceNumber>95843690</InvoiceNumber>
                <OrderAmount>3.99</OrderAmount>
                <AvailableRefundAmount>0.00</AvailableRefundAmount>
                <RMAProcessedBy>Seller</RMAProcessedBy>
                <RMAReceiveDate>01/09/2013 18:40:28</RMAReceiveDate>
                <RMANote></RMANote>
                <PriorRefundAmount>0.00</PriorRefundAmount>
                <CustomerName>Fiona Test</CustomerName>
                <CustomerPhoneNumber>626-271-1420</CustomerPhoneNumber>
                <CustomerEmailAddress>cq2test@marketplace.newegg.com</CustomerEmailAddress>
                <ShipToAddress1>17708 Rowland St</ShipToAddress1>
                <ShipToAddress2></ShipToAddress2>
                <ShipToCityName>Rowland Heights</ShipToCityName>
                <ShipToStateCode>CA</ShipToStateCode>
                <ShipToZipCode>91748-1119</ShipToZipCode>
                <ShipToCountryCode>UNITED STATES</ShipToCountryCode>
                <ShipToLastName>Test</ShipToLastName>
                <ShipToFirstName>Fiona</ShipToFirstName>
                <ShipToCompany></ShipToCompany>
                <ReturnShippingLabel> 
                   <Label> 
                    <TrackingNumber>1ZA813779092080471</TrackingNumber> 
                    <TrackingURL>http://www.newegg.com/info/trackOrder.aspx?trackingnumber=1ZA813779092080471&Type=1</TrackingURL>
                    <LabelEstimateCost>6.19</LabelEstimateCost> 
                    <PaidBy>Seller</PaidBy> 
                    </Label> 
                </ReturnShippingLabel> 
                <RMATransactionList>
                    <RMATransaction>
                        <SellerPartNumber>nz-tst-123</SellerPartNumber>
                        <MfrPartNumber>nz-tst-123</MfrPartNumber>
                        <NeweggItemNumber>9SIA0060BB9157</NeweggItemNumber>
                        <Description>Test Flag</Description>
                        <UnitPrice>3.99</UnitPrice>
                        <ReturnQuantity>1</ReturnQuantity>
                        <ReturnUnitPrice>3.99</ReturnUnitPrice>
                        <RefundShippingPrice>0.00</RefundShippingPrice>
                        <ShippedBy></ShippedBy>
                        <RMAReason>4</RMAReason>
                        <RMAReasonDescription>No longer needed</RMAReasonDescription>
                    </RMATransaction>
                </RMATransactionList>
            </RMAInfo>
        </RMAInfoList>
    </ResponseBody>
</NeweggAPIResponse>

Example: Json, Response

{
  "NeweggAPIResponse": {
    "IsSuccess": "true",
    "OperationType": "GetRMAInfo",
    "SellerID": "A2GS",
    "ResponseBody": {
      "PageInfo": {
        "TotalCount": "1",
        "TotalPageCount": "1",
        "PageIndex": "1",
        "PageSize": "100"
      },
      "RMAInfoList": {
        "RMAInfo": {
          "RMANumber": "21964299",
          "RMAType": "2",
          "RMATypeDescription": "Refund",
          "SellerRMANumber": "TestRMAA2GS20200305101",
          "IssueUser": "A2GS",
          "RMADate": "03/03/2020 17:16:49",
          "RMAStatus": "1",
          "RMAStatusDescription": "Open",
          "OrderNumber": "458765952",
          "OrderDate": "01/22/2020 19:03:37",
          "InvoiceNumber": "175154088",
          "OrderAmount": "0.81",
          "AvailableRefundAmount": "0.26",
          "RMAProcessedBy": "Newegg",
          "RMANote": "Test--This is a test RMA TestRMAA2GS20200305101 1001",
          "PriorRefundAmount": "0.40",
          "CustomerName": "Michael Liang",
          "CustomerPhoneNumber": "435-432-1431",
          "CustomerEmailAddress": "cusatest@marketplace.newegg.com",
          "ShipToAddress1": "17709 Rowland St",
          "ShipToAddress2": "",
          "ShipToCityName": "Rowland Heights",
          "ShipToStateCode": "CA",
          "ShipToZipCode": "91748-1108",
          "ShipToCountryCode": "UNITED STATES",
          "ShipToLastName": "Liang",
          "ShipToFirstName": "Michael",
          "ShipToCompany": "",
          "ReturnShippingLabel": {
            "Label": {
              "TrackingNumber": "1ZA813779092080471",
              "TrackingURL": "http://www.newegg.com/info/trackOrder.aspx?trackingnumber=1ZA813779092080471&Type=1",
              "LabelEstimateCost": "6.19",
              "PaidBy": "Seller"
            }
          },
          "RMATransactionList": {
            "RMATransaction": {
              "SellerPartNumber": "Test_SP#AJST_201904090006",
              "MfrPartNumber": "Test_MP#201904090006",
              "NeweggItemNumber": "9SIA2GS9212178",
              "Description": "Test_Item Website Short Title 20190409_0006",
              "UnitPrice": "0.01",
              "ReturnQuantity": "1",
              "ReturnUnitPrice": "0.01",
              "RefundShippingPrice": "0.10",
              "RMAReason": "4",
              "RMAReasonDescription": "No longer needed"
            }
          }
        }
      }
    },
    "ResponseDate": "03/06/2020 16:22:42"
  }
}

Request Failure Errors

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

Example: XML, Response

<?xml version="1.0" encoding="utf-8"?>
<Errors>
    <Error>
        <Code>CE001</Code>
        <Message>SellerID cannot be null or empty</Message>
    </Error>
</Errors>

Example: Json, Response

[
    {
        "Code": "CE001",
        "Message": "SellerID cannot be null or empty"
    }
]

Last updated: October 15, 2018