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:
|
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:
|
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 | Newegg’s assigned number for RMA |
RMATypeDescription | String | Available values:
|
RMAType | Integer | Available values:
|
SellerRMANumber | String | Seller’s user defined RMA number
|
RMADate | String | Date of RMA (Pacific Standard Time) |
RMAStatus | Integer | Available values:
|
RMAStatusDescription | String | Available values:
|
LastEditDate | String | Last edit date (Pacific Standard Time) |
LastEditUser | String | Last 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
|
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.
|
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
|
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:
|
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:
|
ReplacementReason | String | The replacement reason of each item’s in RMA Available values:
|
ReplacmentReasonDescription | String | The replacement/refund reason of each item’s in RMA Available values:
|
RMAShipMethod | String | The ship method if the RMA type = Replacement:
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&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