Get RMA List Report

Get a list of returns, replacements, and refunds from seller’s account.

Resource URL

Newegg.com: https://api.newegg.com/marketplace/reportmgmt/report/result?sellerid={sellerid}&version={version}
Neweggbusiness.com: https://api.newegg.com/marketplace/b2b/reportmgmt/report/result?sellerid={sellerid}&version={version}
Newegg.ca: https://api.newegg.com/marketplace/can/reportmgmt/report/result?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 Available versions:

Version Available Platform Impact
305 Neweggbusiness.com, Newegg.ca Response includes the Seller Order Number assigned by seller when using for SBN to fulfill multi-channel orders.
306 Newegg.com Response includes the Seller Order Number assigned by seller when using for SBN to fulfill multi-channel orders.
307 Newegg.com Response includes SalesTax amount for U.S., VAT and Duty amount for Newegg Global.
309 All Response includes the replacement order #s for related RMAs.
320 All Response includes return shipping label related information.

Resource Information

HTTP Method Authentication? Request Formats Response Formats Rate Limited?
PUT Required XML, Json XML, Json 500 request per hour

Request Body

Attribute Required? Format Description
IssueUser No String 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 values: RMAListReportRequest
RequestID Yes String Newegg’s assigned ID for submitted request
PageIndex Yes Integer Current page index
PageSize Yes Integer Return records count in one page

Max is 100 per page

Schema: GetReportRequest.xsd

Example: XML, Request

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

<NeweggAPIRequest >
    <OperationType>RMAListReportRequest</OperationType>
    <RequestBody>
        <RequestID>2PQBYWH4V68ZP</RequestID>
        <PageInfo>
            <PageIndex>1</PageIndex>
            <PageSize>10</PageSize>
        </PageInfo>
    </RequestBody>
</NeweggAPIRequest>

Example: Json, Request

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

{
    "OperationType": "RMAListReportRequest",
    "RequestBody": {
        "RequestID": "2PQBYWH4V68ZP",
        "PageInfo": {
            "PageSize": "10",
            "PageIndex": "1"
        }
    }
}

Response Body

Attribute Format Description
IsSuccess String Get feed status operation:

True: Successful
False: Not successful

SellerID String Your seller ID
OperationType String Fixed value: GetRMAListInfoResponse
RequestID String Newegg’s assigned ID for submitted request
RequestDate String Your request date time (Pacific Standard Time)
TotalCount Integer Total number of records
TotalPageCount Integer Total page count
PageIndex Integer Current page index
PageSize Integer How many records in a page
SellerID String Your seller ID
RMANumber Integer Newgg’s assigned number for RMA
RMATypeDescription String Available values:

Replacement:RMAType value 1
Refund:RMAType value 2

RMAType Integer Available values:

1:Replacement
2:Refund

SellerRMANumber String Seller’s user defined RMA number

  • An alphanumeric string, max 50 characters
  • Available for version: 309
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

LastEditDate String Last edit date (Pacific Standard Time)
LastEditUser String Las edit user
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)
RMAProcessedBy String Available values: “Newegg” or “Seller”
CustomerName String Customer Name
CustomerPhoneNumber String Customer Phone Number
CustomerAddress String Customer Address
RMAReceiveDate String RMA shipment received date (Pacific Standard Time)
RMANote String Comment in this RMA if any noted
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: Available for RMA type: Replacement (RMAType value= 1) and the request version=309

RefundGSTorHSTAmount Decimal The refund GST or HST tax amount of this RMA

Not available for Newegg.com and Neweggbusiness.com

RefundPSTorQSTAmount Decimal The refund PST or QST amount of this RMA

Not available for Newegg.com and Neweggbusiness.com

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)
ItemReturnQty Integer The return quantity of each SKU in this RMA
ItemRefundPerQty Integer Refund per qty of the item
ItemShippingRefund Decimal The shipping amount of refund of each SKU in this RMA
RMATotalRefund Decimal RMA total Refund
RefundReason String The refund reason of each item’s in RMA

Available values:

Carrier damage
Defective
Incompatible
No longer needed
Not match what we show
Ordered wrong item
Sent wrong item
Unsatisfied
Personal Reason | Other Reason

ItemReturnQty Integer The return quantity of each SKU in this RMA
ShippedBy String If RMA type = Replacement, available values to indicate who will ship replacement:

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

ReplacementReason String The replacement 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: Personal Reason | Other Reason

ReplacmentReasonDescription 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
Personal Reason | Other Reason: If RMAReason value = 9

RMAShipMethod String The ship method if the RMA type = Replacement:

Super Saver(7-14 business days)
Standard Shipping(5-7 business days)
Expedited Shipping(3-5 business days)
Two-Day Shipping(2 business days)
One-Day Shipping(Next day)
International Economy Shipping(8-15 business days)
International Standard Shipping(5-7 business days)
International Expedited Shipping(3-5 business days)
International Two-Day Shipping(2 business days)
APO/FPO – Military ONLY
Newegg Premier 3 Days
Newegg Premier 2 Days
Newegg Premier Next Day

If RMA type = Refund, this element will be blank.

Schema: RMAListResponse.xsd

Example: XML, Response

<?xml version="1.0" encoding="utf-8"?>
<NeweggAPIResponse>
    <IsSuccess>true</IsSuccess>
    <OperationType>GetRMAListInfoResponse</OperationType>
    <SellerID>A2GS</SellerID>
    <ResponseBody>
        <PageInfo>
            <TotalCount>1</TotalCount>
            <TotalPageCount>1</TotalPageCount>
            <PageIndex>1</PageIndex>
            <PageSize>100</PageSize>
        </PageInfo>
        <RequestID>237F788KK8LS0</RequestID>
        <RequestDate>03/05/2020 22:20:08</RequestDate>
        <RMAInfoList>
            <RMAInfo>
                <SellerID>A2GS</SellerID>
                <RMANumber>22187609</RMANumber>
                <SellerRMANumber>TestRMAA2GS202001231001</SellerRMANumber>
                <RMAType>2</RMAType>
                <RMATypeDescription>Refund</RMATypeDescription>
                <RMADate>01/19/2020 19:24:46</RMADate>
                <RMAStatus>1</RMAStatus>
                <RMAStatusDescription>Open</RMAStatusDescription>
                <LastEditDate>01/22/2020 17:30:39</LastEditDate>
                <LastEditUser>Seller</LastEditUser>
                <OrderNumber>461654091</OrderNumber>
                <OrderDate>11/01/2019 23:36:12</OrderDate>
                <InvoiceNumber>172997652</InvoiceNumber>
                <OrderAmount>0.05</OrderAmount>
                <RMAProcessedBy>Seller</RMAProcessedBy>
                <CustomerName>Jian Qin</CustomerName>
                <CustomerPhoneNumber>626-347-5618</CustomerPhoneNumber>
                <CustomerAddress>17708 Rowland St, Rowland Heights, CA, 91748-1119, USA</CustomerAddress>
                <RMANote>Test Test TestRMAA2GS202001231001 your note here</RMANote>
                <ReturnShippingLabel>
                    <Label>
                        <TrackingNumber>1ZA813779097504156</TrackingNumber>
                        <TrackingURL>http://www.newegg.com/info/trackOrder.aspx?trackingnumber=1ZA813779097504156&amp;Type=1</TrackingURL>
                        <LabelEstimateCost>6.19</LabelEstimateCost>
                        <PaidBy>Customer</PaidBy>
                    </Label>
                </ReturnShippingLabel>
                <RMATransactionList>
                    <RMATransaction>
                        <SellerPartNumber>Test_SPA2GS_20190930_3002</SellerPartNumber>
                        <MfrPartNumber>TestMP#A2GS190930_32</MfrPartNumber>
                        <NeweggItemNumber>9SIA2GSAAK6919</NeweggItemNumber>
                        <Description>Test_Item Website Short Title A2GS 20190930 30002</Description>
                        <UnitPrice>0.01</UnitPrice>
                        <RefundInfo>
                            <ItemReturnQty>1</ItemReturnQty>
                            <ItemRefundPerQty>0.01</ItemRefundPerQty>
                            <ItemShippingRefund>0.00</ItemShippingRefund>
                            <RMATotalRefund>0.01</RMATotalRefund>
                            <RefundReason>1</RefundReason>
                            <RefundReasonDescription>Carrier damage</RefundReasonDescription>
                        </RefundInfo>
                    </RMATransaction>
                </RMATransactionList>
            </RMAInfo>
        </RMAInfoList>
    </ResponseBody>
    <ResponseDate>03/05/2020 22:43:20</ResponseDate>
</NeweggAPIResponse>

Example: Json, Request

{
    "ResponseDate": "03/05/2020 22:42:44",
    "IsSuccess": true,
    "OperationType": "GetRMAListInfoResponse",
    "SellerID": "A2GS",
    "ResponseBody": {
        "PageInfo": {
            "TotalCount": 1,
            "TotalPageCount": 1,
            "PageIndex": 1,
            "PageSize": 100
        },
        "RequestID": "237F788KK8LS0",
        "RequestDate": "03/05/2020 22:20:08",
        "RMAInfoList": [
            {
                "SellerID": "A2GS",
                "RMANumber": 22187609,
                "SellerRMANumber": "TestRMAA2GS202001231001",
                "RMAType": 2,
                "RMATypeDescription": "Refund",
                "RMADate": "01/19/2020 19:24:46",
                "RMAStatus": 1,
                "RMAStatusDescription": "Open",
                "LastEditDate": "01/22/2020 17:30:39",
                "LastEditUser": "Seller",
                "OrderNumber": 461654091,
                "OrderDate": "11/01/2019 23:36:12",
                "InvoiceNumber": 172997652,
                "OrderAmount": 0.05,
                "RMAProcessedBy": "Seller",
                "CustomerName": "Jian Qin",
                "CustomerPhoneNumber": "626-347-5618",
                "CustomerAddress": "17708 Rowland St, Rowland Heights, CA, 91748-1119, USA",
                "RMANote": "Test Test TestRMAA2GS202001231001 your note here",
                "ReturnShippingLabel": [
                    {
                        "TrackingNumber": "1ZA813779097504156",
                        "TrackingURL": "http://www.newegg.com/info/trackOrder.aspx?trackingnumber=1ZA813779097504156&Type=1",
                        "LabelEstimateCost": 6.19,
                        "PaidBy": "Customer"
                    }
                ],
                "RMATransactionList": [
                    {
                        "SellerPartNumber": "Test_SPA2GS_20190930_3002",
                        "MfrPartNumber": "TestMP#A2GS190930_32",
                        "NeweggItemNumber": "9SIA2GSAAK6919",
                        "Description": "Test_Item Website Short Title A2GS 20190930 30002",
                        "UnitPrice": 0.01,
                        "RefundInfo": {
                            "ItemReturnQty": 1,
                            "ItemRefundPerQty": 0.01,
                            "ItemShippingRefund": 0,
                            "RMATotalRefund": 0.01,
                            "RefundReason": 1,
                            "RefundReasonDescription": "Carrier damage"
                        }
                    }
                ]
            }
        ]
    }
}

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: Feb 6, 2020