Submit Item Lookup Report

Request a list of  item’s if available in Newegg’s catalog.

Resource URL

Newegg.com: https://api.newegg.com/marketplace/reportmgmt/report/submitrequest?sellerid={sellerid}
Neweggbusiness.com: https://api.newegg.com/marketplace/b2b/reportmgmt/report/submitrequest?sellerid={sellerid}
Newegg.ca: https://api.newegg.com/marketplace/can/reportmgmt/report/submitrequest?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 30 requests per min per client

Request Body

Attribute Required? Format Description
OperationType Yes String Fixed value: OrderListReportRequest
UPC Yes, if ManufacturerPartNumber not provided String UPC/EAN code for item search
Condition No Integer Available values:

1: New
2: Refurbished
3: Used – Like New
4: Used – Very Good
5: Used – Good
6: Used – Acceptable

ManufacturerName Yes, if UPC not provided String Manufacturer name for item search
ManufacturerPartNumber Yes, if UPC not provided String Manufacturer part number for item search
PacksOrSets No Integer Identify the package count for item search

Schema: ItemLookupRequest.xsd

Example: XML, Request

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

<NeweggAPIRequest>
    <OperationType>ItemLookupRequest</OperationType>
    <RequestBody>
        <RequestCriteria>
            <Item>
                <UPC>20140711101111</UPC>
                <Condition>1</Condition>
                <ManufacturerName>q-see</ManufacturerName>
                <ManufacturerPartNumber>canmfpn20140711101</ManufacturerPartNumber>
                <PacksOrSets>1</PacksOrSets>
            </Item>
            <Item>
                <UPC>20140711101111</UPC>
                <Condition>1</Condition>
                <ManufacturerName>q-see</ManufacturerName>
                <ManufacturerPartNumber>canmfpn20140711101</ManufacturerPartNumber>
            </Item>
            <Item>
                <Condition>1</Condition>
                <ManufacturerName>q-see</ManufacturerName>
                <ManufacturerPartNumber>canmfpn20140711101</ManufacturerPartNumber>
                <PacksOrSets>4</PacksOrSets>
            </Item>
            <Item>
                <ManufacturerName>q-see</ManufacturerName>
                <ManufacturerPartNumber>canmfpn20140711101</ManufacturerPartNumber>
            </Item>
        </RequestCriteria>
    </RequestBody>
</NeweggAPIRequest>

Example: Json, Request

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

{
    "OperationType": "ItemLookupRequest",
    "RequestBody": {
        "RequestCriteria": {
            "Item": [
                {
                    "UPC": "20140711101111",
                    "Condition": "1",
                    "ManufacturerName": "q-see",
                    "ManufacturerPartNumber": "canmfpn20140711101"
                },
                {
                    "UPC": "20140711101111",
                    "Condition": "1",
                    "ManufacturerName": "q-see",
                    "ManufacturerPartNumber": "canmfpn20140711101"
                },
                {
                    "Condition": "1",
                    "ManufacturerName": "q-see",
                    "ManufacturerPartNumber": "canmfpn20140711101"
                },
                {
                    "ManufacturerName": "q-see",
                    "ManufacturerPartNumber": "canmfpn20140711101"
                }
            ]
        }
    }
}

Response Body

Attribute Format Description
IsSuccess String Get feed status operation:

True: Successful
False: Not successful

OperationType String Fixed value: ItemLookupReportResponse
SellerID String Your seller ID
RequestId String Newegg’s assigned ID for submitted request
RequestType String Fixed value: ITEM_LOOKUP
RequestDate String The date when the feed was submitted (Pacific Standard Time)
RequestSatus String Status of the submission:

SUBMITTED (Default)

Memo String Additional information

Schema: SubmitReportResponse.xsd

Example: XML, Response

<NeweggAPIResponse>
    <IsSuccess>true</IsSuccess>
    <OperationType>ItemLookupReportResponse</OperationType>
    <SellerID>a001</SellerID>
    <ResponseBody>
        <ResponseList>
            <ResponseInfo>
                <RequestId>270Z8Y3SYIGQV</RequestId>
                <RequestType>ITEM_LOOKUP</RequestType>
                <RequestDate>07/12/2014 11:02:35</RequestDate>
                <RequestStatus>SUBMITTED</RequestStatus>
            </ResponseInfo>
        </ResponseList>
    </ResponseBody>
</NeweggAPIResponse>

Example: Json, Response

{
    "IsSuccess": true,
    "OperationType": "ItemLookupReportResponse",
    "SellerID": "a001",
    "ResponseBody": {
        "ResponseList": [
            {
                "RequestId": "270Z8Y3SYIGQV",
                "RequestType": "ITEM_LOOKUP",
                "RequestDate": "07/12/2014 11:34:57",
                "RequestStatus": "SUBMITTED"
            }
        ]
    }
}

Request Failure Errors

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

Error Code Description
RP010 Invalid Order Number.
RP018 Invalid Settlement Date.
RP019 The requestID cannot be null or empty.
RP020 We are unable to process your request because one of the following search criteria is required: SettlementID, SettlementDate, or SettlementDateFrom and SettlementDateTo.
RP021 Maximum item lookup cannot exceed 1000 for each request.
RP022 Daily Inventory Report does not support multiple warehouse locations. For multiple warehouse locations, please
use International Program – Daily Inventory Report.

Example: XML, Response

<?xml version="1.0" encoding="utf-8"?>
<Errors>
    <Error>
        <Code>RP018</Code>
        <Message>Invalid Settlement Date</Message>
    </Error>
</Errors>

Example: Json, Response

{
    "Code": "RP018",
    "Message": "Invalid Settlement Date"
}

Last updated: October 15, 2018