获取额外订单信息
检索新蛋全球订单的额外信息,包括:
- 某些国家额外的订单要求
- 由新蛋国际配送服务(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