获取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 编号 |
RMATypeDescription | String | 有效值: Replacement 换货:RMAType 值为1 Refund 退款:RMAType 值为2 |
RMAType | Integer | 有效值: 1:Replacement(换货) 2:Refund(退款) |
SellerRMANumber | String | 商家自定义的退换货请求编号
|
RMADate | String | RMA发布时间(太平洋标准时间) |
RMAStatus | Integer | 有效值: 1: Open(待收货) 2: Received(已接收) 3: Rejected(已拒绝) 4: Voided(已作废) 5: Closed(已完成) 6: Processing(处理中) |
RMAStatusDescription | String | 有效值: Open(待收货):如果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中,每个商品退货的原因。 有效值: Carrier damage(运输损伤) Defective(有缺陷) Incompatible(商品不兼容) No longer needed(不再需要) Not match what we show(与页面中描述的不相符) Ordered wrong item(订错商品) Sent wrong item(发错商品) Unsatisfied(不满意) 个人原因|其他原因 |
ItemReturnQty | Integer | 该RMA中,每个商品的退回数量 |
ShippedBy | String | 如果RMA类型为Replacement(换货),以下为有效值用于表示谁将配送换货: 0:Shipped by Seller(商家配送SBS) 1:Shipped by Newegg(新蛋配送SBN) |
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)时的运送方式: 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 如果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