Get Order Information

Retrieve order information by specified order number.

Resource URL

This operation is designed for  Newegg.ca:

Newegg.ca: https://api.newegg.com/marketplace/can/ordermgmt/order/orderinfo?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 version numbers:

304
305

Resource Information

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

Request Body

Attribute Required? Format Description
IssueUser No String Specify your eligible seller account (email
address) here.
OperationType Yes String Fixed value: GetOrderInfoRequest
PageIndex No Integer Current page index

If left blank, will use 1 as default.

PageSize No Integer Return records count in one page.
(Max is 100 per page)If left blank, will use 100 as default.
OrderNumber No Integer Newegg order number

Ignores other search conditions (request criteria) if order number specified this
field.

SellerOrderNumber No String The seller order number

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

If not specify Newegg order number in field “OrderNumber”, ignores other search conditions (request criteria) and only apply the query result on seller order numbers specified in this field.

Available version: 305

Status No Integer Available values:

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

If left blank, will return orders in all order status

OrderDownloaded No Integer Available values:

0: False (Default): include downloaded orders
1: True: do not include downloaded orders

Type No Integer Available values:

0: All (Default)
1: SBN (Shipped by Newegg)
2: SBS (Shipped by Seller)
3: Multi-Channel

VoidSoon No Integer The order will be auto voided after 24 or 48 hours.

Available values:

24
48

OrderDateFrom No String Order Date From (Pacific Standard Time)

Please refer to the Acceptable Date Format

OrderDateTo No String Order Date To (Pacific Standard Time)

Please refer to the Acceptable Date Format

Schema: GetOrderInfoRequest.xsd

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

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

Response Body

Attribute Format Description
IsSuccess String Used to identify the operation of Get Order Info is
successful True or False.
SellerID String Your seller ID
OperationType String Fixed value: GetOrderInfoResponse
TotalCount Integer Total number of records
TotalPageCount Integer Total page count
PageSize Integer How many records in a page
PageIndex Integer Current page index
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

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
ShipService String The order’s shipping service:

Shipped By Newegg
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-5business days)
International Two-Day Shipping(2business days)
International Economy Shipping(8-15business days)
International Standard Shipping(5-7business days)

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

Note: All amounts are set in CAN Dollars (CAD).

ShippingAmount Decimal Order’s shipping Amount

Note: All amounts are set in CAN Dollars (CAD).

DiscountAmount Decimal Order’s total discount amount

Note: All amounts are set in CAN Dollars (CAD).

GSTorHSTAmount Decimal Order’s GST or HST tax amount

Note: All amounts are set in CAN Dollars (CAD).

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

Note: All amounts are set in CAN Dollars (CAD).

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

Note: All amounts are set in CAN Dollars (CAD).

OrderTotalAmount Decimal Order’s total amount

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

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.

Note: All amounts are set in CAN Dollars (CAD).

ExtendUnitPrice Decimal Item’s total charge (Item Unit Price x Quantity Ordered)

Note: All amounts are set in CAN Dollars (CAD).

UnitShippingCharge Decimal Item’s shipping charge per unit
ExtendShippingCharge Decimal Item’s total shipping charge (Item Unit Shipping Price x Quantity Ordered)

Note: All amounts are set in CAN Dollars (CAD).

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)
ShipFromAddress String Ship from address
ShipFromAddress2 String Ship from address 2
ShipFromCity String Ship from city
ShipFromState String Ship from state
ShipFromZipCode String Ship from zip code
ShipFromName String Ship from name
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: GetOrderInfoResponse.xsd

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

Example: Json, Response

{
    "NeweggAPIResponse": {
        "IsSuccess": "true",
        "SellerID": "A006",
        "OperationType": "GetOrderInfoResponse",
        "ResponseBody": {
            "PageInfo": {
                "TotalCount": "2",
                "TotalPageCount": "1",
                "PageSize": "10",
                "PageIndex": "1"
            },
            "OrderInfoList": {
                "OrderInfo": [
                    {
                        "SellerID": "A006",
                        "OrderNumber": "41473642",
                        "SellerOrderNumber": "2153930",
                        "InvoiceNumber": "0",
                        "OrderDownloaded": "true",
                        "OrderDate": "1/23/2012 7:33:05",
                        "OrderStatus": "4",
                        "OrderStatusDescription": "Voided",
                        "CustomerName": "WY SD",
                        "CustomerPhoneNumber": "123-223-3223",
                        "CustomerEmailAddress": "gdv6l0viwo4l7j1d@marketplace.newegg.com",
                        "ShipToAddress1": "149 Kenwood Dr",
                        "ShipToAddress2": "",
                        "ShipToCityName": "Newcastle",
                        "ShipToStateCode": "WY",
                        "ShipToZipCode": "82701",
                        "ShipToCountryCode": "USA",
                        "ShipService": "Media Mail (7-14 business days)",
                        "ShipToFirstName": "WY",
                        "ShipToLastName": "SD",
                        "ShipToCompany": "",
                        "OrderItemAmount": "0",
                        "ShippingAmount": "0.00",
                        "DiscountAmount": "0.00",
                        "GSTorHSTAmount": "0.00",
                        "PSTorQSTAmount": "0.00",
                        "RefundAmount": "0",
                        "OrderTotalAmount": "0.00",
                        "OrderQty": "1",
                        "IsAutoVoid": "true",
                        "SalesChannel": "0",
                        "FulfillmentOption": "1",
                        "ItemInfoList": {
                            "ItemInfo": {
                                "SellerPartNumber": "A00655467241",
                                "NeweggItemNumber": "9SIA0060823129",
                                "MfrPartNumber": "55467241",
                                "UPCCode": "",
                                "Description": "test creation test item",
                                "OrderedQty": "1",
                                "ShippedQty": "0",
                                "UnitPrice": "1.00",
                                "ExtendUnitPrice": "1.03",
                                "UnitShippingCharge": "1.03",
                                "ExtendShippingCharge": "1.03",
                                "Status": "3",
                                "StatusDescription": "Canceled"
                            }
                        }
                    },
                    {
                        "SellerID": "A006",
                        "OrderNumber": "159243598",
                        "SellerOrderNumber": "2153930",
                        "InvoiceNumber": "82961992",
                        "OrderDownloaded": "true",
                        "OrderDate": "1/18/2012 1:05:18",
                        "OrderStatus": "3",
                        "OrderStatusDescription": "Invoiced",
                        "CustomerName": "WY SD",
                        "CustomerPhoneNumber": "123-223-3223",
                        "CustomerEmailAddress": "gdv6l0viwo4l7j1d@marketplace.newegg.com",
                        "ShipToAddress1": "149 Kenwood Dr",
                        "ShipToAddress2": "",
                        "ShipToCityName": "Newcastle",
                        "ShipToStateCode": "WY",
                        "ShipToZipCode": "82701",
                        "ShipToCountryCode": "USA",
                        "ShipService": "Media Mail (7-14 business days)",
                        "ShipToFirstName": "WY",
                        "ShipToLastName": "SD",
                        "ShipToCompany": "",
                        "OrderItemAmount": "2.00",
                        "ShippingAmount": "10.00",
                        "DiscountAmount": "1.00",
                        "GSTorHSTAmount": "0.00",
                        "PSTorQSTAmount": "0.00",
                        "RefundAmount": "0",
                        "OrderTotalAmount": "11.00",
                        "OrderQty": "2",
                        "IsAutoVoid": "false",
                        "SalesChannel": "0",
                        "FulfillmentOption": "1",
                        "ItemInfoList": {
                            "ItemInfo": {
                                "SellerPartNumber": "A006ZX-35833",
                                "NeweggItemNumber": "9SIA0060845543",
                                "MfrPartNumber": "ZX-35833",
                                "UPCCode": "431573000287",
                                "Description": "GYRO Huge Metal Goliath 3.5CH Electric RTF RC Helicopter",
                                "OrderedQty": "2",
                                "ShippedQty": "2",
                                "UnitPrice": "1.00",
                                "Status": "2",
                                "StatusDescription": "Shipped",
                                "ExtendUnitPrice": "1.03",
                                "UnitShippingCharge": "1.03",
                                "ExtendShippingCharge": "1.03"
                            }
                        },
                        "PackageInfoList": {
                            "PackageInfo": {
                                "PackageType": "Shipped",
                                "ShipCarrier": "UPS",
                                "ShipService": "342",
                                "TrackingNumber": "2342424",
                                "ShipDate": "1/18/2012 16:59:15",
                                "ShipFromAddress": "17708 rowland st",
                                "ShipFromAddress2": "this is test number",
                                "ShipFromCity": "RP",
                                "ShipFromState": "CA",
                                "ShipFromZipCode": "90001",
                                "ShipFromName": "USA",
                                "ItemInfoList": {
                                    "ItemInfo": {
                                        "SellerPartNumber": "A006ZX-35833",
                                        "MfrPartNumber": "ZX-35833",
                                        "ShippedQty": "2"
                                    }
                                }
                            }
                        }
                    }
                ]
            }
        },
        "Memo": "",
        "ResponseDate": "2/22/2012 16:51:03"
    }
}

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