運送訂單
運送訂單功能允許您更新訂單中一個或全部商品的運送資訊。當一個訂單被完全運送,即訂單中所有商品都已運送,那麼這個訂單就處理完成了。
請參考以下案例瞭解可接受的運送訂單請求:
訂單XYZ有5個商品A,一個商品B
- 場景1單個包裹:包裹1,包含5個商品A和一個商品B,且使用一個運送單號
- 場景2 單個包裹:包裹1,包含5個商品A且使用一個運送單號
- 這將被視為部分發貨訂單
- 商品B應該在訂單自動失效前通過包裹2發貨,如果未發貨,新蛋將從訂單中刪除商品B,並僅為訂單中的商品A開具發票
- 場景3 多個包裹:包裹1包含5個商品A, 使用一個運送單號;包裹2包含1個商品B,使用一個運送單號
- 場景4多個包裹:包裹1包含2個商品A, 使用一個運送單號;包裹2包含3個商品A,使用一個運送單號;包裹3包含1個商品B,使用一個運送單號
- 新蛋不接受這樣提交部分運送的請求:僅有一個包裹只包含2個商品A,使用一個運送單號
- 新蛋系統會報錯並提示商品A 的訂購總數量與發貨數量不匹配。
相關URL
Newegg.com: https://api.newegg.com/marketplace/ordermgmt/orderstatus/orders/{ordernumber}?sellerid={sellerid}&version={version} Neweggbusiness.com: https://api.newegg.com/marketplace/b2b/ordermgmt/orderstatus/orders/{ordernumber}?sellerid={sellerid}&version={version} Newegg.ca: https://api.newegg.com/marketplace/can/ordermgmt/orderstatus/orders/{ordernumber}?sellerid={sellerid}&version={version}
註:請確保您的請求URL全都是小寫(除Seller ID)並且不能包含任何空格或者分行符號。
參數
名稱 | 是否必填? | 描述 |
sellerid | 是 | 您在新蛋商城的商家編號 |
ordernumber | 是 | 訂單編號 |
version | 否 | 可用版本號:304 |
相關請求資訊
HTTP方式 | 是否需要認證 | 請求格式 | 回覆格式 | 頻率限制 |
PUT | 需要 | XML,Json | XML,Json | 1000 請求/小時 |
請求文件主體
屬性 | 是否必填 | 格式 | 描述 |
Action | 是 | Integer | 2:運送訂單 |
SellerID | 是 | String | 您在新蛋商城的商家編號 |
SONumber | 是 | Integer | 銷售訂單編號 |
TrackingNumber | 是 | String | 已發貨包裹的運送單號 |
ShipCarrier | 是 | String | 賣家在發貨時使用的物流公司。 Newegg.com,NeweggBusiness.com 以及Newegg.ca都可接受的有效值,請參考新蛋已對接物流服務商列表 |
ShipService | 是 | String | 物流服務類型,例如空運、陸運等。請直接向您使用的物流公司查詢。 |
SellerPartNumber | 是 | String | 商品的Seller Part#(商家分配的商品編號) |
NeweggItemNumber | 否 | String | 商品的Newegg Item#(新蛋商城分配的商品編號) |
ShippedQty | 是 | String | 商品發貨的數量。該值必須大於0。 |
Schema: ShipmentRequest.xsd
示例:XML, Request
註:<VALUE>必須附上<![CDATA[]]>,細節部分請看下面示例
PUT https://api.newegg.com/marketplace/can/ordermgmt/orderstatus/orders/{ordernumber}?sellerid={sellerid} Authorization: 720ddc067f4d115bd544aff46bc75634 SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D Content-Type: application/xml Accept: application/xml <UpdateOrderStatus> <Action>2</Action> <Value> <![CDATA[ <Shipment><Header><SellerID>A006</SellerID><SONumber>159243598</SONumber></Header><PackageList><Package><TrackingNumber>lztestA0060001</TrackingNumber><ShipCarrier>Other Carrier</ShipCarrier><ShipService>Other Service</ShipService><ItemList><Item><SellerPartNumber>A006ZX-35833</SellerPartNumber><ShippedQty>1</ShippedQty></Item></ItemList></Package></PackageList></Shipment> ]]> </Value> </UpdateOrderStatus>
示例:Json, Request
PUT https://api.newegg.com/marketplace/can/ordermgmt/orderstatus/orders/{ordernumber}?sellerid={sellerid} Authorization: 720ddc067f4d115bd544aff46bc75634 SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D Content-Type: application/Json Accept: application/Json { "Action": "2", "Value": { "Shipment": { "Header": { "SellerID": "A006", "SONumber": "159243598" }, "PackageList": { "Package": [ { "TrackingNumber": "alistestonly1", "ShipCarrier": "Purolator", "ShipService": "3-5", "ItemList": { "Item": { "SellerPartNumber": "A3WG11002378965412586", "ShippedQty": "1" } } }, { "TrackingNumber": "alistestonly2", "ShipCarrier": "Purolator", "ShipService": "3-5", "ItemList": { "Item": [ { "SellerPartNumber": "A3WG11002378965412583", "ShippedQty": "1" }, { "SellerPartNumber": "A3WG11002378965412584", "ShippedQty": "1" } ] } } ] } } } }
回覆文件主體
屬性 | 格式 | 描述 |
IsSuccess | String | 用來確認訂單更新操作是否成功。 始終返回 true |
TotalPackageCount | Integer | 包裹數量 |
SuccessCount | Integer | 處理成功包裹數 |
FailCount | Integer | 處理失敗包裹數 |
OrderNumber | Integer | 要進行操作的訂單編號 |
SellerID | String | 您的商家編號 |
OrderStatus | String | 新訂單狀態:
|
TrackingNumber | String | 已發貨包裹的運單號 |
ShipDate | String | 發貨時間(太平洋標準時間) |
ProcessStatus | String | True或者 False True=包裹已被成功處理 False=包裹處理失敗 |
SellerPartNumber | String | 商品的商家編號 |
NeweggItemNumber | String | 商品的新蛋編號 |
ShippedQty | Integer | 發貨的商品數量 |
Schema: ShipmentResponse.xsd
示例:XML, Response
<?xml version="1.0" encoding="utf-8"?> <UpdateOrderStatusInfo> <IsSuccess>true</IsSuccess> <PackageProcessingSummary> <TotalPackageCount>1</TotalPackageCount> <SuccessCount>1</SuccessCount> <FailCount>0</FailCount> </PackageProcessingSummary> <Result> <OrderNumber>159243598</OrderNumber> <SellerID>A006</SellerID> <OrderStatus>Shipped</OrderStatus> <Shipment> <PackageList> <Package> <TrackingNumber>lztestA0060001</TrackingNumber> <ShipDate>2012-02-10T15:30:01</ShipDate> <ProcessStatus>true</ProcessStatus> <ProcessResult>Success</ProcessResult> <ItemList> <ItemDes> <NeweggItemNumber>9SIA0060845543</NeweggItemNumber> <SellerPartNumber>A006ZX-35833</SellerPartNumber> <ShippedQty>1</ShippedQty> </ItemDes> </ItemList> </Package> </PackageList> </Shipment> </Result> </UpdateOrderStatusInfo>
示例:Json, Response
{ "IsSuccess": true, "PackageProcessingSummary": { "FailCount": 0, "SuccessCount": 1, "TotalPackageCount": 1 }, "Result": { "OrderNumber": "159243598", "OrderStatus": "Shipped", "SellerID": "A006", "Shipment": { "PackageList": [ { "ItemList": [ { "NeweggItemNumber": "9SIA0060845543", "SellerPartNumber": "A006ZX-35833", "ShippedQty": 1 } ], "ProcessResult": "Success", "ProcessStatus": true, "ShipDate": "2012-02-10T15:30:01", "TrackingNumber": "lztestA0060001" } ] } } }
請求失敗錯誤資訊
常規HTTP錯誤回應,請參考回覆失敗錯誤代碼清單。
錯誤代碼 | 描述 |
SO001 | Seller ID cannot be null or empty
Seller ID(商家編號)不能為空。 |
SO002 | Order Number should be an integer (ranging from 1 to 2147483647)
訂單編號應為整數(區間為 1 到 2147483647)。 |
SO003 | No data found or this order does not belong to this seller
找不到資料或此訂單不屬於該商家。 |
SO004 | This is a replacement SO with a RMA number. It cannot be voided
此訂單是帶有 RMA 編號的換貨訂單,不能被作廢。 |
SO005 | Cannot remove item because this is a Shipped by Newegg order. order is Shipped by Newegg
不能移除由新蛋 SBN 服務運送的訂單中的商品。此訂單由新蛋 SBN 服務運送。 |
SO006 | Only unshipped orders can be voided. The order status is currently {0}
只有未發貨的訂單才能被刪除。當前訂單狀態為{0}。 |
SO007 | Cannot get the order status info
不能獲取訂單狀態資訊。 |
SO008 | This order has already been voided
此訂單已被作廢。 |
SO009 | Order number cannot be null or empty
訂單編號不能為空。 |
SO010 | Invalid order. No item exists
無效訂單。此訂單無商品。 |
SO011 | Only unshipped orders can be shipped. The order status is currently {0}
只有未發貨的訂單才能被運送。訂單狀態當前為{0}。 |
SO012 | Only shipped by seller orders can be supported currently
當前只支持商家配送的訂單。 |
SO014 | The action should be [ Canceled = 1 | Shipped = 2]
操作應該是 [ 已取消 = 1 | 已發貨 = 2]。 |
SO015 | The Argument ‘{0}’ cannot be null
參數‘{0}不能為空。 |
SO016 | This order has not been downloaded onto seller portal yet. Please re-submit your request after two hours.
此訂單目前不能在 seller portal 上下載。請在兩小時後重新提交請求。 |
SO017 | Reason code should be [24 — OutOfStock,72 — Customer Requested to Cancel,73 — PriceError,74 — Unable to Fulfill the Order]
原因代碼應為 [24 – 缺貨,72 – 顧客請求取消訂單,73 – 價格錯誤,74 – 無法完成訂單]。 |
SO020 | There is a package or packages without shipping information in this shipment.
訂單在此貨運單中有一個或多個包裹缺失運輸資訊。 |
SO025 | Some items in the shipment have already been shipped.
此貨運單中的部分商品已被運出。 |
SO027 | This order has already been shipped.
此訂單已發貨。 |
SO030 | There is a format error in shipment segment of this XML request.
此 XML 請求的運送資訊部分有格式錯誤。 |
SO036 | The order’s shipping method is null. Please contact System Admin.
訂單的運送方式為空,請聯繫系統管理員。 |
SO037 | The action should be [1 – Cancelled, 2 – Shipped]
操作應為[1 – 已取消, 2 – 已發貨]。 |
SO040 | The Order number or Seller ID provided is not the same as in the URL.
提供的訂單編號或商家編號與 URL 中的不匹配。 |
SO056 | Your request cannot be processed. Order:[order #] is a Newegg Premier order and can only be shipped using Newegg Shipping Label Service.
你的請求無法處理。訂單編號[order #]是一個 Newegg Premier 訂單,只能使用 Newegg Shipping Label Service 服務運送。 |
示例:XML, Response
<?xml version="1.0" encoding="utf-8"?> <Errors> <Error> <Code>SO002</Code> <Message>Order Number should be an integer (ranging from 1 to 2147483647)</Message> </Error> </Errors>
示例:Json, Response
[ { "Code": "SO002", "Message": "Order Number should be an integer (ranging from 1 to 2147483647)" } ]
更新日期:10/15/2018