獲取RMA列表報表
獲取商家帳戶下退貨、換貨和退款的列表報表。
相關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}
註:請確保您的請求URL全都是小寫(除Seller ID)並且不能包含任何空格或者分行符號。
參數
名稱 | 是否必填? | 描述 | ||||||||||||||||||
sellerid | 是 | 您在新蛋商城的商家編號 | ||||||||||||||||||
version | 是 | 有效版本:
|
相關請求資訊
HTTP方式 | 是否需要認證? | 請求格式 | 回覆格式 | 頻率限制 |
PUT | 需要 | XML,Json | XML,Json | 500 請求/小時 |
請求文件主體
屬性 | 是否必填? | 格式 | 描述 |
IssueUser | 否 | String | 請求發送者在Seller Portal上註冊過的郵箱位址 。 系統只接受商家註冊過的Seller Portal郵箱位址。如果為空,預設值為商家編號 |
OperationType | 是 | String | 固定值:RMAListReportRequest |
RequestID | 是 | String | 新蛋分配的已提交的請求的編號 |
PageIndex | 是 | Integer | 當前頁索引 |
PageSize | 是 | Integer | 單頁返回的記錄總數 每頁最多100條 |
Schema: GetReportRequest.xsd
示例: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>
示例: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" } } }
回覆文件主體
屬性 | 格式 | 描述 |
IsSuccess | String | 獲取資料狀態的操作: True: 成功 False: 失敗 |
SellerID | String | 您的商家編號 |
OperationType | String | 固定值:GetRMAListInfoResponse |
RequestID | String | 已提交的請求編號 |
RequestDate | String | 請求提交時間(太平洋標準時間) |
TotalCount | Integer | 總記錄數 |
TotalPageCount | Integer | 總頁數 |
PageIndex | Integer | 當前頁索引 |
PageSize | Integer | 單頁的記錄數 |
SellerID | String | 您的商家編號 |
RMANumber | Integer | 新蛋分配的RMA 編號 |
RMAType | Integer | 有效值: 1:Replacement(換貨) 2:Refund(退款) |
RMATypeDescription | String | 有效值: Replacement:RMAType 值為1 Refund:RMAType 值為2 |
SellerRMANumber | String | 商家定義的退換貨請求編號
|
RMADate | String | RMA 的發佈時間(太平洋標準時間) |
RMAStatus | Integer | 有效值: 0: All (Default)(默認) 1: Open(待收貨) 2: Received(已接收) 3: Rejected(已拒絕) 4: Voided(已作廢) 5: Closed(已關閉) 6: Processing(處理中) |
RMAStatusDescription | String | 有效值: All (Default)(默認):如果RMAStatus值為1 Received(已接收):如果RMAStatus值為2 Rejected(已拒絕):如果RMAStatus值為3 Voided(已作廢):如果RMAStatus值為4 Closed(已關閉):如果RMAStatus值為5 Processing(處理中):如果RMAStatus值為6 |
LastEditDate | String | 最後編輯時間(太平洋標準時間) |
LastEditUser | String | 最後編輯用戶 |
OrderNumber | Integer | 已發佈 RMA 訂單的訂單編號 |
OrderDate | String | 訂單時間(太平洋標準時間) |
InvoiceNumber | Integer | 已發佈 RMA 訂單的發票號碼 |
OrderAmount | Decimal | 訂單總額
|
RMAProcessedBy | String | 有效值:Newegg或者Seller |
CustomerName | String | 顧客姓名 |
CustomerPhoneNumber | String | 顧客電話 |
CustomerAddress | String | 顧客地址 |
RMAReceiveDate | String | RMA 貨物接收時間 |
RMANote | String | 該 RMA 的補充註解 |
ReplacementOrderNumber | String | 換貨訂單的新訂單編號。確認收到退貨後,新蛋將創建一個替換訂單供您處理 註:可用RMA 類型:換貨(RMAType=1) 請求版本 = 309 |
RefundGSTorHSTAmount | Decimal | GST或HST(增值稅/消費稅)稅收退款 不適用於Newegg.com and Neweggbusiness.com |
RefundPSTorQSTAmount | Decimal | PST(省銷售稅)(有些省稱為QST)稅收退款 不適用於Newegg.com and Neweggbusiness.com |
TrackingNumber | String | 退回貨運標籤相關資訊 可用版本:320 |
TrackingURL | String | |
LabelEstimateCost | Decimal | |
PaidBy | String | |
SellerPartNumber | String | 商家自訂的商品編號 |
MfrPartNumber | String | 廠商商品型號 |
NeweggItemNumber | String | 新蛋分配的商品編號 |
Description | String | 商品的網頁標題描述 |
UnitPrice | Decimal | 商品售價
|
ItemReturnQty | Integer | 此 RMA 中每個商品的退貨數量 |
ItemRefundPerQty | Integer | 商品單個退款額 |
ItemShippingRefund | Decimal | 此 RMA 中每個商品的運費退款 |
RMATotalRefund | Decimal | RMA 總退款 |
RefundReason | String | 在該RMA中,每個商品退貨的原因。 有效值: 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:個人原因|其他原因 |
ItemReturnQty | Integer | 該RMA中,每個商品的退回數量 |
ShippedBy | Integer | 如果RMA類型為Replacement(換貨),以下為有效值用於表示誰將配送換貨: 0:Shipped by Seller(商家配送) 1:Shipped by Newegg(新蛋配送) |
ReplacmentReason | String | 該RMA中每個商品的退/換貨原因,有效值: 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:個人原因|其他原因 |
ReplacmentReasonDescription | String | 在該RMA中,每個商品退/換貨的原因。 有效值: Carrier damage(運輸損傷):如果RMAReason值為1 Defective(有瑕疵):如果RMAReason值為2 Incompatible(商品不相容):如果RMAReason值為3 No longer needed(不再需要):如果RMAReason值為4 Not match what we show(與頁面中描述的不相符):如果RMAReason值為5 Ordered wrong item(訂錯商品):如果RMAReason值為6 Sent wrong item(寄錯商品):如果RMAReason值為7 Unsatisfied(不滿意):如果RMAReason值為8 個人原因|其他原因:如果RMAReason值為9 |
RMAShipMethod | String | 如果RMA類型為換貨(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 如果RMA類型為退款(Refund),該欄位為空 |
Schema: RMAListResponse.xsd
示例: 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>
示例: Json, Response
{ "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" } } ] } ] } }
請求失敗錯誤資訊
常規HTTP錯誤回應,請參考回覆失敗錯誤代碼清單。
示例: XML, Response
<?xml version="1.0" encoding="utf-8"?> <Errors> <Error> <Code>CE001</Code> <Message>SellerID cannot be null or empty</Message> </Error> </Errors>
示例: Json, Response
[ { "Code": "CE001", "Message": "SellerID cannot be null or empty" } ]
更新日期:02/06/2020