获取RMA信息

通过指定查询条件获取RMA的信息。

相关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}

注:请确保您的请求URL全都是小写(除Seller ID)并且不能包含任何空格或者换行符。

参数

名称 是否必填? 描述
sellerid 您在新蛋商城的商家编号
version Newegg.com:可用版本:307,309,320
Neweggbusiness.com和Newegg.ca:可用版本:305,309,320
注:

  • 309,回复包括:
    • 商家自己的RMA编号,以供参考
    • 该RMA下的换货订单号
  • 320,回复包括:
    • 退货货运标签信息

相关请求信息

HTTP方式 是否需要认证? 请求格式 回复格式 频率限制
PUT 需要 XML,Json XML,Json 1000 请求/小时

请求文件主体

属性 是否必填? 格式 描述
IssueUser String 请求发送者在Seller Portal上注册过的邮箱地址。
系统只接受商家注册过的Seller Portal邮箱地址。如果为空,默认值为商家编号。
OperationType String 固定值:GetRMAInfoRequest
PageSize Integer 一页中的记录数

  • 一页最大记录数为100
  • 如果不填,默认为1
PageIndex Integer 当前页索引

  • 默认为1
  • 如果不填,默认为100
KeywordsType Integer 有效值:

  • 1: RMANumber(RMA编号)
  • 2: OrderNumber(订单编号)
  • 3: CustomerName(顾客姓名)
  • 4: SellerRMANumber(商家退换货编号)

注:对于SellerRMANumber:

  • Newegg.com 使用307版本
  • Newggbusiness.com 和 Newegg.ca 使用305版本
KeywordsValue String 指定类型的关键字的值
Status Integer 有效值:

  • 0: All (Default)(所有(默认))
  • 1: Open(待收货)
  • 2: Received(已接收)
  • 3: Rejected(已拒绝)
  • 4: Voided(已作废)
  • 5: Closed(已关闭)
  • 6: Processing(处理中)
RMADateFrom String 根据时间范围查找 RMA(太平洋标准时间)。请参考可接受时间格式
RMADateTo String 根据时间范围查找 RMA(太平洋标准时间)。请参考可接受时间格式
RMAType Integer 有效值:

  • 0: All (Default) (所有(默认))
  • 1: Replacement(换货)
  • 2: Refund(退款)
ProcessedBy Integer 有效值:

  • 0: All (Default)(所有(默认))
  • 1: Seller(商家)
  • 2: Newegg(新蛋)

Schema: RMAInfoRequest.xsd

示例: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>

示例: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"
    }
}

回复文件主体

属性 格式 描述
IsSuccess String 获取数据状态的操作:

  • True:成功
  • False:失败
OperationType String 固定值:IssueRMAResponse
SellerID String 您的商家编号
TotalCount Integer 总记录数
TotalPageCount Integer 总页数
PageIndex Integer 当前页索引(默认为1)
PageSize Integer 一页的记录个数(每页最大为100个记录)
RMANumber Integer 新蛋分配的RMA 编号
RMAType Integer 有效值:

  • 1:Replacement(换货)
  • 2:Refund(退款)
RMATypeDescription String 有效值:

  • Replacement 换货:RMAType 值为1
  • Refund 退款:RMAType 值为2
SellerRMANumber String 商家定义的退换货请求编号

  • 含有字母和数字的字符串,最多50个字符
  • Newegg.com可用版本:307,309
  • Neweggbusiness.com 和Newegg.ca可用版本:305,309
ReplacementOrderNumber String 换货订单的订单编号。在确认收到顾客退货后,新蛋将为您创建一个换货订单。

注:Newegg.com,Neweggbusiness.com,Newegg.ca平台适用的RMA类型:Replacement(换货)(RMAType值为1)并且请求版本为309。

IssueUser String RMA发布者或者商家编号(在创建RMA时,没有指定RMA发布者)
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
RMAShipMethod Integer 如果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),该字段为空

RMAShipMethodDescription String 如果RMA类型为换货(Replacement)时的运送方式:

  • Super Saver(7-14 business days):如果RMAShipMethod值为1
  • Standard Shipping(5-7 business days) :如果RMAShipMethod值为2
  • Expedited Shipping(3-5 business days) :如果RMAShipMethod值为3
  • Two-Day Shipping(2 business days) :如果RMAShipMethod值为4
  • One-Day Shipping(Next day) :如果RMAShipMethod值为5
  • International Economy Shipping(8-15 business days) :如果RMAShipMethod值为6
  • International Standard Shipping(5-7 business days) :如果RMAShipMethod值为7
  • International Expedited Shipping (3-5 business days) :如果RMAShipMethod值为8
  • International Two-Day Shipping(2 business days) :如果RMAShipMethod值为9
  • APO/FPO – Military:如果RMAShipMethod值为10
  • Newegg Premier 3 Days:如果RMAShipMethod值为11
  • Newegg Premier 2 Days:如果RMAShipMethod值为12
  • Newegg Premier Next Day:如果RMAShipMethod值为13

如果RMA类型为退款(Refund),该字段为空

OrderNumber Integer 已发布 RMA 订单的订单编号
OrderDate String 订单时间(太平洋标准时间)
InvoiceNumber Integer 已发布 RMA 订单的发票编号
OrderAmount Decimal 订单总额

  • Newegg.com 和 Newggbusiness.com,所有金额都设置使用美元(USD)
  • Newegg.ca,所有金额都设置使用加元(CAD)
AvailableRefundAmount Decimal 有效退款额=总金额-已退款金额(包括当前RMA)

  • Newegg.com 和 Newggbusiness.com,所有金额都设置使用美元(USD)
  • Newegg.ca,所有金额都设置使用加元(CAD)
RMAProcessedBy String 有效值:Newegg或者Seller
RMAReceiveDate String RMA 货物接收时间(太平洋标准时间)
RMANote String 该 RMA 的补充注解
PriorRefundAmount Decimal 同一订单之前的退款金额(如果有)

  • Newegg.com 和 Newggbusiness.com,所有金额都设置使用美元(USD)
  • Newegg.ca,所有金额都设置使用加元(CAD)
CustomerName String 顾客姓名
CustomerPhoneNumber String 顾客电话
CustomerEmailAddress String 被加密的顾客邮箱地址,你可以通过这个地址联系顾客
例如: gdv6l0viwo4l7j1d@marketplace.newegg.com
ShipToAddress1 String 订单收货地址 1
ShipToAddress2 String 订单收货地址 2
ShipToCityName String 收货地城市名
ShipToStateCode String 收货地所在州代码
ShipToZipCode String 收货地邮编
ShipToCountryCode String 收货地所在国家代码
ShipToLastName String 收货人名
ShipToFirstName String 收货人姓
ShipToCompany String 收货公司
TrackingNumber String 退回货运标签相关信息
Newegg.com,Neweggbusiness.com 和Newegg.ca:可用版本:320
TrackingURL String
LabelEstimateCost Decimal
PaidBy String
SellerPartNumber String 商家自定义的商品编号
MfrPartNumber String 厂商商品型号
NeweggItemNumber String 新蛋分配的商品编号
Description String 商品的网页标题描述
UnitPrice Decimal 商品售价

  • Newegg.com 和 Newggbusiness.com,所有金额都设置使用美元(USD)
  • Newegg.ca,所有金额都设置使用加元(CAD)
ReturnQuantity Integer 在此 RMA中此项商品的退货数
ReturnUnitPrice Decimal 如果RMA类型为Refund:

  • 在退款RMA中每个商品的退款单价,即该商品每件的退款额
  • Newegg.com 和 Newggbusiness.com,所有金额都设置使用美元(USD)
  • Newegg.ca,所有金额都设置使用加元(CAD)

如果RMA类型为replacement(换货),该字段为空

RefundShippingPrice Decimal 如果RMA类型为Refund:

  • 在该RMA中每个商品的运费退款总额。
  • Newegg.com 和 Newggbusiness.com,所有金额都设置使用美元(USD)
  • Newegg.ca,所有金额都设置使用加元(CAD)

如果RMA类型为replacement(换货),该字段为空

ShippedBy Integer 如果RMA类型为Replacement(换货),以下为有效值用于表示谁将配送换货:

  • 0:Shipped by Seller(商家配送SBS)
  • 1:Shipped by Newegg(新蛋配送SBN)
RMAReason Integer 在该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:其他原因{0}
RMAReasonDescription 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
  • 其他原因{0}:如果RMAReason值为9
Memo String 附加说明
ResponseDate String 回复时间(太平洋标准时间)

Schema: RMAInfoResponse.xsd

示例: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>Nazi Power 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>

示例: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"
  }
}

请求失败错误信息

常规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"
    }
]

更新日期:10/15/2018