获取订单信息
提交获取该账户的订单信息请求。
相关URL
该操作只适用于Newegg.ca。
Newegg.ca: https://api.newegg.com/marketplace/can/ordermgmt/order/orderinfo?sellerid={sellerid}&version={version}
注:请确保您的请求URL全都是小写(除Seller ID)并且不能包含任何空格或者换行符。
参数
名称 | 是否必填? | 描述 |
sellerid | 是 | 您在新蛋商城的商家编号 |
version | 是 | 可用版本号:304、305 |
相关请求信息
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字段中指定新蛋订单号,则忽略其他搜索条件(请求条件),只对该字段中指定卖家自定义订单号应用查询结果。 可用版本:305 |
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(多渠道) |
VoidSoon | 否 | Integer | 在24或48 小时后订单会自动被作废 有效值: 24 48 |
OrderDateFrom | 否 | String | 订单起始时间(太平洋标准时间)。请参考可接受的时间格式 |
OrderDateTo | 否 | String | 订单结束时间(太平洋标准时间)。请参考可接受的时间格式 |
Schema: GetOrderInfoRequest.xsd
示例:XML,Request
PUT https://api.newegg.com/marketplace/can/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> </RequestCriteria> </RequestBody> </NeweggAPIRequest>
示例:Json,Request
PUT https://api.newegg.com/marketplace/can/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 } } }
回复文件主体
属性 | 格式 | 描述 |
IsSuccess | String | 用于确认获取订单信息的操作是否成功 返回值:True或者False |
SellerID | String | 您的商家编号 |
OperationType | String | 固定值:GetOrderInfoResponse |
TotalCount | Integer | 记录总数 |
TotalPageCount | Integer | 总页数 |
PageSize | Integer | 一页中的记录数 |
PageIndex | Integer | 当前页索引 |
SellerID | String | 您的商家编号 |
OrderNumber | Integer | 新蛋订单编号 |
SellerOrderNumber | String | 卖家自定义订单编号 仅对使用新蛋配送SBN服务来运送多渠道订单的商家可用。 可用版本:305 |
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 Partially Shipped(部分发货):订单状态代码 1 Shipped(已全部发货):订单状态代码 2 Invoiced(交易完成):订单状态代码 3 Void(作废订单):订单状态代码 4 |
CustomerName | String | 订单中的顾客姓名 |
CustomerPhoneNumber | String | 订单中的顾客电话 |
CustomerEmailAddress | String | 被加密的顾客邮箱地址,你可以通过这个地址联系顾客。 比如: gdv6l0viwo4l7j1d@marketplace.newegg.com |
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) Standard Shipping (5-15 business days) |
ShipToFirstName | String | 收货人名 |
ShipToLastName | String | 收货人姓 |
ShipToCompany | String | 收货地所在公司 |
OrderItemAmount | Decimal | 订单商品总金额 注:所有金额都设置使用加元(CAD) |
ShippingAmount | Decimal | 订单运费总金额 注:所有金额都设置使用加元(CAD) |
DiscountAmount | Decimal | 订单折扣总金额 注:所有金额都设置使用加元(CAD) |
GSTorHSTAmount | Decimal | 订单的GST或HST(增值税/消费税)税收总额 注:所有金额都设置使用加元(CAD) |
PSTorQSTAmount | Decimal | 订单的PST(省销售税)(有些省称为QST)总额 注:所有金额都设置使用加元(CAD) |
EHFAmount | Decimal | 回收费是政府对新购买的电子产品、电池、新轮胎等征收的费用。这些费用用于支付这些产品的未来回收,因为其中许多产品含有有害物质。 以下回收费用将添加到回收费用总额中:电子废物回收费、电池回收费、轮胎回收费、环保费。 |
OrderQty | Integer | 订单的商品总数 |
RefundAmount | Decimal | 订单的退款总金额 注:所有金额都设置使用加元(CAD) |
OrderTotalAmount | Decimal | 订单总金额 注:所有金额都设置使用加元(CAD) |
IsAutoVoid | String | 如果订单被新蛋系统自动撤销,那么值为 true,否则,值 为 false |
SalesChannel | Integer | 订单销售渠道: 0. Newegg order(新蛋订单) 1. Multi-channel order(多渠道订单) 2. Replacement 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 | 出现在顾客购物车中的最终商品单价 注:所有金额都设置使用加元(CAD) |
ExtendUnitPrice | Decimal | 商品的总价(商品的单位价格 x 订购个数) 注:所有金额都设置使用加元(CAD) |
UnitShippingCharge | Decimal | 每个商品的运费 |
ExtendShippingCharge | Decimal | 商品的总运费(商品单位运费 x 订购数量) 注:所有金额都设置使用加元(CAD) |
Status | Integer | 有效值: 1: Unshipped(未发货) 2: Shipped(已发货) 3: Cancelled(已取消) |
StatusDescription | String | 有效值: Unshipped(未发货):订单状态代码 1 Shipped(已全部发货):订单状态代码 2 Cancelled(已取消):订单状态代码 3 |
PackageType | String | 包裹类型: 已发货 未发货 |
ShipCarrier | String | 包裹的实际运输商 |
ShipService | String | 包裹的实际运输服务类型 |
TrackingNumber | String | 包裹的追踪号码 |
ShipDate | String | 包裹的运送时间(太平洋标准时间) |
ShipFromAddress | String | 发货地址 |
ShipFromAddress2 | String | 发货地址2 |
ShipFromCity | String | 发货地所在城市 |
ShipFromState | String | 发货地所在州 |
ShipFromZipCode | String | 发货地邮编 |
ShipFromName | 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>USA</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> <GSTorHSTAmount>0.00</GSTorHSTAmount> <PSTorQSTAmount>0.00</PSTorQSTAmount> <RefundAmount>0</RefundAmount> <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> <UnitShippingCharge>1.03</UnitShippingCharge > <ExtendShippingCharge>1.03</ExtendShippingCharge> <Status>3</Status> <StatusDescription>Canceled</StatusDescription> </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>USA</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> <GSTorHSTAmount>0.00</GSTorHSTAmount> <PSTorQSTAmount>0.00</PSTorQSTAmount> <RefundAmount>0</RefundAmount> <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> <ExtendUnitPrice>1.03</ExtendUnitPrice> <UnitShippingCharge>1.03</UnitShippingCharge> <ExtendShippingCharge>1.03</ExtendShippingCharge> </ItemInfo> </ItemInfoList> <PackageInfoList> <PackageInfo> <PackageType>Shipped</PackageType> <ShipCarrier>UPS</ShipCarrier> <ShipService>342</ShipService> <TrackingNumber>2342424</TrackingNumber> <ShipDate>1/18/2012 16:59:15</ShipDate> <ShipFromAddress>17708 rowland st</ShipFromAddress> <ShipFromAddress2>this is test number</ShipFromAddress2> <ShipFromCity>RP</ShipFromCity> <ShipFromState>CA</ShipFromState> <ShipFromZipCode>90001</ShipFromZipCode> <ShipFromName>USA</ShipFromName> <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" }, { "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" } ], "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