Get Order List Report

Get available orders from seller’s account.

Resource 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}

Note: Please make sure your request URL is all in lower case (except for Seller ID) and cannot contain any blank spaces or line breaks.

Parameters

Name Required? Description
sellerid Yes Your seller ID on Newegg Marketplace
version Yes Available versions:

Version Available Platform Impact
305 Neweggbusiness.com, Newegg.ca Response includes the Seller Order Number assigned by seller when using for SBN to fulfill multi-channel orders.
306 Newegg.com Response includes the Seller Order Number assigned by seller when using for SBN to fulfill multi-channel orders.
307 Newegg.com Response includes SalesTax amount for U.S., VAT and Duty amount for Newegg Global.
309 All Response includes the replacement order #s for related RMAs.

Resource Information

HTTP Method Authentication? Request Formats Response Formats Rate Limited?
PUT Required XML, Json XML, Json 30 requests per min per client

Request Body

Attribute Required? Format Description
IssueUser No String Issuer’s registered Seller Portal email address. System will only accept Seller’s
registered Seller Portal email addresses.If left blank, default value will be Seller ID.
OperationType Yes String Fixed values: OrderListReportRequest
RequestID Yes String Newegg’s assigned ID for submitted request
PageIndex Yes Integer Current page index
PageSize Yes Integer Return records count in one page

Max is 100 per page

Schema: GetReportRequest.xsd

Example: 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>

Example: 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"
        }
    }
}

Response Body

Attribute Format Description
IsSuccess String Get feed status operation:

True: Successful
False: Not successful

SellerID String Your seller ID
OperationType String Fixed value: GetOrderInfoResponse
RequestID String Newegg’s assigned ID for submitted request
RequestDate String Your request date time (Pacific Standard Time)
TotalCount Integer Total number of records
TotalPageCount Integer Total page count
PageIndex Integer Current page index
PageSize Integer How many records in a page
SellerID String Seller ID
OrderNumber Integer Newegg Order number
SellerOrderNumber String Order number, assigned by seller.

This is available for sellers using SBN (Shipped by
Newegg) to fulfill multi-channel orders.

Available version: 305, 306

InvoiceNumber Integer The Invoice Number
OrderDownloaded String False: Order has not been downloaded yet.
True: Order downloaded already.When order is shipped, this field will automatically become “True”.
OrderDate String Create date
OrderStatus Integer The Order Status:

0: Unshipped
1: Partially Shipped
2: Shipped
3: Invoiced
4: Voided

OrderStatusDescription String The Order Status Description

Unshipped for order status code: 0
Partially Shipped for order status code: 1
Shipped for order status code: 2
Invoiced for order status code: 3
Voided for order status code: 4

CustomerName String Customer name
CustomerPhoneNumber String Phone number of customer
CustomerEmailAddress String The masked customer email address, you can reach to the customer through this email address.

For example:
gdv6l0viwo4l7j1d@marketplace.newegg.com

ShipToAddress1 String Shipped to address of customer
ShipToAddress2 String Shipped to address line 2 of customer
ShipToCityName String Shipped to city name
ShipToStateCode String Shipped to state
ShipToZipCode String Shipped to zip code
ShipToCountryCode String Shipped to country, i.e. United Kingdom
ShipService String The order’s shipping service:

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)
Newegg Premier 3 Days
Newegg Premier 2 Days
Newegg Premier Next Day

Note: That the following shipping services are for indicating Newegg Premier orders, you should ship the order as soon as the service required.  Please contact datafeeds@newegg.com for more detail regarding Premier Seller Enrollment Program.

ShipToFirstName String Ship to first name
ShipToLastName String Ship to last name
ShipToCompany String Ship to company
OrderItemAmount Decimal Order’s item(s) total amount

  • Newegg.com and Newggbusiness.com, all amounts are set in U.S. Dollars (USD)
  • Newegg.ca, all amounts are set in Can Dollars (CAD)
ShippingAmount Decimal Order’s shipping Amount

  • Newegg.com and Newggbusiness.com, all amounts are set in U.S. Dollars (USD)
  • Newegg.ca, all amounts are set in Can Dollars (CAD)
DiscountAmount Decimal Order’s total discount amount

  • Newegg.com and Newggbusiness.com, all amounts are set in U.S. Dollars (USD)
  • Newegg.ca, all amounts are set in Can Dollars (CAD)
GSTorHSTAmount Decimal The order’s GST or HST tax amount

  • Newegg.ca, all amounts are set in Can Dollars (CAD)

Not available for Newegg.com and Newggbusiness.com

PSTorQSTAmount Decimal The order’s PST(some province calls QST) amount

  • Newegg.ca, all amounts are set in Can Dollars (CAD)

Not available for Newegg.com and Newggbusiness.com

OrderQty integer Order’s total item quantity
RefundAmount Decimal The order’s refund amount

  • Newegg.com and Newggbusiness.com, all amounts are set in U.S. Dollars (USD)
  • Newegg.ca, all amounts are set in Can Dollars (CAD)
SalesTax Decimal Order’s sales tax

  • Newegg.com, all amounts are set in U.S. Dollars (USD)

Available version:  307

Not available for Newggbusiness.com and Newegg.ca

VATTotal Decimal International Value Additional Tax Total

  • Newegg.com, all amounts are set in U.S. Dollars (USD)

Available version:  307

Not available for Newggbusiness.com and Newegg.ca

DutyTotal Decimal International Duty Total

  • Newegg.com, all amounts are set in U.S. Dollars (USD)

Available version:  307

Not available for Newggbusiness.com and Newegg.ca

OrderTotalAmount Decimal Order’s total amount

  • Newegg.com and Newggbusiness.com, all amounts are set in U.S. Dollars (USD)
  • Newegg.ca, all amounts are set in Can Dollars (CAD)
IsAutoVoid String If an order was auto voided by Newegg system, then
the value is true. Otherwise, value is false.
SalesChannel Integer Order sales channel:

0: Newegg order
1: Multi-channel order
2: Replacement order

Available version:  305, 306, 307, 309

FulfillmentOption integer Order fulfillment option:

0: Ship by seller
1: Ship by Newegg

SellerPartNumber String Seller part number of item
NeweggItemNumber String Newegg number of item
MfrPartNumber String Manufacture part number of item
UPCCode String UPC code of item
Description String Web short title of item
OrderedQty Integer Ordered quantity of item
ShippedQty integer Shipped quantity of item
UnitPrice Decimal The final price per unit of the item appearing in customer’s shopping cart.

  • Newegg.com and Newggbusiness.com, all amounts are set in U.S. Dollars (USD)
  • Newegg.ca, all amounts are set in Can Dollars (CAD)
ExtendUnitPrice Decimal Item’s total charge (Item Unit Price x Quantity Ordered)

  • Newegg.com and Newggbusiness.com, all amounts are set in U.S. Dollars (USD)
  • Newegg.ca, all amounts are set in Can Dollars (CAD)
ExtendShippingCharge Decimal Item’s total shipping charge (Item Unit Shipping Price x Quantity Ordered)

  • Newegg.com and Newggbusiness.com, all amounts are set in U.S. Dollars (USD)
  • Newegg.ca, all amounts are set in Can Dollars (CAD)
ExtendSalesTax Decimal Item’s total sales tax charge

  • Newegg.com, all amounts are set in U.S. Dollars (USD)

Available version:  307

Not available for Newggbusiness.com and Newegg.ca

ExtendVAT Decimal Item’s total Value Additional Tax charge

  • Newegg.com, all amounts are set in U.S. Dollars (USD)

Available version:  307

Not available for Newggbusiness.com and Newegg.ca

ExtendDuty Decimal Item’s total Duty charge

  • Newegg.com, all amounts are set in U.S. Dollars (USD)

Available version:  307

Not available for Newggbusiness.com and Newegg.ca

Status Integer Available values:

1: Unshipped
2: Shipped
3: Cancelled

StatusDescription String Available values:

Unshipped for status code: 1
Shipped for status code: 2
Cancelled for status code: 3

PackageType String The package type:

Shipped
Unshipped

ShipCarrier String Package’s actual ship Carrier
ShipService String Package’s actual ship Service
TrackingNumber String Package’s tracking number
ShipDate String Package’s ship date (Pacific Standard Time)
SellerPartNumber String Seller part number of item
MfrPartNumber String Manufacture part number of item
ShippedQty String Shipped quantity of item
Memo String Other information
ResponseDate String Response date (Pacific Standard Time)

Schema: OrderListResponse.xsd

Example: 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>
                <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>
                    </ItemInfo>
                </ItemInfoList>
            </OrderInfo>
        </OrderInfoList>
    </ResponseBody>
    <Memo />
</NeweggAPIResponse>

Example: 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",
                    "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"
                        }
                    },
                    "PackageInfoList": null
                }
            }
        },
        "Memo": null
    }
}

Request Failure Errors

For common HTTP error responses, please refer to Failed Response Error Code List.

Example: XML, Response

<?xml version="1.0" encoding="utf-8"?>
<Errors>
    <Error>
        <Code>CE001</Code>
        <Message>SellerID cannot be null or empty</Message>
    </Error>
</Errors>

Example: Json, Response

{
    "Code": "CE001",
    "Message": "SellerID cannot be null or empty"
}

Last updated: October 15, 2018