獲取訂單清單報表
獲取商家帳戶下有效訂單清單。
相關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 | 固定值:OrderListReportRequest |
| 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>OrderListReportRequest</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": "OrderListReportRequest",
"RequestBody": {
"RequestID": "2PQBYWH4V68ZP",
"PageInfo": {
"PageSize": "10",
"PageIndex": "1"
}
}
}
回覆文件主體
| 屬性 | 格式 | 描述 |
| IsSuccess | String | 用於獲取資料狀態的操作 True:成功 False:失敗 |
| SellerID | String | 您的商家編號 |
| OperationType | String | 固定值:GetOrderInfoResponse |
| RequestID | String | 新蛋為已提交的請求分配的編號 |
| RequestDate | String | 您提交請求的時間(太平洋標準時間) |
| TotalCount | Integer | 記錄總數 |
| TotalPageCount | Integer | 總頁數 |
| PageIndex | Integer | 當前頁索引 |
| PageSize | Integer | 單頁的記錄數 |
| SellerID | String | 您的商家編號 |
| OrderNumber | Integer | 新蛋訂單編號 |
| SellerOrderNumber | String | 賣家自訂訂單編號 僅對使用SBN服務來運送其他管道訂單的商家可用。 有效版本:305,306 |
| InvoiceNumber | Integer | 發票編號 |
| OrderDownloaded | String | False:訂單還未被下載 True:訂單已被下載 當訂單已發貨,這個欄位將自動變為“True” |
| OrderDate | String | 訂單創建時間 |
| OrderStatus | Integer | 訂單狀態: 0. Unshipped(未發貨) 1. Partially Shipped(部分發貨) 2. Shipped(完全發貨) 3. Invoiced(交易完成) 4. Voided(訂單已作廢) |
| OrderStatusDescription | String | 訂單狀態描述: Unshipped(未發貨):訂單狀態碼 0 PartiallyShipped(部分發貨):訂單狀態碼 1 Shipped(已全部發貨):訂單狀態碼 2 Invoiced(交易完成):訂單狀態碼 3 Void(作廢訂單):訂單狀態碼 4 |
| CustomerName | String | 訂單中的顧客姓名 |
| CustomerPhoneNumber | String | 訂單中的顧客電話 |
| CustomerEmailAddress | String | 被加密的顧客郵箱地址,你可以通過這個地址聯繫顧客。 比如: gv6l0iwo4l7j1d@marketplace.newegg.com 註:在Newegg.com 310 版本中,如果AutoRegWarranty值為True, 顧客郵箱地址將被取消加密;否則,它依然為加密郵箱。 |
| ShipToAddress1 | String | 訂單收貨位址 1 |
| ShipToAddress2 | String | 訂單收貨位址 2 |
| ShipToCityName | String | 收貨地所在城市 |
| ShipToStateCode | String | 收貨地所在州 |
| ShipToZipCode | String | 收貨地郵編 |
| ShipToCountryCode | String | 收貨地國家,如 United Kingdom |
| ShipService | String | 訂單運送服務的有效選項: Shipped By Newegg APO/FPO – Military ONLY 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 Expedited Shipping(3-5 business days) International Two-Day Shipping(2 business days) International Economy Shipping(8-15 business days) International Standard Shipping(5-7 business days) 註:以下運送服務表示該訂單為新蛋Premier訂單,請按照服務要求儘快配送訂單。 Newegg Premier 3 Days Newegg Premier 2 Days Newegg Premier Next Day 如有關於 Premier 商家註冊專案的詳細資訊, 請聯繫 Datafeeds@Newegg.com。 |
| ShipToFirstName | String | 收貨人名 |
| ShipToLastName | String | 收貨人姓 |
| ShipToCompany | String | 收貨地所在公司 |
| OrderItemAmount | Decimal | 訂單商品總金額
|
| ShippingAmount | Decimal | 訂單運費總金額
|
| DiscountAmount | Decimal | 訂單折扣總金額
|
| GSTorHSTAmount | Decimal | 訂單的GST或HST(增值稅/消費稅)稅收總額
不適用於Newegg.com和Newggbusiness.com平台 |
| PSTorQSTAmount | Decimal | 訂單的PST(省銷售稅)(有些省稱為QST)總額
不適用於Newegg.com和Newggbusiness.com平台 |
| OrderQty | Integer | 訂單的商品總數 |
| RefundAmount | Decimal | 訂單的退款總金額
|
| RecyclingFeeAmount | Decimal | 回收費是政府對新購買的電子產品、電池、新輪胎等徵收的費用。這些費用用於支付這些產品的未來回收,因為其中許多產品含有有害物質。以下回收費用將添加到回收費用總額中:電子廢物回收費、電池回收費、輪胎回收費、環保費。 有效版本: Newegg.com: 309 Neweggbusiness.com: 306 |
| SalesTax | Decimal | 訂單的消費稅
有效版本:307 |
| VATTotal | Decimal | 國際增值稅總額。
有效版本:307 |
| DutyTotal | Decimal | 國際關稅總額。
有效版本:307 |
| OrderTotalAmount | Decimal | 訂單總金額
|
| IsAutoVoid | String | 如果訂單被新蛋系統自動作廢,那麼值為 true,否則,值為 false |
| SalesChannel | Integer | 訂單銷售管道: 0. Newegg order(新蛋訂單) 1. Multi-channel order(其他管道訂單) 2. Replacement order(換貨訂單) 有效版本:305,306,307,309 |
| FulfillmentOption | Integer | 訂單運送方式: 0.Ship by Seller(商家配送) 1.Ship by Newegg(新蛋配送) |
| SellerPartNumber | String | 商家自訂的商品編號 |
| NeweggItemNumber | String | 新蛋分配的商品編號 |
| MfrPartNumber | String | 廠商商品型號 |
| UPCCode | String | 商品 UPC 編碼 |
| Description | String | 商品的網頁標題描述 |
| OrderedQty | Integer | 商品的訂購數量 |
| ShippedQty | Integer | 商品的運送數量 |
| UnitPrice | Decimal | 出現在顧客購物車中的最終商品單價
|
| ExtendUnitPrice | Decimal | 商品的總價(商品的單位價格 x 訂購個數)
|
| ExtendShippingCharge | Decimal | 商品的總運費(商品單位運費 x 訂購數量)
|
| ExtendSalesTax | Decimal | 商品總消費稅
有效版本:307 |
| ExtendVAT | Decimal | 商品總增值稅
有效版本:307 |
| ExtendDuty | Decimal | 商品總關稅
有效版本:307 |
| Status | Integer | 有效值: 1: Unshipped(未發貨) 2: Shipped(已發貨) 3: Cancelled(已取消) |
| StatusDescription | String | 有效值: Unshipped(未發貨):訂單狀態碼 1 Shipped(已全部發貨):訂單狀態碼 2 Cancelled(已取消):訂單狀態碼 3 |
| AutoRegWarranty | String | 如果顧客在系統中啟用了商品的自動註冊保固,則該值為 true。否則,該值為false。 如果此值為 true,則顧客郵箱地址將被取消加密。否則,它仍然被加密。 有效版本:310 不適用於Newggbusiness.com 和 Newegg.ca平台 |
| PackageType | String | 包裹類型: 已發貨 未發貨 |
| ShipCarrier | String | 包裹的實際運輸商 |
| ShipService | String | 包裹的實際運輸服務類型 |
| TrackingNumber | String | 包裹的追蹤號碼 |
| ShipDate | String | 包裹的運送時間(太平洋標準時間) |
| SellerPartNumber | String | 商家自訂的商品編號 |
| MfrPartNumber | String | 廠商商品型號 |
| ShippedQty | String | 商品已發貨數量 |
| Memo | String | 其他資訊 |
| ResponseDate | String | 回應時間(太平洋標準時間) |
Schema: OrderListResponse.xsd
示例: XML, Response
<?xml version="1.0" encoding="utf-8"?>
<NeweggAPIResponse>
<IsSuccess>true</IsSuccess>
<SellerID>V006</SellerID>
<OperationType>GetOrderInfoResponse</OperationType>
<ResponseBody>
<PageInfo>
<TotalCount>20</TotalCount>
<TotalPageCount>20</TotalPageCount>
<PageSize>10</PageSize>
<PageIndex>1</PageIndex>
</PageInfo>
<RequestID>2PQBYWH4V68ZP</RequestID>
<RequestDate>2/21/2012 14:38:17</RequestDate>
<OrderInfoList>
<OrderInfo>
<SellerID>V006</SellerID>
<OrderNumber>155738158</OrderNumber>
<SellerOrderNumber>2153930</SellerOrderNumber>
<InvoiceNumber>0</InvoiceNumber>
<OrderDownloaded>false</OrderDownloaded>
<OrderDate>12/21/2011 1:47:24</OrderDate>
<OrderStatus>4</OrderStatus>
<OrderStatusDescription>Voided</OrderStatusDescription>
<CustomerName>Richard Chen</CustomerName>
<CustomerPhoneNumber>626-277-1420</CustomerPhoneNumber>
<CustomerEmailAddress>cq3fw1aierwat94fm@marketplace.newegg.com</CustomerEmailAddress>
<ShipToAddress1>17708 Rowland St</ShipToAddress1>
<ShipToAddress2 />
<ShipToCityName>Rowland Heights</ShipToCityName>
<ShipToStateCode>DC</ShipToStateCode>
<ShipToZipCode>20001</ShipToZipCode>
<ShipToCountryCode>USA</ShipToCountryCode>
<ShipService>Media Mail (7-14 business days)</ShipService>
<ShipToFirstName>Richard</ShipToFirstName>
<ShipToLastName>Chen</ShipToLastName>
<ShipToCompany />
<OrderItemAmount>0.00</OrderItemAmount>
<ShippingAmount>3.00</ShippingAmount>
<DiscountAmount>-5.00</DiscountAmount>
<RefundAmount>0.00</RefundAmount>
<RecyclingFeeAmount>0.00</RecyclingFeeAmount>
<OrderTotalAmount>8.00</OrderTotalAmount>
<OrderQty>1</OrderQty>
<IsAutoVoid>false</IsAutoVoid>
<SalesChannel>0</SalesChannel>
<FulfillmentOption>1</FulfillmentOption>
<ItemInfoList>
<ItemInfo>
<SellerPartNumber>Mike_A006_101478-151</SellerPartNumber>
<NeweggItemNumber>9SIA00607Y6664</NeweggItemNumber>
<MfrPartNumber>Mike_A006_10114-151</MfrPartNumber>
<UPCCode>410997000004</UPCCode>
<Description>Tungsten Ladies' Dome Ring w/ CZ</Description>
<OrderedQty>1</OrderedQty>
<ShippedQty>0</ShippedQty>
<UnitPrice>5.00</UnitPrice>
<ExtendUnitPrice>1.03</ExtendUnitPrice>
<UnitShippingCharge>1.03</UnitShippingCharge>
<ExtendShippingCharge>1.03</ExtendShippingCharge>
<Status>3</Status>
<StatusDescription>Canceled</StatusDescription>
<AutoRegWarranty>false</AutoRegWarranty>
</ItemInfo>
</ItemInfoList>
</OrderInfo>
</OrderInfoList>
</ResponseBody>
<Memo />
</NeweggAPIResponse>
示例: Json, Response
{
"NeweggAPIResponse": {
"IsSuccess": "true",
"SellerID": "V006",
"OperationType": "GetOrderInfoResponse",
"ResponseBody": {
"PageInfo": {
"TotalCount": "20",
"TotalPageCount": "20",
"PageSize": "10",
"PageIndex": "1"
},
"RequestID": "2PQBYWH4V68ZP",
"RequestDate": "2/21/2012 14:38:17",
"OrderInfoList": {
"OrderInfo": {
"SellerID": "V006",
"OrderNumber": "155738158",
"SellerOrderNumber": "2153930",
"InvoiceNumber": "0",
"OrderDownloaded": "false",
"OrderDate": "12/21/2011 1:47:24",
"OrderStatus": "4",
"OrderStatusDescription": "Voided",
"CustomerName": "Richard Chen",
"CustomerPhoneNumber": "626-277-1420",
"ShipToAddress1": "17708 Rowland St",
"ShipToAddress2": null,
"ShipToCityName": "Rowland Heights",
"ShipToStateCode": "DC",
"ShipToZipCode": "20001",
"ShipToCountryCode": "USA",
"ShipService": "Media Mail (7-14 business days)",
"ShipToFirstName": "Richard",
"ShipToLastName": "Chen",
"ShipToCompany": null,
"OrderItemAmount": "0.00",
"ShippingAmount": "3.00",
"DiscountAmount": "-5.00",
"RefundAmount": "0.00",
"RecyclingFeeAmount": "0.00",
"OrderTotalAmount": "8.00",
"OrderQty": "1",
"IsAutoVoid": "false",
"SalesChannel": 0,
"FulfillmentOption": 1,
"ItemInfoList": {
"ItemInfo": {
"SellerPartNumber": "Mike_A006_101478-151",
"NeweggItemNumber": "9SIA00607Y6664",
"MfrPartNumber": "Mike_A006_10114-151",
"UPCCode": "410997000004",
"Description": "Tungsten Ladies' Dome Ring w/ CZ",
"OrderedQty": "1",
"ShippedQty": "0",
"UnitPrice": "5.00",
"ExtendUnitPrice": "1.03",
"UnitShippingCharge": "1.03",
"ExtendShippingCharge": "1.03",
"Status": "3",
"StatusDescription": "Canceled"
"AutoRegWarranty": false
}
},
"PackageInfoList": null
}
}
},
"Memo": null
}
}
請求失敗錯誤資訊
常規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