Get Additional Order Information

Retrieve the additional information for Newegg Global order including:

  • Additional order requirement for certain countries.
  • The original recipient information for orders shipped by NISP service.
  • The original recipient information inputted by international customers.

Resource URL

Newegg.com: https://api.newegg.com/marketplace/ordermgmt/order/addorderinfo?sellerid={sellerid}

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

Resource Information

HTTP Method Authentication? Request Formats Response Formats Rate Limited?
POST 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: GetAddOrderInfoRequest
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.

Status No Integer Available values:

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

If left blank, will return orders in Unshipped 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: NISP

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

CountryCode No String The country for your orders.

Only the ISO standard 3-digit codes are accepted.  To review the complete list of available values, please download the following:

Schema: GetAddOrderInfoRequest.xsd

Example: XML, Request

POST https://api.newegg.com/marketplace/ordermgmt/order/addorderinfo?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml

<NeweggAPIRequest>
    <OperationType>GetAddOrderInfoRequest</OperationType>
    <RequestBody>
        <PageIndex>1</PageIndex>
        <PageSize>10</PageSize>
        <RequestCriteria>
            <OrderNumberList>
                <OrderNumber>159243598</OrderNumber>
                <OrderNumber>41473642</OrderNumber>
            </OrderNumberList>
            <Status>0</Status>
            <Type>1</Type>
            <OrderDateFrom>2017-01-01 09:30:47</OrderDateFrom>
            <OrderDateTo>2017-12-17 09:30:47</OrderDateTo>
            <OrderDownloaded>0</OrderDownloaded>
            <CountryCode>BRA</CountryCode>
        </RequestCriteria>
    </RequestBody>
</NeweggAPIRequest>

Example: Json, Request

POST https://api.newegg.com/marketplace/ordermgmt/order/addorderinfo?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json

{
    "OperationType": "GetAddOrderInfoRequest",
    "RequestBody": {
        "PageIndex": "1",
        "PageSize": "10",
        "RequestCriteria": {
            "OrderNumberList": {
                "OrderNumber": [
                    "159243598",
                    "41473642"
                ]
            },
            "Status": "1",
            "Type": "1",
            "OrderDateFrom": "2017-01-01 09:30:47",
            "OrderDateTo": "2017-12-17 09:30:47",
            "OrderDownloaded": 0,
            "CountryCode": "BRA"
        }
    }
}

Response Body

Attribute Format Description
IsSuccess String Used to identify the operation of Get Additional Order Info is
successful: true or false
SellerID String Your seller ID
OperationType String Fixed value: GetAddOrderInfoResponse
TotalCount Integer Total number of records
TotalPageCount Integer Total page count
PageSize Integer How many records in a page.
PageIndex Integer Current page index
OrderNumber Integer Newegg Order number
RecipientIDType String A personal identity document that provided by customer. This document may be used for customs clearance for certain countries.

Currently available values: CPF, CNPJ, Passport.It is required for orders from Brazil.

RecipientIDNumber String The value of the ID associated with the document identified under
“ID Type”.
OrderDownloaded String False: Order has not been downloaded yet.
True: Order downloaded already.When order is shipped, this field will automatically become “True”.
NISPOriFirstName String First Name of the original recipient
NISPOriLastName String Last Name of the original recipient
NISPOriCompanyName String Company name of the original recipient
NISPOriAddress1 String Address line 1 of the original recipient
NISPOriAddress2 String Address line 2 of the original recipient
NISPOriCity String City of the original recipient
NISPOriState String State of the original recipient
NISPOriZipCode String Zipcode of the original recipient
NISPOriCountryCode String Destination country of the original recipient
NISPOriPhoneNumber String Contact phone number of the original recipient
OriginalFirstName String First Name of the recipient, in the original format inputted by customer
OriginalLastName String Last Name of the recipient, in the original format inputted by customer
OriginalCompanyName String Company name of the recipient, in the original format inputted by customer
OriginalAddress1 String Address line 1 of the recipient, in the original format inputted by customer
OriginalAddress2 String Address line 2 of the recipient, in the original format inputted by customer
OriginalCity String City of the recipient, in the original format inputted by customer
OriginalState String State of the recipient, in the original format inputted by customer
OriginalZipCode String Zipcode of the recipient, in the original format inputted by customer
OriginalCountryCode String Destination country of the recipient, in the original format inputted by customer
OriginalPhoneNumber String Contact phone number of the recipient, in the original format inputted by customer
AddInfo1 String Additional information may include further information related to Newegg Global orders or data that may providing additional information that are beneficial to your operation in Newegg Marketplace. It is optional and currently no data is available. We will notify sellers once they are available.
AddInfo2 String
AddInfo3 String
Memo String Other information
ResponseDate String Response date (Pacific Standard Time)

Schema: GetAddOrderInfoResponse.xsd

Example: XML, Response

<?xml version="1.0" encoding="utf-8"?>
<NeweggAPIResponse>
    <IsSuccess>true</IsSuccess>
    <SellerID>A006</SellerID>
    <OperationType>GetAddOrderInfoResponse</OperationType>
    <ResponseBody>
        <PageInfo>
            <TotalCount>2</TotalCount>
            <TotalPageCount>1</TotalPageCount>
            <PageSize>10</PageSize>
            <PageIndex>1</PageIndex>
        </PageInfo>
        <AddOrderInfoList>
            <AddOrderInfo>
                <OrderNumber>41473642</OrderNumber>
                <RecipientIDType>ID</RecipientIDType>
                <RecipientIDNumber>511522198812036655</RecipientIDNumber>
                <NISPOriginalInfo>
                    <NISPOriFirstName>Guang</NISPOriFirstName>
                    <NISPOriLastName>Li</NISPOriLastName>
                    <NISPOriCompanyName />
                    <NISPOriAddress1>149 Tianfu Blvd</NISPOriAddress1>
                    <NISPOriAddress2 />
                    <NISPOriCity>Chengdu</NISPOriCity>
                    <NISPOriState>Sichuan</NISPOriState>
                    <NISPOriZipCode>64410</NISPOriZipCode>
                    <NISPOriCountryCode>CHINA</NISPOriCountryCode>
                    <NISPOriPhoneNumber>13812345678</NISPOriPhoneNumber>
                </NISPOriginalInfo>
                <OriginalInputInfo>
                    <OriginalFirstName>广</OriginalFirstName>
                    <OriginalLastName>李</OriginalLastName>
                    <OriginalCompanyName />
                    <OriginalAddress1>天府大道149 号</OriginalAddress1>
                    <OriginalAddress2 />
                    <OriginalCity>成都</OriginalCity>
                    <OriginalState>四川</OriginalState>
                    <OriginalZipCode>64410</OriginalZipCode>
                    <OriginalCountryCode>CHINA</OriginalCountryCode>
                    <OriginalPhoneNumber>13812345678</OriginalPhoneNumber>
                </OriginalInputInfo>
                <AddInfo1/>
                <AddInfo2/>
                <AddInfo3/>
            </AddOrderInfo>
        </AddOrderInfoList>
    </ResponseBody>
    <Memo />
    <ResponseDate>09/01/2018 16:51:03</ResponseDate>
</NeweggAPIResponse>

Example: Json, Response

{
    "IsSuccess": "true",
    "SellerID": "A006",
    "OperationType": "GetAddOrderInfoResponse",
    "ResponseBody": {
        "PageInfo": {
            "TotalCount": "2",
            "TotalPageCount": "1",
            "PageSize": "10",
            "PageIndex": "1"
        },
        "AddOrderInfoList": {
            "AddOrderInfo": {
                "OrderNumber": "41473642",
                "RecipientIDType": "ID",
                "RecipientIDNumber": "511522198812036655",
                "NISPOriginalInfo": {
                    "NISPOriFirstName": "Guang",
                    "NISPOriLastName": "Li",
                    "NISPOriCompanyName": [],
                    "NISPOriAddress1": "149 Tianfu Blvd",
                    "NISPOriAddress2": [],
                    "NISPOriCity": "Chengdu",
                    "NISPOriState": "Sichuan",
                    "NISPOriZipCode": "64410",
                    "NISPOriCountryCode": "CHINA",
                    "NISPOriPhoneNumber": "13812345678"
                },
                "OriginalInputInfo": {
                    "OriginalFirstName": "广",
                    "OriginalLastName": "李",
                    "OriginalCompanyName": [],
                    "OriginalAddress1": "天府大道149 号",
                    "OriginalAddress2": [],
                    "OriginalCity": "成都",
                    "OriginalState": "四川",
                    "OriginalZipCode": "64410",
                    "OriginalCountryCode": "CHINA",
                    "OriginalPhoneNumber": "13812345678"
                },
                "AddInfo1": [],
                "AddInfo2": [],
                "AddInfo3": []
            }
        }
    },
    "Memo": [],
    "ResponseDate": "9/01/2018 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: April 1, 2019