提交RMA
為一個已完成的訂單提交一個退款或者換貨RMA。
相關URL
Newegg.com: https://api.newegg.com/marketplace/servicemgmt/rma/newrma?sellerid={sellerid}&version={version}
Neweggbusiness.com: https://api.newegg.com/marketplace/b2b/servicemgmt/rma/newrma?sellerid={sellerid}&version={version}
Newegg.ca: https://api.newegg.com/marketplace/can/servicemgmt/rma/newrma?sellerid={sellerid}&version={version}
註:請確保您的請求URL全都是小寫(除Seller ID)並且不能包含任何空格或者分行符號。
參數
| 名稱 | 是否必填? | 描述 |
| sellerid | 是 | 您在新蛋商城的商家編號 |
| version | 否 | Newegg.com:可用版本:307
Neweggbusiness.com和Newegg.ca:可用版本:305 |
相關請求資訊
| HTTP方式 | 是否需要認證? | 請求格式 | 回覆格式 | 頻率限制 |
| POST | 需要 | XML,Json | XML,Json | 100 請求/小時 |
請求文件主體
| 屬性 | 是否必填? | 格式 | 描述 |
| IssueUser | 否 | String | 請求發送者在Seller Portal上註冊過的郵箱位址。
系統只接受商家註冊過的Seller Portal郵箱位址。如果為空,預設值為商家編號 |
| OperationType | 是 | String | 固定值:IssueRMARequest |
| RMAType | 是 | Integer | 有效值: 1. Replacement(換貨) 2. Refund(退款) 對於補償性質退款,請參考提交補償性質退款部分 |
| SourceSONumber | 是 | Integer | 與當前的 RMA 相關聯的訂單編號 |
| SellerRMANumber | 否 | String | 商家定義的退換貨請求編號
|
| DiffShippedByPartyAction | 如果滿足一下條件,為必填:
|
Integer | 你當前提交的 RMA 換貨訂單不僅有商家配送的商品,也有新蛋配送的商品。為了處理 RMA 換貨請求,請在下列選項中選擇一個: 1. 轉換為帶有退貨手續費的Refund(退款)模式 2. 轉換為不帶有退貨手續費的 Refund(退款)模式 3. 拆分成兩個獨立的 RMA |
| AutoReceiveMark | 否 | Integer | 這個標記具有以下功能: RMA 被成功創建後,自動標記為 “收到退貨” 。商家就不需要另外提出 “收到退貨” 的單獨請求以進行退款。 否則,賣家將需要另外提出“收到退貨”的單獨請求以確認收到退貨並進行退款。 如果存在未被處理的 RMA 能被應用於當前的請求,那麼系統會自動匹配一個現存的 RMA 有效值: 0:不自動標記為收到退貨(預設)。只有當RMA標記為已收到,才能退款。 1:在RMA創建後自動標記為收到退貨並執行退款。
註:如果您不確定如何使用該功能,請諮詢datafeeds@newegg.com。 |
| RMANote | 否 | String | 該RMA的補充註釋,最多4000字元 |
| SellerPartNumber | 是 | String | 商家自訂的商品編碼。用於標識商品。 |
| ReturnQuantity | 是 | Integer | 該RMA中此項商品的退貨數量。 |
| ReturnUnitPrice | 如果RMA類型為退款,此項必填 | Decimal | 在退款RMA中每個商品的退款單價,即該商品每件的退款額
|
| RefundShippingPrice | 如果RMA類型為退款,此項必填 | Decimal | 在該RMA中每個商品的運費退款總額。
|
| 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(不滿意) |
Schema: SubmitRMARequest.xsd
示例:XML, Request
POST https://api.newegg.com/marketplace/servicemgmt/rma/newrma?sellerid={sellerid}&version={version}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
<NeweggAPIRequest>
<OperationType>IssueRMARequest</OperationType>
<RequestBody>
<IssueRMA>
<RMAType>2</RMAType>
<SourceSONumber>123456789</SourceSONumber>
<SellerRMANumber>E12345678</SellerRMANumber>
<AutoReceiveMark>1</AutoReceiveMark>
<RMANote>This is a test RMA</RMANote>
<RMATransactionList>
<RMATransaction>
<SellerPartNumber>test001</SellerPartNumber>
<ReturnQuantity>1</ReturnQuantity>
<ReturnUnitPrice>1.00</ReturnUnitPrice>
<RefundShippingPrice>1.00</RefundShippingPrice>
<RMAReason>2</RMAReason>
</RMATransaction>
</RMATransactionList>
</IssueRMA>
</RequestBody>
</NeweggAPIRequest>
示例:Json, Request
POST https://api.newegg.com/marketplace/servicemgmt/rma/newrma?sellerid={sellerid}&version={version}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"OperationType": "IssueRMARequest",
"RequestBody": {
"IssueRMA": {
"RMAType": "2",
"SourceSONumber": "123456789",
"SellerRMANumber": "E12345678",
"AutoReceiveMark": "1",
"RMANote": "This is a test RMA",
"RMATransactionList": {
"RMATransaction": {
"SellerPartNumber": "test001",
"ReturnQuantity": "1",
"ReturnUnitPrice": "1.00",
"RefundShippingPrice": "1.00",
"RMAReason": "2"
}
}
}
}
}
回覆文件主體
| 屬性 | 格式 | 描述 |
| IsSuccess | String | 獲取資料狀態的操作: True: 成功 False: 失敗 |
| OperationType | String | 固定值:IssueRMAResponse |
| SellerID | String | 您的商家編號 |
| RMANumber | Integer | 新蛋分配的RMA 編號 |
| RMAType | Integer | 有效值: 1:Replacement(換貨) 2:Refund(退款) |
| RMATypeDescription | String | 有效值: Replacement:RMAType 值為1 Refund:RMAType 值為2 |
| SellerRMANumber | String | 商家定義的RMA編號
|
| IssueUser | String | RMA發佈者或者商家編號(在創建RMA時,沒有指定RMA發佈者) |
| RMADate | String | RMA 的發佈時間(太平洋標準時間) |
| RMAStatus | Integer | 有效值: 6:Processing(處理中) |
| RMAStatusDescription | String | 有效值:Processing(default)處理中(默認) |
| 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 | 訂單總額
|
| AvailableRefundAmount | Decimal | 有效退款額
|
| RMAProcessedBy | String | 有效值:Newegg或者Seller |
| RMAReceiveDate | String | RMA 貨物接收時間(太平洋標準時間) |
| RMANote | String | 該 RMA 的補充註解 |
| PriorRefundAmount | Decimal | 同一訂單之前的退款金額(如果有)
|
| 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 | 收貨公司 |
| SellerPartNumber | String | 商家自訂的商品編號 |
| MfrPartNumber | String | 廠商商品型號 |
| NeweggItemNumber | String | 新蛋分配的商品編號 |
| Description | String | 商品的網頁標題描述 |
| UnitPrice | Decimal | 商品售價
|
| ReturnQuantity | Integer | 在此 RMA中此項商品的退貨數 |
| ReturnUnitPrice | Decimal | 如果RMA類型為Refund:
如果RMA類型為replacement(換貨),該欄位為空 |
| RefundShippingPrice | Decimal | 如果RMA類型為Refund:
如果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: SubmitRMAResponse.xsd
示例: XML, Response
<?xml version="1.0" encoding="utf-8"?>
<NeweggAPIResponse>
<IsSuccess>true</IsSuccess>
<OperationType>IssueRMAResponse</OperationType>
<SellerID>A006</SellerID>
<ResponseDate>2012-02-22 20:59:50</ResponseDate>
<Memo />
<ResponseBody>
<RMAInfo>
<RMANumber>20103389</RMANumber>
<RMAType>2</RMAType>
<RMATypeDescription>Refund</RMATypeDescription>
<IssueUser>A004</IssueUser>
<RMADate>2012-02-22</RMADate>
<RMAStatus>6</RMAStatus>
<RMAStatusDescription>Processing</RMAStatusDescription>
<RMAShipMethod />
<RMAShipMethodDescription />
<OrderNumber>41473422</OrderNumber>
<OrderDate>2012-01-11</OrderDate>
<InvoiceNumber>82868509</InvoiceNumber>
<OrderAmount>15.00</OrderAmount>
<AvailableRefundAmount>12000</AvailableRefundAmount>
<RMAProcessedBy>newegg</RMAProcessedBy>
<RMAReceiveDate />
<RMANote>This is a test RMA</RMANote>
<PriorRefundAmount>2.00</PriorRefundAmount>
<CustomerName>abc Roosevelt</CustomerName>
<CustomerPhoneNumber>626-271-9700</CustomerPhoneNumber>
<CustomerEmailAddress>gdv6l0viwo4l7j1d@marketplace.newegg.com</CustomerEmailAddress>
<ShipToAddress1>1941 E. Cedar Loop Drive</ShipToAddress1>
<ShipToAddress2>9A</ShipToAddress2>
<ShipToCityName>South Weber</ShipToCityName>
<ShipToStateCode>UT</ShipToStateCode>
<ShipToZipCode>884405</ShipToZipCode>
<ShipToLastName>Roosevelt</ShipToLastName>
<ShipToFirstName>abc</ShipToFirstName>
<ShipToCompany />
<RMATransactionList>
<RMATransaction>
<SellerPartNumber>201112310900</SellerPartNumber>
<MfrPartNumber>201112310900</MfrPartNumber>
<NeweggItemNumber>9SIA0040286987</NeweggItemNumber>
<Description>ICYTEST201112310900</Description>
<UnitPrice>600.00</UnitPrice>
<ReturnQuantity>1</ReturnQuantity>
<ReturnUnitPrice>1.00</ReturnUnitPrice>
<RefundShippingPrice>1.00</RefundShippingPrice>
<RMAReason>2</RMAReason>
<RMAReasonDescription>Defective</RMAReasonDescription>
</RMATransaction>
</RMATransactionList>
</RMAInfo>
</ResponseBody>
</NeweggAPIResponse>
示例: Json, Response
{
"IsSuccess": "true",
"OperationType": "IssueRMAResponse",
"SellerID": "A006",
"ResponseDate": "2012-02-22 20:59:50",
"ResponseBody": {
"RMAInfo": {
"RMANumber": "20103389",
"RMAType": "2",
"RMATypeDescription": "Refund",
"IssueUser": "A004",
"RMADate": "2012-02-22",
"RMAStatus": "6",
"RMAStatusDescription": "Processing",
"OrderNumber": "41473422",
"OrderDate": "2012-01-11",
"InvoiceNumber": "82868509",
"OrderAmount": "15.00",
"AvailableRefundAmount": "12000",
"RMANote": "This is a test RMA",
"PriorRefundAmount": "2.00",
"CustomerName": "abc Roosevelt",
"CustomerPhoneNumber": "626-271-9700",
"CustomerEmailAddress": "gdv6l0viwo4l7j1d@marketplace.newegg.com",
"ShipToAddress1": "1941 E. Cedar Loop Drive",
"ShipToAddress2": "9A",
"ShipToCityName": "South Weber",
"ShipToStateCode": "UT",
"ShipToZipCode": "884405",
"ShipToLastName": "Roosevelt",
"ShipToFirstName": "abc",
"RMATransactionList": {
"RMATransaction": {
"SellerPartNumber": "201112310900",
"MfrPartNumber": "201112310900",
"NeweggItemNumber": "9SIA0040286987",
"Description": "ICYTEST201112310900",
"UnitPrice": "600.00",
"ReturnQuantity": "1",
"ReturnUnitPrice": "1.00",
"RefundShippingPrice": "1.00",
"RMAReason": "2",
"RMAReasonDescription": "Defective"
}
}
}
}
}
請求失敗錯誤資訊
常規HTTP錯誤回應,請參考回覆失敗錯誤代碼清單。
| 錯誤代碼 | 描述 |
| SE001 | Invalid SellerPartNumber.
無效的 SellerPartNumber。 |
| SE003 | OrderNumber is required.
訂單編號 (OrderNumbr) 必填。 |
| SE004 | Cannot issue RMA because the order has not been invoiced.
此訂單交易未完成不能發佈 RMA。 |
| SE005 | ShipMethodCode is required when RMAType is replacement.
當 RMA 類型為換貨時,運送方式代碼(ShipMethodCode)必填。 |
| SE006 | RMATransaction is required in RMATransactionList.
在RMA交易清單裡 RMA 交易必填。 |
| SE007 | ReasonCode is required.
原因代碼(ReasonCode)必填。 |
| SE008 | Return Qty must be greater than zero.
退貨數量必須大於 0 |
| SE009 | [Seller Part #] Return Qty has to be equal to or less than Max Return Qty – Prior Returned Qty, currently the available return qty = {0}. [Seller Part #]退貨數量必須等於或小於最大退貨數-優先退貨數,當前有效的退貨數量= {0}。 |
| SE010 | Refund per Qty must be greater than zero.
每單位數量的退款必須大於 0。 |
| SE011 | {Seller Part #} refund price per Qty cannot be greater than item unit price, which = {0.00}.
{Seller Part #}商品每單位數量的退款額不能大於商品單價{0.00} |
| SE012 | Order Shipping Refund cannot be greater than Order Shipping Charge, which = {0.00}.
訂單運費退款不能大於訂單運費{0.00} |
| SE013 | Replacement RMA Order Qty cannot be greater than item available inventory.
換貨 RMA 訂購數不能大於商品可用庫存數 |
| SE014 | Item(s) has two fulfillment channels. Please use DiffShippedByPartyAction field to resolve this issue.
商品有兩個完成管道。請使用 DiffShippedByPartyAction 欄位來解決這個問題 |
| SE020 | The following item(s) must return with the current item(s) since they are in a same Combo or Auto Add to Cart promotion :{ Seller Part # List}.
由於以下商品和當前商品都屬於相同的 Combo 或自動添加到購物車的促銷,它們必須一起被退回:{ Seller Part # List}. |
| SE021 | The following item(s) must return with the current item(s) since they are in a same Combo or Auto Add to Cart promotion :{ Seller Part # List}.
商品的退款單價(ReturnUnitPrice)不能大於商品在訂單中的單價(UnitPrice){0.00}。 |
| SE023 | Total refund amount cannot exceed total order amount, which = {0.00}.
總退貨數不能超過總訂單數{0.00}。 |
| SE024 | Item does not exist.
商品不存在。 |
| SE025 | Cannot issue RMA because the order type is invalid.
訂單類型無效不能發佈 RMA。 |
| SE026 | Cannot issue RMA because the order is a replacement order.
此訂單是換貨訂單不能發佈 RMA。 |
| SE027 | Cannot issue RMA because the order has been voided.
訂單已被刪除不能發佈 RMA |
| SE031 | Auto Receive is not available for order returns processed by Newegg.
對於由新蛋處理退貨的訂單,Auto Receive(自動接收)不可用 |
| SE032 | Cannot issue RMA as Auto Receive because the RMA type is not refund.
RMA 類型不是退貨,不能將 RMA 發佈為自動接收 |
| SE034 | Refund cannot exceed order total minus previous refunded amount[{0}].
退貨數不能超過訂單總數-已退貨數[{0}] |
| SE035 | This seller account currently does not support the selected shipping method {0}. Please setup this shipping setting in Seller Portal or select another shipping method.
該商家帳戶當前不支援選擇運送方式{0}。請在 Seller Portal 的 shipping setting 裡進行設置運送方式或選擇其他運送方式。 |
| SE036 | The item:{seller part #} unit product refund cannot be less than {minimum refund amount} per account restocking fee setting: {seller restocking fee rate}.
商品:{seller part #}的單位商品退款不能低於{最小退款數} 每個帳戶的退貨費設置: {商家退貨費比率 } |
| SE038 | International seller covered by Newegg Buy-out policy cannot request return or refund directly. Please contact MarketplaceSupport@newegg.com for assistance.
國際商家受新蛋Buy-out政策限制無法直接申請退貨或退款。 請聯繫 MarketplaceSupport@newegg.com請求幫助。 |
| SE039 | This item is not eligible for {refund |replacement}.
該商品不支援退貨|換貨。 |
| SE040 | This seller RMA number must be a text of number and/or letters.
Seller RMA 編號必須是數位和/或字母字串。 |
示例: XML, Response
<?xml version="1.0" encoding="utf-8"?>
<Errors>
<Error>
<Code>SE004</Code>
<Message>Cannot issue RMA because the order has not been invoiced</Message>
</Error>
</Errors>
示例: Json, Response
[
{
"Code": "SE004",
"Message": "Cannot issue RMA because the order has not been invoiced"
}
]
更新日期:10/15/2018