獲取額外訂單資訊
檢索新蛋全球訂單的額外資訊,包括:
- 某些國家額外的訂單要求
- 由新蛋國際配送服務(NISP)配送的訂單的原始收件人資訊
- 海外客戶輸入的原始收件人資訊
相關URL
Newegg.com: https://api.newegg.com/marketplace/ordermgmt/order/addorderinfo?sellerid={sellerid}
註:請確保您的請求URL全都是小寫(除Seller ID)並且不能包含任何空格或者分行符號。
參數
| 名稱 | 是否必填? | 描述 |
| sellerid | 是 | 您在新蛋商城的商家編號 |
相關請求資訊
| HTTP方式 | 是否需要認證 | 請求格式 | 回覆格式 | 頻率限制 |
| POST | 需要 | XML,Json | XML,Json | 10,000 請求/小時 |
請求文件主體
| 屬性 | 是否必填? | 格式 | 描述 |
| IssueUser | 否 | String | 您註冊成為新蛋賣家帳戶的郵箱地址 |
| OperationType | 是 | String | 固定值:GetAddOrderInfoRequest |
| PageIndex | 否 | Integer | 當前頁索引。如果為空,默認使用1 |
| PageSize | 否 | Integer | 返回單頁的記錄數(最大值為每頁100條記錄)。 如果為空,默認使用100 |
| OrderNumber | 否 | Integer | 新蛋訂單編號 如果該欄位已指定訂單編號,其他查詢準則(請求條件)請忽略。 |
| Status | 否 | Integer | 有效值: 0. Unshipped(未發貨) 1. Partially Shipped(部分發貨) 2. Shipped(完全發貨) 3. Invoiced(交易完成) 4. Voided(訂單已作廢) 5. All (所有) 如果為空,返回未發貨訂單狀態 |
| OrderDownloaded | 否 | Integer | 有效值: 0. False(默認):包括已下載過的訂單 1. True:不包括已下載過的訂單 |
| Type | 否 | Integer | 有效值: 0. All (Default)(所有(默認)) 1. SBN(由新蛋配送) 2. SBS(由商家配送) 3. NISP(新蛋國際配送服務) |
| VoidSoon | 否 | Integer | 在24或48 小時後訂單會自動被作廢 有效值: 24 48 |
| OrderDateFrom | 否 | String | 訂單起始時間(太平洋標準時間)。請參考可接受的時間格式 |
| OrderDateTo | 否 | String | 訂單結束時間(太平洋標準時間)。請參考可接受的時間格式 |
| CountryCode | 否 | String | 該訂單客戶所在國家。只能使用國際標準的三位國家代碼。 完整國家代碼清單,請通過以下連結下載:International Country Guide |
Schema: GetAddOrderInfoRequest.xsd
示例:XML, Request
POST https://api.newegg.com/marketplace/ordermgmt/order/addorderinfo?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
<NeweggAPIRequest>
<OperationType>GetAddOrderInfoRequest</OperationType>
<RequestBody>
<PageIndex>1</PageIndex>
<PageSize>10</PageSize>
<RequestCriteria>
<OrderNumberList>
<OrderNumber>159243598</OrderNumber>
<OrderNumber>41473642</OrderNumber>
</OrderNumberList>
<Status>0</Status>
<Type>1</Type>
<OrderDateFrom>2017-01-01 09:30:47</OrderDateFrom>
<OrderDateTo>2017-12-17 09:30:47</OrderDateTo>
<OrderDownloaded>0</OrderDownloaded>
<CountryCode>BRA</CountryCode>
</RequestCriteria>
</RequestBody>
</NeweggAPIRequest>
示例:Json, Request
POST https://api.newegg.com/marketplace/ordermgmt/order/addorderinfo?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"OperationType": "GetAddOrderInfoRequest",
"RequestBody": {
"PageIndex": "1",
"PageSize": "10",
"RequestCriteria": {
"OrderNumberList": {
"OrderNumber": [
"159243598",
"41473642"
]
},
"Status": "1",
"Type": "1",
"OrderDateFrom": "2017-01-01 09:30:47",
"OrderDateTo": "2017-12-17 09:30:47",
"OrderDownloaded": 0,
"CountryCode": "BRA"
}
}
}
回覆文件主體
| 屬性 | 格式 | 描述 |
| IsSuccess | String | 用來確認獲取額外訂單資訊的操作是否成功 返回 true 或 false |
| SellerID | String | 你的商家編號 |
| OperationType | String | 固定值:GetAddOrderInfoResponse |
| TotalCount | Integer | 記錄總數 |
| TotalPageCount | Integer | 總頁數 |
| PageSize | Integer | 單頁的記錄數 |
| PageIndex | Integer | 當前頁索引 |
| OrderNumber | Integer | 新蛋訂單編號 |
| RecipientIDType | String | 由顧客提供的個人身份證明文件。某些國家在清關過程中可能會用到該文件。 該欄位有效值為: 巴西:CPF、CNPJ、护照 中國:身份證 沙烏地阿拉伯:國民身份證,居民身份證 |
| RecipientIDNumber | String | 與指定的 ID Type 相關聯的身份資訊編碼 |
| OrderDownloaded | String | False:訂單還沒有被下載。 True:訂單已被下載。 當訂單為已發貨,該欄位自動更新為True。 |
| NISPOriFirstName | String | 收件人名 |
| NISPOriLastName | String | 收件人姓 |
| NISPOriCompanyName | String | 收件人公司名稱 |
| NISPOriAddress1 | String | 收件人地址 1 |
| NISPOriAddress2 | String | 收件人地址 2 |
| NISPOriCity | String | 收件人所在城市 |
| NISPOriState | String | 收件人所在州 |
| NISPOriZipCode | String | 收件人所在地郵編 |
| NISPOriCountryCode | String | 收件人所在國家 |
| NISPOriPhoneNumber | String | 收件人聯繫電話 |
| OriginalFirstName | String | 收件人名,顧客輸入的原始資訊 |
| OriginalLastName | String | 收件人姓,顧客輸入的原始資訊 |
| OriginalCompanyName | String | 收件人公司名稱,顧客輸入的原始資訊 |
| OriginalAddress1 | String | 收件人位址 1,顧客輸入的原始資訊 |
| OriginalAddress2 | String | 收件人位址 2,顧客輸入的原始資訊 |
| OriginalCity | String | 收件人所在城市,顧客輸入的原始資訊 |
| OriginalState | String | 收件人所在州,顧客輸入的原始資訊 |
| OriginalZipCode | String | 收件人所在地郵編,顧客輸入的原始資訊 |
| OriginalCountryCode | String | 收件人所在國家,顧客輸入的原始資訊 |
| OriginalPhoneNumber | String | 收件人聯繫電話,顧客輸入的原始資訊 |
| AddInfo1 | String | 附加資訊,可能包含更多有關新蛋國際訂單的資訊或有 助於你的新蛋商城運營的資訊資料。該欄位是可選字 段,當前沒有資料。如有新的資訊,我們會通知商家。 |
| AddInfo2 | String | |
| AddInfo3 | String | |
| TaxDutyTypeChina | String | 對運往中國的物品適用的稅收和關稅規則。可用選項:
|
| ImportTypeChina | String | 計算運往中國的物品的稅額訂單進口類型,可用選項:
|
| IDCopyFront | String | 下載身份證影本圖片的直接連結,正面 |
| IDCopyBack | String | 下載身份證影本圖片的直接連結,反面 |
| Memo | String | 其他資訊 |
| ResponseDate | String | 回應時間 (太平洋標準時間) |
Schema: GetAddOrderInfoResponse.xsd
示例:XML, Response
<?xml version="1.0" encoding="utf-8"?>
<NeweggAPIResponse>
<IsSuccess>true</IsSuccess>
<SellerID>A006</SellerID>
<OperationType>GetAddOrderInfoResponse</OperationType>
<ResponseBody>
<PageInfo>
<TotalCount>2</TotalCount>
<TotalPageCount>1</TotalPageCount>
<PageSize>10</PageSize>
<PageIndex>1</PageIndex>
</PageInfo>
<AddOrderInfoList>
<AddOrderInfo>
<OrderNumber>41473642</OrderNumber>
<RecipientIDType>Identification Card</RecipientIDType>
<RecipientIDNumber>511522198812036655</RecipientIDNumber>
<NISPOriginalInfo>
<NISPOriFirstName>Guang</NISPOriFirstName>
<NISPOriLastName>Li</NISPOriLastName>
<NISPOriCompanyName />
<NISPOriAddress1>149 Tianfu Blvd</NISPOriAddress1>
<NISPOriAddress2 />
<NISPOriCity>Chengdu</NISPOriCity>
<NISPOriState>Sichuan</NISPOriState>
<NISPOriZipCode>64410</NISPOriZipCode>
<NISPOriCountryCode>CHINA</NISPOriCountryCode>
<NISPOriPhoneNumber>13812345678</NISPOriPhoneNumber>
</NISPOriginalInfo>
<OriginalInputInfo>
<OriginalFirstName>广</OriginalFirstName>
<OriginalLastName>李</OriginalLastName>
<OriginalCompanyName />
<OriginalAddress1>天府大道149 号</OriginalAddress1>
<OriginalAddress2 />
<OriginalCity>成都</OriginalCity>
<OriginalState>四川</OriginalState>
<OriginalZipCode>64410</OriginalZipCode>
<OriginalCountryCode>CHINA</OriginalCountryCode>
<OriginalPhoneNumber>13812345678</OriginalPhoneNumber>
</OriginalInputInfo>
<TaxDutyTypeChina>ATI</TaxDutyTypeChina>
<ImportTypeChina>EE</ImportTypeChina>
<IDCopyFront>https://ec-apis.tthigo.com/dfisupload/realname/images/Front_testCopy.jpg</IDCopyFront>
<IDCopyBack>https://ec-apis.tthigo.com/dfisupload/realname/images/Back_testCopy.jpg</IDCopyBack>
</AddOrderInfo>
</AddOrderInfoList>
</ResponseBody>
<Memo />
<ResponseDate>09/01/2018 16:51:03</ResponseDate>
</NeweggAPIResponse>
示例:Json, Response
{
"IsSuccess": "true",
"SellerID": "A006",
"OperationType": "GetAddOrderInfoResponse",
"ResponseBody": {
"PageInfo": {
"TotalCount": "2",
"TotalPageCount": "1",
"PageSize": "10",
"PageIndex": "1"
},
"AddOrderInfoList": {
"AddOrderInfo": {
"OrderNumber": "41473642",
"RecipientIDType": "Identification Card",
"RecipientIDNumber": "511522198812036655",
"NISPOriginalInfo": {
"NISPOriFirstName": "Guang",
"NISPOriLastName": "Li",
"NISPOriCompanyName": "",
"NISPOriAddress1": "149 Tianfu Blvd",
"NISPOriAddress2": "",
"NISPOriCity": "Chengdu",
"NISPOriState": "Sichuan",
"NISPOriZipCode": "64410",
"NISPOriCountryCode": "CHINA",
"NISPOriPhoneNumber": "13812345678"
},
"OriginalInputInfo": {
"OriginalFirstName": "广",
"OriginalLastName": "李",
"OriginalCompanyName": "",
"OriginalAddress1": "天府大道149 号",
"OriginalAddress2": "",
"OriginalCity": "成都",
"OriginalState": "四川",
"OriginalZipCode": "64410",
"OriginalCountryCode": "CHINA",
"OriginalPhoneNumber": "13812345678"
},
"TaxDutyTypeChina": "ATI",
"ImportTypeChina": "EE",
"IDCopyFront": "https://ec-apis.tthigo.com/dfisupload/realname/images/Front_testCopy.jpg",
"IDCopyBack": "https://ec-apis.tthigo.com/dfisupload/realname/images/Back_testCopy.jpg"
}
}
},
"Memo": "",
"ResponseDate": "09/01/2018 16:51:03"
}
請求失敗錯誤資訊
常規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"
}
]
更新日期:07/24/2019