提交订单列表报告
请求获取商家账户下有效订单列表。
相关URL
Newegg.com: https://api.newegg.com/marketplace/reportmgmt/report/submitrequest?sellerid={sellerid} Neweggbusiness.com: https://api.newegg.com/marketplace/b2b/reportmgmt/report/submitrequest?sellerid={sellerid} Newegg.ca: https://api.newegg.com/marketplace/can/reportmgmt/report/submitrequest?sellerid={sellerid}
注:请确保您的请求URL全都是小写(除Seller ID)并且不能包含任何空格或者换行符。
参数
名称 | 是否必填? | 描述 |
sellerid | 是 | 您在新蛋商城的商家编号 |
相关请求信息
HTTP方式 | 是否需要认证? | 请求格式 | 回复格式 | 频率限制 |
POST | 需要 | XML,Json | XML,Json | 100 请求/小时 |
请求文件主体
属性 | 是否必填? | 格式 | 描述 |
IssueUser | 否 | String | 请求发送者在Seller Portal上注册过的邮箱地址 。
系统只接受商家注册过的Seller Portal邮箱地址。如果为空,默认值为商家编号 |
OperationType | 是 | String | 固定值: OrderListReportRequest |
RequestType | 是 | String | 固定值:ORDER_LIST_REPORT |
KeywordsType | 是 | Integer | 有效值: 0:All (Default)(所有)(默认) 1: OrderNumber(订单编号) 2: InvoiceNumber(发票编号) 3: CustomerName(顾客姓名) 4: SellerPartNumber(商家商品编号) 5: NeweggItemNumber(新蛋商品编号) 6: CustomerPhoneNumber(顾客电话) 7: TitleDescription(标题描述) 8: Manufacturer(制造商) 9: SellerOrderNumber(商家自定义订单编号) 注:9: SellerOrderNumber(商家自定义订单编号)只可用于商家使用新蛋配送SBN配送多渠道订单时使用。 |
KeywordsValue | 否 | String | 指定KeywordsType(关键词类型)的关键词的值 如果KeywordsType(关键词类型)为0,系统将忽略该字段。 |
Status | 是 | Integer | 有效值: 0: Unshipped(未发货) 1: Partially Shipped(部分发货) 2: Shipped(已发货) 3: Invoiced(交易完成) 4: Voided(订单作废) |
Type | 否 | Integer | 有效值: 0: All (Default) 所有(默认) 1: SBN(新蛋配送) 2: SBS(商家配送) 3: Multi-Channel(多渠道) |
OrderDateFrom | 否 | String | 根据订单时间范围查询(太平洋标准时间)。请参考可接受时间格式 |
OrderDateTo | 否 | String | 根据订单时间范围查询(太平洋标准时间)。请参考可接受时间格式 |
VoidSoon | 否 | Integer | 订单将在24或48小时后自动删除 有效值: 24 48 |
OrderDownloaded | 否 | String | 有效值: False:包括已下载订单 True:不包括已下载订单 |
CountryCode | 否 | String | 订单所在国家。只接受国际标准3位国家编码。 完整国家代码列表,请通过以下链接下载:International Country Guide 不适用于Neweggbusiness.com 和Newegg.ca |
PremierOrder | 否 | String | 有效值: 0: All (Default) 所有(默认) 1: Premier Order Only 仅显示Premier订单 2: No Premier Order 不显示Premier订单 不适用于Neweggbusiness.com 和Newegg.ca |
Schema: OrderListRequest.xsd
示例:XML,Request
POST https://api.newegg.com/marketplace/reportmgmt/report/submitrequest?sellerid={sellerid} Authorization: 720ddc067f4d115bd544aff46bc75634 SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D Content-Type: application/xml Accept: application/xml <NeweggAPIRequest> <OperationType>OrderListReportRequest</OperationType> <RequestBody> <OrderReportCriteria> <RequestType>ORDER_LIST_REPORT</RequestType> <KeywordsType>0</KeywordsType> <KeywordsValue/> <Status>4</Status> <Type>0</Type> <OrderDateFrom>2011-12-07</OrderDateFrom> <OrderDateTo>2012-12-30</OrderDateTo> <OrderDownloaded>false</OrderDownloaded> <CountryCode>USA</CountryCode> <PremierOrder>1</PremierOrder> </OrderReportCriteria> </RequestBody> </NeweggAPIRequest>
示例:Json,Response
POST https://api.newegg.com/marketplace/reportmgmt/report/submitrequest?sellerid={sellerid} Authorization: 720ddc067f4d115bd544aff46bc75634 SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D Content-Type: application/json Accept: application/json { "OperationType": "OrderListReportRequest", "RequestBody": { "OrderReportCriteria": { "RequestType": "ORDER_LIST_REPORT", "KeywordsType": "0", "Status": "4", "Type": "0", "OrderDateFrom": "2011-12-07", "OrderDateTo": "2012-12-30", "OrderDownloaded": "false", "CountryCode": "USA", "PremierOrder": "1" } } }
回复文件主体
属性 | 格式 | 描述 |
IsSuccess | String | 获取数据状态操作: True:成功 False:失败 |
OperationType | String | 固定值:OrderListReportResponse |
SellerID | String | 您的商家编号 |
RequestId | String | 新蛋为已提交的请求分配的编号 |
RequestType | String | 固定值:ORDER_LIST_REPORT |
RequestDate | String | 数据提交的时间(太平洋标准时间) |
RequestSatus | String | 提交状态:
SUBMITTED 已提交(默认) |
Memo | String | 附加信息 |
Schema: SubmitReportResponse.xsd
示例:XML,Request
<NeweggAPIResponse> <IsSuccess>true</IsSuccess> <OperationType>OrderListReportResponse</OperationType> <SellerID>a001</SellerID> <ResponseBody> <ResponseList> <ResponseInfo> <RequestId>270Z8Y3SYIGQV</RequestId> <RequestType>ORDER_LIST_REPORT</RequestType> <RequestDate>07/12/2014 11:02:35</RequestDate> <RequestStatus>SUBMITTED</RequestStatus> </ResponseInfo> </ResponseList> </ResponseBody> </NeweggAPIResponse>
示例:Json,Response
{ "IsSuccess": true, "OperationType": "OrderListReportResponse", "SellerID": "a001", "ResponseBody": { "ResponseList": [ { "RequestId": "270Z8Y3SYIGQV", "RequestType": "ORDER_LIST_REPORT", "RequestDate": "07/12/2014 11:34:57", "RequestStatus": "SUBMITTED" } ] } }
请求失败错误信息
常规HTTP错误回复,请参考回复失败错误代码列表。
错误代码 | 描述 |
RP010 | Invalid Order Number.
无效的 Order Number |
RP018 | Invalid Settlement Date.
无效的 Settlement Date(结算时间) |
RP019 | The requestID cannot be null or empty.
请求编号(requestID)不能为空 |
RP020 | We are unable to process your request because one of the following search criteria is required: SettlementID, SettlementDate, or SettlementDateFrom and SettlementDateTo.
我们无法处理你的请求,因为你必须提供下列搜索条件中的一个:SettlementID,SettlementDate或 SettlementDateFrom 和 SettlementDateTo |
RP021 | Maximum item lookup cannot exceed 1000 for each request.
每个请求的商品检索数量最多不超过1000个 |
RP022 | Daily Inventory Report does not support multiple warehouse locations. For multiple warehouse locations, please use International Program – Daily Inventory Report.
每日库存报告不支持多个仓库所在地。若有多个仓库所在地,请使用新蛋全球化 – 每日库存报告章节内容. |
示例:XML,Request
<?xml version="1.0" encoding="utf-8"?> <Errors> <Error> <Code>RP018</Code> <Message>Invalid Settlement Date</Message> </Error> </Errors>
示例:Json,Response
[ { "Code": "RP018", "Message": "Invalid Settlement Date" } ]
更新日期:10/15/2018