獲取訂單資訊
提交獲取該帳戶的訂單資訊請求。
相關URL
Newegg.com: https://api.newegg.com/marketplace/ordermgmt/order/orderinfo?sellerid={sellerid}&version={version}
註:請確保您的請求URL全都是小寫(除Seller ID)並且不能包含任何空格或者分行符號。
參數
| 名稱 | 是否必填? | 描述 |
| sellerid | 是 | 您在新蛋商城的商家編號 |
| version | 是 | 可用版本號:304、305、306、307、309、310 |
相關請求資訊
| HTTP方式 | 是否需要認證 | 請求格式 | 回覆格式 | 頻率限制 |
| PUT | 需要 | XML,Json | XML,Json | 1000 請求/小時 |
請求文件主體
| 屬性 | 是否必填? | 格式 | 描述 |
| IssueUser | 否 | String | 您註冊成為新蛋賣家帳戶的郵箱地址 |
| OperationType | 是 | String | 固定值:GetOrderInfoRequest |
| PageIndex | 否 | Integer | 當前頁索引,如果為空,默認使用1 |
| PageSize | 否 | Integer | 返回單頁的記錄數(最大值為每頁100條記錄),如果為空,默認使用100 |
| OrderNumber | 否 | Integer | 新蛋訂單編號 如果該欄位已指定訂單編號,其他查詢準則(請求條件)請忽略。 |
| SellerOrderNumber | 否 | String | 賣家自訂訂單編號 僅對使用SBN服務來運送其他管道訂單的商家可用。 如果沒有在OrderNumber欄位中指定新蛋訂單編號,則忽略其他搜索條件(請求條件),只對該欄位中指定賣家自訂訂單編號應用查詢結果。 可用版本:307 |
| Status | 否 | Integer | 有效值: 0. Unshipped(未發貨) 1. Partially Shipped (部分發貨) 2. Shipped(完全發貨) 3. Invoiced(交易完成) 4. Voided (訂單已作廢) 如果為空,返回以上所有狀態下的訂單 |
| OrderDownloaded | 否 | Integer | 有效值: 0. False(默認):包括已下載過的訂單 1. True:不包括已下載過的訂單 |
| Type | 否 | Integer | 有效值: 0. All (Default)(所有(默認)) 1. SBN(由新蛋配送) 2. SBS(由商家配送) 3. Multi-Channel(其他銷售管道) 4. NWS order |
| VoidSoon | 否 | Integer | 在24或48 小時後訂單會自動被作廢 有效值: 24 48 |
| OrderDateFrom | 否 | String | 訂單起始時間(太平洋標準時間)。請參考可接受的時間格式 |
| OrderDateTo | 否 | String | 訂單結束時間(太平洋標準時間)。請參考可接受的時間格式 |
| CountryCode | 否 | String | 該訂單客戶所在國家 只能使用國際標準的三位國家代碼。 完整國家代碼清單,請通過以下連結下載:International Country Guide |
| PremierOrder | 否 | String | 有效值: 0:全部(默認) 1:只包含Premier 訂單 2:排除Premier 訂單 |
Schema: GetOrderInfoRequest.xsd
示例:XML, Request
PUT https://api.newegg.com/marketplace/ordermgmt/order/orderinfo?sellerid={sellerid}&version={version}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
<NeweggAPIRequest>
<OperationType>GetOrderInfoRequest</OperationType>
<RequestBody>
<PageIndex>1</PageIndex>
<PageSize>10</PageSize>
<RequestCriteria>
<OrderNumberList>
<OrderNumber>159243598</OrderNumber>
<OrderNumber>41473642</OrderNumber>
</OrderNumberList>
<SellerOrderNumberList>
<SellerOrderNumber>SO159243598</SellerOrderNumber>
<SellerOrderNumber>SO41473642</SellerOrderNumber>
</SellerOrderNumberList>
<Status>1</Status>
<Type>1</Type>
<OrderDateFrom>2011-01-01 09:30:47</OrderDateFrom>
<OrderDateTo>2011-12-17 09:30:47</OrderDateTo>
<OrderDownloaded>0</OrderDownloaded>
<CountryCode>USA</CountryCode>
<PremierOrder>1</PremierOrder>
</RequestCriteria>
</RequestBody>
</NeweggAPIRequest>
示例:Json, Request
PUT https://api.newegg.com/marketplace/ordermgmt/order/orderinfo?sellerid={sellerid}&version={version}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"OperationType": "GetOrderInfoRequest",
"RequestBody": {
"PageIndex": "1",
"PageSize": "10",
"RequestCriteria": {
"OrderNumberList": {
"OrderNumber": [
"159243598",
"41473642"
]
},
"SellerOrderNumberList": {
"SellerOrderNumber": [
"SO159243598",
"SO41473642"
]
},
"Status": "1",
"Type": "1",
"OrderDateFrom": "2011-01-01 09:30:47",
"OrderDateTo": "2011-12-17 09:30:47",
"OrderDownloaded": 0,
"CountryCode": "USA",
"PremierOrder": "1"
}
}
}
回覆文件主體
| 屬性 | 格式 | 描述 |
| IsSuccess | String | 用於確認獲取訂單資訊的操作是否成功 返回值:True或者False |
| SellerID | String | 您的商家編號 |
| OperationType | String | 固定值:GetOrderInfoResponse |
| TotalCount | Integer | 記錄總數 |
| TotalPageCount | Integer | 總頁數 |
| PageSize | Integer | 單頁的記錄數 |
| PageIndex | Integer | 當前頁索引 |
| SellerID | String | 您的商家編號 |
| OrderNumber | Integer | 新蛋訂單編號 |
| SellerOrderNumber | String | 賣家自訂訂單編號 僅對使用SBN服務來運送其他管道訂單的商家可用。 可用版本:307 |
| InvoiceNumber | Integer | 發票編號 |
| OrderDownloaded | String | False:訂單還未被下載 True:訂單已被下載 當訂單已發貨,這個欄位將自動變為“True” |
| OrderDate | String | 訂單創建時間 |
| OrderStatus | Integer | 訂單狀態: 0. Unshipped(未發貨) 1. PartiallyShipped(部分發貨) 2. Shipped(已全部發貨) 3. Invoiced(交易完成) 4. Void (作廢訂單) |
| OrderStatusDescription | String | 訂單狀態描述: Unshipped(未發貨):訂單狀態碼 0. PartiallyShipped(部分發貨):訂單狀態碼 1. Shipped(已全部發貨):訂單狀態碼 2. Invoiced(交易完成):訂單狀態碼 3. Void(作廢訂單):訂單狀態碼 4. |
| CustomerName | String | 訂單中的顧客姓名 |
| CustomerPhoneNumber | String | 訂單中的顧客電話 |
| CustomerEmailAddress | String | 被加密的顧客郵箱地址,你可以通過這個地址聯繫顧客。 比如:gdv6l0viwo4l7j1d@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) 註:下列運送服務表示該訂單為 Newegg 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 | 訂單商品總金額 註:所有金額都設置使用美元(USD) |
| ShippingAmount | Decimal | 訂單運費總金額 註:所有金額都設置使用美元(USD) |
| DiscountAmount | Decimal | 訂單折扣總金額 註:所有金額都設置使用美元(USD) |
| OrderQty | Integer | 訂單的商品總數 |
| RefundAmount | Decimal | 訂單的退款總金額 註:所有金額都設置使用美元(USD) |
| SalesTax | Decimal | 訂單的消費稅 註:所有金額都設置使用美元(USD) 可用版本:305,306 |
| VATTotal | Decimal | 國際增值稅總額。 註:所有金額都設置使用美元(USD) 可用版本:306 |
| DutyTotal | Decimal | 國際關稅總額。 註:所有金額都設置使用美元(USD) 可用版本:306 |
| RecyclingFeeAmount | Decimal | 回收費是政府對新購買的電子產品、電池、新輪胎等徵收的費用。這些費用用於支付這些產品的未來回收,因為其中許多產品含有有害物質。以下回收費用將添加到回收費用總額中:電子廢物回收費、電池回收費、輪胎回收費、環保費。 可用版本:309 |
| OrderTotalAmount | Decimal | 訂單總金額 註:所有金額都設置使用美元(USD) |
| IsAutoVoid | String | 如果訂單被新蛋系統自動作廢,那麼值為 true,否則,值為 false |
| SalesChannel | Integer | 訂單銷售管道: 0:Newegg order(新蛋訂單) 1:Multi-channel order(其他銷售管道訂單) 2:Replacement order(換貨訂單) 3:NWS order |
| 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 | 出現在顧客購物車中的最終商品單價 註:所有金額都設置使用美元(USD) |
| ExtendUnitPrice | Decimal | 商品的總價(商品的單位價格 x 訂購個數) 註:所有金額都設置使用美元(USD) |
| ExtendShippingCharge | Decimal | 商品的總運費(商品單位運費 x 訂購數量) 註:所有金額都設置使用美元(USD) |
| ExtendSalesTax | Decimal | 商品總消費稅 註:所有金額都設置使用美元(USD) 可用版本:305,306 |
| ExtendVAT | Decimal | 商品總增值稅 註:所有金額都設置使用美元(USD) 可用版本:306 |
| ExtendDuty | Decimal | 商品總關稅 註:所有金額都設置使用美元(USD) 可用版本:306 |
| Status | Integer | 有效值: 1:Unshipped(未發貨) 2:Shipped(已發貨) 3:Cancelled(已取消) |
| StatusDescription | String | 有效值: Unshipped(未發貨):訂單狀態碼 1 Shipped(已全部發貨):訂單狀態碼 2 Cancelled(已取消):訂單狀態碼 3 |
| AutoRegWarranty | String | 如果顧客在系統中啟用了商品的自動註冊保固,則該值為 true。否則,該值為false。 如果此值為 true,則顧客郵箱地址將被取消加密。否則,它仍然被加密。 可用版本:310 |
| PackageType | String | 包裹類型: 已發貨 未發貨 |
| ShipCarrier | String | 包裹的實際運輸商 |
| ShipService | String | 包裹的實際運輸服務類型 |
| TrackingNumber | String | 包裹的追蹤號碼 |
| ShipDate | String | 包裹的運送時間(太平洋標準時間) |
| SellerPartNumber | String | 商家自訂的商品編號 |
| MfrPartNumber | String | 廠商商品型號 |
| ShippedQty | String | 商品已發貨數量 |
| Memo | String | 其他資訊 |
| ResponseDate | String | 回應時間(太平洋標準時間) |
Schema: GetOrderInfoResponse.xsd
示例:XML, Response
<?xml version="1.0" encoding="utf-8"?>
<NeweggAPIResponse>
<IsSuccess>true</IsSuccess>
<SellerID>A006</SellerID>
<OperationType>GetOrderInfoResponse</OperationType>
<ResponseBody>
<PageInfo>
<TotalCount>2</TotalCount>
<TotalPageCount>1</TotalPageCount>
<PageSize>10</PageSize>
<PageIndex>1</PageIndex>
</PageInfo>
<OrderInfoList>
<OrderInfo>
<SellerID>A006</SellerID>
<OrderNumber>41473642</OrderNumber>
<SellerOrderNumber>2153930</SellerOrderNumber>
<InvoiceNumber>0</InvoiceNumber>
<OrderDownloaded>true</OrderDownloaded>
<OrderDate>1/23/2012 7:33:05</OrderDate>
<OrderStatus>4</OrderStatus>
<OrderStatusDescription>Voided</OrderStatusDescription>
<CustomerName>WY SD</CustomerName>
<CustomerPhoneNumber>123-223-3223</CustomerPhoneNumber>
<CustomerEmailAddress>gdv6l0viwo4l7j1d@marketplace.newegg.com</CustomerEmailAddress>
<ShipToAddress1>149 Kenwood Dr</ShipToAddress1>
<ShipToAddress2 />
<ShipToCityName>Newcastle</ShipToCityName>
<ShipToStateCode>WY</ShipToStateCode>
<ShipToZipCode>82701</ShipToZipCode>
<ShipToCountryCode>UNITED STATES</ShipToCountryCode>
<ShipService>Media Mail (7-14 business days)</ShipService>
<ShipToFirstName>WY</ShipToFirstName>
<ShipToLastName>SD</ShipToLastName>
<ShipToCompany />
<OrderItemAmount>0</OrderItemAmount>
<ShippingAmount>0.00</ShippingAmount>
<DiscountAmount>0.00</DiscountAmount>
<RefundAmount>0</RefundAmount>
<SalesTax />
<VATTotal />
<DutyTotal />
<RecyclingFeeAmount />
<OrderTotalAmount>0.00</OrderTotalAmount>
<OrderQty>1</OrderQty>
<IsAutoVoid>true</IsAutoVoid>
<SalesChannel>0</SalesChannel>
<FulfillmentOption>1</FulfillmentOption>
<ItemInfoList>
<ItemInfo>
<SellerPartNumber>A00655467241</SellerPartNumber>
<NeweggItemNumber>9SIA0060823129</NeweggItemNumber>
<MfrPartNumber>55467241</MfrPartNumber>
<UPCCode />
<Description>test creation test item</Description>
<OrderedQty>1</OrderedQty>
<ShippedQty>0</ShippedQty>
<UnitPrice>1.00</UnitPrice>
<ExtendUnitPrice>1.03</ExtendUnitPrice>
<ExtendShippingCharge>1.03</ExtendShippingCharge>
<ExtendSalesTax />
<ExtendVAT />
<ExtendDuty />
<Status>3</Status>
<StatusDescription>Canceled</StatusDescription>
<AutoRegWarranty>false</AutoRegWarranty>
</ItemInfo>
</ItemInfoList>
<PackageInfoList />
</OrderInfo>
<OrderInfo>
<SellerID>A006</SellerID>
<OrderNumber>159243598</OrderNumber>
<SellerOrderNumber>2153930</SellerOrderNumber>
<InvoiceNumber>82961992</InvoiceNumber>
<OrderDownloaded>true</OrderDownloaded>
<OrderDate>1/18/2012 1:05:18</OrderDate>
<OrderStatus>3</OrderStatus>
<OrderStatusDescription>Invoiced</OrderStatusDescription>
<CustomerName>WY SD</CustomerName>
<CustomerPhoneNumber>123-223-3223</CustomerPhoneNumber>
<CustomerEmailAddress>gdv6l0viwo4l7j1d@marketplace.newegg.com</CustomerEmailAddress>
<ShipToAddress1>149 Kenwood Dr</ShipToAddress1>
<ShipToAddress2 />
<ShipToCityName>Newcastle</ShipToCityName>
<ShipToStateCode>WY</ShipToStateCode>
<ShipToZipCode>82701</ShipToZipCode>
<ShipToCountryCode>UNITED STATES</ShipToCountryCode>
<ShipService>Media Mail (7-14 business days)</ShipService>
<ShipToFirstName>WY</ShipToFirstName>
<ShipToLastName>SD</ShipToLastName>
<ShipToCompany />
<OrderItemAmount>2.00</OrderItemAmount>
<ShippingAmount>10.00</ShippingAmount>
<DiscountAmount>1.00</DiscountAmount>
<RefundAmount>0</RefundAmount>
<SalesTax />
<VATTotal />
<DutyTotal />
<RecyclingFeeAmount />
<OrderTotalAmount>11.00</OrderTotalAmount>
<OrderQty>2</OrderQty>
<IsAutoVoid>false</IsAutoVoid>
<SalesChannel>0</SalesChannel>
<FulfillmentOption>1</FulfillmentOption>
<ItemInfoList>
<ItemInfo>
<SellerPartNumber>A006ZX-35833</SellerPartNumber>
<NeweggItemNumber>9SIA0060845543</NeweggItemNumber>
<MfrPartNumber>ZX-35833</MfrPartNumber>
<UPCCode>431573000287</UPCCode>
<Description>GYRO Huge Metal Goliath 3.5CH Electric RTF RC Helicopter</Description>
<OrderedQty>2</OrderedQty>
<ShippedQty>2</ShippedQty>
<UnitPrice>1.00</UnitPrice>
<Status>2</Status>
<StatusDescription>Shipped</StatusDescription>
<AutoRegWarranty>false</AutoRegWarranty>
<ExtendUnitPrice>1.03</ExtendUnitPrice>
<ExtendShippingCharge>1.03</ExtendShippingCharge>
<ExtendSalesTax />
<ExtendVAT />
<ExtendDuty />
</ItemInfo>
</ItemInfoList>
<PackageInfoList>
<PackageInfo>
<PackageType>Shipped</PackageType>
<ShipCarrier>UPS</ShipCarrier>
<ShipService>342</ShipService>
<TrackingNumber>2342424</TrackingNumber>
<ShipDate>1/18/2012 16:59:15</ShipDate>
<ItemInfoList>
<ItemInfo>
<SellerPartNumber>A006ZX-35833</SellerPartNumber>
<MfrPartNumber>ZX-35833</MfrPartNumber>
<ShippedQty>2</ShippedQty>
</ItemInfo>
</ItemInfoList>
</PackageInfo>
</PackageInfoList>
</OrderInfo>
</OrderInfoList>
</ResponseBody>
<Memo />
<ResponseDate>2/22/2012 16:51:03</ResponseDate>
</NeweggAPIResponse>
示例:Json, Response
{
"ResponseDate": "01/05/2022 14:16:28",
"Memo": "",
"IsSuccess": true,
"OperationType": "GetOrderInfoResponse",
"SellerID": "A2EU",
"ResponseBody": {
"PageInfo": {
"TotalCount": 1,
"TotalPageCount": 1,
"PageIndex": 1,
"PageSize": 100
},
"OrderInfoList": [
{
"SellerID": "A2EU",
"OrderNumber": 511952652,
"InvoiceNumber": 0,
"OrderDownloaded": false,
"OrderDate": "11/10/2021 19:12:33",
"OrderStatus": 4,
"OrderStatusDescription": "Voided",
"CustomerName": "tesstordend testtordend",
"CustomerPhoneNumber": "523-534-5234",
"CustomerEmailAddress": "cusa.q7zw1u4erbgt9e@marketplace.newegg.com",
"ShipToAddress1": "17708 Rowland St",
"ShipToAddress2": "Test32",
"ShipToCityName": "Rowland Heights",
"ShipToStateCode": "CA",
"ShipToZipCode": "91748-1119",
"ShipToCountryCode": "UNITED STATES",
"ShipService": "Standard Shipping (5-7 business days)",
"ShipToFirstName": "tesstordend",
"ShipToLastName": "testtordend",
"ShipToCompany": "update 0012 test021",
"OrderItemAmount": 0.02,
"ShippingAmount": 0,
"DiscountAmount": 0,
"RefundAmount": 0,
"OrderTotalAmount": 0.02,
"OrderQty": 2,
"IsAutoVoid": false,
"SalesChannel": 0,
"FulfillmentOption": 0,
"ItemInfoList": [
{
"SellerPartNumber": "testYukiNew202110261526",
"NeweggItemNumber": "9SIA2EUGAT9779",
"MfrPartNumber": "202110261526",
"UPCCode": "",
"Description": "testYuki_new_Notebooks_2110261526",
"OrderedQty": 1,
"ShippedQty": 0,
"UnitPrice": 0.01,
"ExtendUnitPrice": 0.01,
"ExtendShippingCharge": 0,
"Status": 3,
"StatusDescription": "Cancelled"
"AutoRegWarranty": false
},
{
"SellerPartNumber": "TT20-PU-Cloud9",
"NeweggItemNumber": "9SIA2EUFJ97717",
"MfrPartNumber": "27155422019684",
"UPCCode": "",
"Description": "Secretlab TITAN 2020",
"OrderedQty": 1,
"ShippedQty": 0,
"UnitPrice": 0.01,
"ExtendUnitPrice": 0.01,
"ExtendShippingCharge": 0,
"Status": 3,
"StatusDescription": "Cancelled"
"AutoRegWarranty": false
}
],
"PackageInfoList": []
}
]
}
}
請求失敗錯誤資訊
常規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