获取订单列表报告

获取商家账户下有效订单列表。

相关URL

Newegg.com: https://api.newegg.com/marketplace/reportmgmt/report/result?sellerid={sellerid}&version={version}
Neweggbusiness.com: https://api.newegg.com/marketplace/b2b/reportmgmt/report/result?sellerid={sellerid}&version={version}
Newegg.ca: https://api.newegg.com/marketplace/can/reportmgmt/report/result?sellerid={sellerid}&version={version}

注:请确保您的请求URL全都是小写(除Seller ID)并且不能包含任何空格或者换行符。

参数

名称 是否必填? 描述
sellerid 您在新蛋商城的商家编号
version 有效版本:

版本 适用平台 结果
305 Neweggbusiness.com,Newegg.ca 返回结果中包含商家在使用SBN配送多渠道订单时的商家分配的订单编号。
306 Newegg.com 返回结果中包含商家在使用SBN配送多渠道订单时的商家分配的订单编号。
306 Neweggbusiness.com 返回结果包含RecyclingFeeAmount.
307 Newegg.com 返回结果中包含商品美国的消费税,增值税以及新蛋全球商品的关税总额。
309 所有 返回结果中包含相关RMA的换货的订单号。
309 Newegg.com 返回结果包含RecyclingFeeAmount.
310 Newegg.com 返回结果包含AutoRegWarranty.

相关请求信息

HTTP方式 是否需要认证? 请求格式 回复格式 频率限制
PUT 需要 XML,Json XML,Json 500 请求/小时

请求文件主体

属性 是否必填? 格式 描述
IssueUser String 请求发送者在Seller Portal上注册过的邮箱地址 。
系统只接受商家注册过的Seller Portal邮箱地址。如果为空,默认值为商家编号
OperationType String 固定值:OrderListReportRequest
RequestID String 新蛋分配的已提交的请求的编号
PageIndex Integer 当前页索引
PageSize Integer 一页返回的记录总数
每页最多100条。

Schema: GetReportRequest.xsd

示例:XML,Request

PUT https://api.newegg.com/marketplace/reportmgmt/report/result?sellerid={sellerid}&version={version}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml

<NeweggAPIRequest >
    <OperationType>OrderListReportRequest</OperationType>
    <RequestBody>
        <RequestID>2PQBYWH4V68ZP</RequestID>
        <PageInfo>
            <PageIndex>1</PageIndex>
            <PageSize>10</PageSize>
        </PageInfo>
    </RequestBody>
</NeweggAPIRequest>

示例:Json,Request

PUT https://api.newegg.com/marketplace/reportmgmt/report/result?sellerid={sellerid}&version={version}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json

{
    "OperationType": "OrderListReportRequest",
    "RequestBody": {
        "RequestID": "2PQBYWH4V68ZP",
        "PageInfo": {
            "PageSize": "10",
            "PageIndex": "1"
        }
    }
}

回复文件主体

属性 格式 描述
IsSuccess String 用于获取数据状态的操作
True:成功
False:失败
SellerID String 您的商家编号
OperationType String 固定值:GetOrderInfoResponse
RequestID String 新蛋为已提交的请求分配的编号
RequestDate String 您提交请求的时间(太平洋标准时间)
TotalCount Integer 记录总数
TotalPageCount Integer 总页数
PageIndex Integer 当前页索引
PageSize Integer 一页中的记录数
SellerID String 您的商家编号
OrderNumber Integer 新蛋订单编号
SellerOrderNumber String 卖家自定义订单编号
仅对使用SBN服务来运送多渠道订单的商家可用。
有效版本:305,306
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
PartiallyShipped(部分发货):订单状态代码 1
Shipped(已全部发货):订单状态代码 2
Invoiced(已出票):订单状态代码 3
Void (已作废订单):订单状态代码 4
CustomerName String 订单中的顾客姓名
CustomerPhoneNumber String 订单中的顾客电话
CustomerEmailAddress String 被加密的顾客邮箱地址,你可以通过这个地址联系顾客。
比如: gv6l0iwo4l7j1d@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)
注:以下运送服务表示该订单为新蛋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 订单商品总金额

  • Newegg.com 和 Newggbusiness.com所有金额都设置使用美元 (USD)
  • Newegg.ca所有金额都设置加元 (CAD)
ShippingAmount Decimal 订单运费总金额

  • Newegg.com 和 Newggbusiness.com所有金额都设置使用美元 (USD)
  • Newegg.ca所有金额都设置加元 (CAD)
DiscountAmount Decimal 订单折扣总金额

  • Newegg.com 和 Newggbusiness.com所有金额都设置使用美元 (USD)
  • Newegg.ca所有金额都设置加元 (CAD)
GSTorHSTAmount Decimal 订单的GST或HST(增值税/消费税)税收总额

  • Newegg.ca所有金额都设置加元 (CAD)

不适用于Newegg.com和Newggbusiness.com平台

PSTorQSTAmount Decimal 订单的PST(省销售税)(有些省称为QST)总额

  • Newegg.ca所有金额都设置加元 (CAD)

不适用于Newegg.com和Newggbusiness.com平台

OrderQty Integer 订单的商品总数
RefundAmount Decimal 订单的退款总金额

  • Newegg.com 和 Newggbusiness.com所有金额都设置使用美元 (USD)
  • Newegg.ca所有金额都设置加元 (CAD)
RecyclingFeeAmount Decimal 回收费是政府对新购买的电子产品、电池、新轮胎等征收的费用。这些费用用于支付这些产品的未来回收,因为其中许多产品含有有害物质。以下回收费用将添加到回收费用总额中:电子废物回收费、电池回收费、轮胎回收费、环保费。
有效版本:

  • Newegg.com: 309
  • Neweggbusiness.com: 306
SalesTax Decimal 订单的消费税

  • Newegg.com所有金额都设置使用美元(USD)

有效版本:307
不适用于Newggbusiness.com 和 Newegg.ca平台

VATTotal Decimal 国际增值税总额。

  • Neweg.com: 所有金额都设置使用美元(USD)

有效版本:307
不适用于Newggbusiness.com 和 Newegg.ca平台

DutyTotal Decimal 国际关税总额。

  • Neweg.com: 所有金额都设置使用美元(USD)

有效版本:307
不适用于Newggbusiness.com 和 Newegg.ca平台

OrderTotalAmount Decimal 订单总金额

  • Newegg.com 和 Newggbusiness.com所有金额都设置使用美元(USD)
  • Newegg.ca所有金额都设置为加币 (CAD)
IsAutoVoid String 如果订单被新蛋系统自动撤销,那么值为 true,否则,值为 false
SalesChannel Integer 订单销售渠道
0. Newegg order(新蛋订单)
1. Multi-channel order(多渠道订单)
2. Replacement order(换货订单)
有效版本:305,306,307,309
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 出现在顾客购物车中的最终商品单价

  • Newegg.com 和 Newggbusiness.com所有金额都设置使用美元(USD)
  • Newegg.ca所有金额都设置使用加元(CAD)
ExtendUnitPrice Decimal 商品的总价(商品的单位价格 x 订购个数)

  • Newegg.com 和 Newggbusiness.com所有金额都设置使用美元(USD)
  • Newegg.ca所有金额都设置使用加元(CAD)
ExtendShippingCharge Decimal 商品的总运费(商品单位运费 x 订购数量)

  • Newegg.com 和 Newggbusiness.com所有金额都设置使用美元(USD)
  • Newegg.ca所有金额都设置使用加元(CAD)
ExtendSalesTax Decimal 商品总消费税

  • Neweg.com: 所有金额都设置使用美元(USD)

有效版本:307
不适用于Newggbusiness.com 和 Newegg.ca平台

ExtendVAT Decimal 商品总增值税

  • Neweg.com: 所有金额都设置使用美元(USD)

有效版本:307
不适用于Newggbusiness.com 和 Newegg.ca平台

ExtendDuty Decimal 商品总关税

  • Neweg.com: 所有金额都设置使用美元(USD)

有效版本:307
不适用于Newggbusiness.com 和 Newegg.ca平台

Status Integer 有效值:
1: Unshipped 未发货
2: Shipped 已发货
3: Cancelled 已取消
StatusDescription String 有效值:
Unshipped(未发货): 订单状态代码 1
Shipped(已全部发货): 订单状态代码 2
Cancelled(已取消): 订单状态代码 3
AutoRegWarranty String 如果顾客在系统中启用了商品的自动注册保修,则该值为 true。 否则,该值为false。
如果此值为 true,则顾客邮箱地址将被取消加密。 否则,它仍然被加密。
有效版本:310
不适用于Newggbusiness.com 和 Newegg.ca平台
PackageType String 包裹类型:
已发货
未发货
ShipCarrier String 包裹的实际运输商
ShipService String 包裹的实际运输服务类型
TrackingNumber String 包裹的追踪号码
ShipDate String 包裹的运送时间(太平洋标准时间)
SellerPartNumber String 商家自定义的商品编号
MfrPartNumber String 厂商商品型号
ShippedQty String 商品已发货数量
Memo String 其他信息
ResponseDate String 回复时间(太平洋标准时间)

Schema: OrderListResponse.xsd

示例:XML,Response

<?xml version="1.0" encoding="utf-8"?>
<NeweggAPIResponse>
    <IsSuccess>true</IsSuccess>
    <SellerID>V006</SellerID>
    <OperationType>GetOrderInfoResponse</OperationType>
    <ResponseBody>
        <PageInfo>
            <TotalCount>20</TotalCount>
            <TotalPageCount>20</TotalPageCount>
            <PageSize>10</PageSize>
            <PageIndex>1</PageIndex>
        </PageInfo>
        <RequestID>2PQBYWH4V68ZP</RequestID>
        <RequestDate>2/21/2012 14:38:17</RequestDate>
        <OrderInfoList>
            <OrderInfo>
                <SellerID>V006</SellerID>
                <OrderNumber>155738158</OrderNumber>
                <SellerOrderNumber>2153930</SellerOrderNumber>
                <InvoiceNumber>0</InvoiceNumber>
                <OrderDownloaded>false</OrderDownloaded>
                <OrderDate>12/21/2011 1:47:24</OrderDate>
                <OrderStatus>4</OrderStatus>
                <OrderStatusDescription>Voided</OrderStatusDescription>
                <CustomerName>Richard Chen</CustomerName>
                <CustomerPhoneNumber>626-277-1420</CustomerPhoneNumber>
                <CustomerEmailAddress>cq3fw1aierwat94fm@marketplace.newegg.com</CustomerEmailAddress>
                <ShipToAddress1>17708 Rowland St</ShipToAddress1>
                <ShipToAddress2 />
                <ShipToCityName>Rowland Heights</ShipToCityName>
                <ShipToStateCode>DC</ShipToStateCode>
                <ShipToZipCode>20001</ShipToZipCode>
                <ShipToCountryCode>USA</ShipToCountryCode>
                <ShipService>Media Mail (7-14 business days)</ShipService>
                <ShipToFirstName>Richard</ShipToFirstName>
                <ShipToLastName>Chen</ShipToLastName>
                <ShipToCompany />
                <OrderItemAmount>0.00</OrderItemAmount>
                <ShippingAmount>3.00</ShippingAmount>
                <DiscountAmount>-5.00</DiscountAmount>
                <RefundAmount>0.00</RefundAmount>
                <RecyclingFeeAmount>0.00</RecyclingFeeAmount>
                <OrderTotalAmount>8.00</OrderTotalAmount>
                <OrderQty>1</OrderQty>
                <IsAutoVoid>false</IsAutoVoid>
                <SalesChannel>0</SalesChannel>
                <FulfillmentOption>1</FulfillmentOption>
                <ItemInfoList>
                    <ItemInfo>
                        <SellerPartNumber>Mike_A006_101478-151</SellerPartNumber>
                        <NeweggItemNumber>9SIA00607Y6664</NeweggItemNumber>
                        <MfrPartNumber>Mike_A006_10114-151</MfrPartNumber>
                        <UPCCode>410997000004</UPCCode>
                        <Description>Tungsten Ladies' Dome Ring w/ CZ</Description>
                        <OrderedQty>1</OrderedQty>
                        <ShippedQty>0</ShippedQty>
                        <UnitPrice>5.00</UnitPrice>
                        <ExtendUnitPrice>1.03</ExtendUnitPrice>
                        <UnitShippingCharge>1.03</UnitShippingCharge>
                        <ExtendShippingCharge>1.03</ExtendShippingCharge>
                        <Status>3</Status>
                        <StatusDescription>Canceled</StatusDescription>
                        <AutoRegWarranty>false</AutoRegWarranty>
                    </ItemInfo>
                </ItemInfoList>
            </OrderInfo>
        </OrderInfoList>
    </ResponseBody>
    <Memo />
</NeweggAPIResponse>

示例:Json,Response

{
    "NeweggAPIResponse": {
        "IsSuccess": "true",
        "SellerID": "V006",
        "OperationType": "GetOrderInfoResponse",
        "ResponseBody": {
            "PageInfo": {
                "TotalCount": "20",
                "TotalPageCount": "20",
                "PageSize": "10",
                "PageIndex": "1"
            },
            "RequestID": "2PQBYWH4V68ZP",
            "RequestDate": "2/21/2012 14:38:17",
            "OrderInfoList": {
                "OrderInfo": {
                    "SellerID": "V006",
                    "OrderNumber": "155738158",
                    "SellerOrderNumber": "2153930",
                    "InvoiceNumber": "0",
                    "OrderDownloaded": "false",
                    "OrderDate": "12/21/2011 1:47:24",
                    "OrderStatus": "4",
                    "OrderStatusDescription": "Voided",
                    "CustomerName": "Richard Chen",
                    "CustomerPhoneNumber": "626-277-1420",
                    "ShipToAddress1": "17708 Rowland St",
                    "ShipToAddress2": null,
                    "ShipToCityName": "Rowland Heights",
                    "ShipToStateCode": "DC",
                    "ShipToZipCode": "20001",
                    "ShipToCountryCode": "USA",
                    "ShipService": "Media Mail (7-14 business days)",
                    "ShipToFirstName": "Richard",
                    "ShipToLastName": "Chen",
                    "ShipToCompany": null,
                    "OrderItemAmount": "0.00",
                    "ShippingAmount": "3.00",
                    "DiscountAmount": "-5.00",
                    "RefundAmount": "0.00",
                    "RecyclingFeeAmount": "0.00",
                    "OrderTotalAmount": "8.00",
                    "OrderQty": "1",
                    "IsAutoVoid": "false",
                    "SalesChannel": 0,
                    "FulfillmentOption": 1,
                    "ItemInfoList": {
                        "ItemInfo": {
                            "SellerPartNumber": "Mike_A006_101478-151",
                            "NeweggItemNumber": "9SIA00607Y6664",
                            "MfrPartNumber": "Mike_A006_10114-151",
                            "UPCCode": "410997000004",
                            "Description": "Tungsten Ladies' Dome Ring w/ CZ",
                            "OrderedQty": "1",
                            "ShippedQty": "0",
                            "UnitPrice": "5.00",
                            "ExtendUnitPrice": "1.03",
                            "UnitShippingCharge": "1.03",
                            "ExtendShippingCharge": "1.03",
                            "Status": "3",
                            "StatusDescription": "Canceled"
                            "AutoRegWarranty": false
                        }
                    },
                    "PackageInfoList": null
                }
            }
        },
        "Memo": null
    }
}

请求失败错误信息

常规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