獲取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(商家配送)
1:Shipped by Newegg(新蛋配送)
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