Get Item Lookup Report

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

Resource URL

Newegg.com: https://api.newegg.com/marketplace/reportmgmt/report/result?sellerid={sellerid}
Neweggbusiness.com: https://api.newegg.com/marketplace/b2b/reportmgmt/report/result?sellerid={sellerid}
Newegg.ca: https://api.newegg.com/marketplace/can/reportmgmt/report/result?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?
PUT Required XML, Json XML, Json 500 request per hour

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: ItemLookupRequest
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}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml

<NeweggAPIRequest >
    <OperationType>ItemLookupRequest</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}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json

{
    "OperationType": "ItemLookupRequest",
    "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: ItemLookupResponse
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
NeweggItemNumber String Newegg’s assigned number for item
UPC String UPC/EAN code for item
Condition String Available values:

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

Note: Used only available for Newegg.com
PacksOrSets Integer Identify the package count of this product

Note: All products in a pack or set will have matching item and condition.
ManufacturerName Integer Manufacture name of item
ManufacturerPartNumber String Manufacture part number of item
WebsiteShortTitle String Website short title of item
Note String Error message for the request (e.g. No match found)
ResponseDate String Response date (Pacific Standard Time)

 
GroupID Int Variant group unique identifier
(e.g., “2110011803”)
Options Array Variant attribute array
Name String Variant attribute name
(e.g.,  “Color”)
Value String Variant attribute value
(e.g., “Red”)

Schema: ItemLookupResponse.xsd

Example: XML, Response

<NeweggAPIResponse>
  <IsSuccess>true</IsSuccess>
  <OperationType>ItemLookupResponse</OperationType>
  <SellerID>A006</SellerID>
  <ResponseBody>
    <PageInfo>
      <TotalCount>3</TotalCount>
      <TotalPageCount>1</TotalPageCount>
      <PageIndex>1</PageIndex>
      <PageSize>100</PageSize>
    </PageInfo>
    <RequestID>27YV8H1HHRFLZ</RequestID>
    <RequestDate>02/16/2023 14:00:03</RequestDate>
    <ItemList>
      <Item>
        <Condition>1</Condition>
        <ManufacturerName><![CDATA[Plantronics]]></ManufacturerName>
        <ManufacturerPartNumber><![CDATA[203500-105]]></ManufacturerPartNumber>
        <WebsiteShortTitle></WebsiteShortTitle>
         <Variety>
            <GroupID>204142502</GroupID>
            <Options>
               <ItemVarietyOption>
                    <Name>Color</Name>
                    <Value>Blue</Value>
               </ItemVarietyOption>
            </Options>
         </Variety>
        <Note>No match found.</Note>
      </Item>
      <Item>
        <NeweggItemNumber>0G6-0008-003W9</NeweggItemNumber>
        <UPC>017229164116</UPC>
        <Condition>1</Condition>
        <PacksOrSets>1</PacksOrSets>
        <ManufacturerName><![CDATA[Plantronics]]></ManufacturerName>
        <ManufacturerPartNumber><![CDATA[206110-101]]></ManufacturerPartNumber>
        <WebsiteShortTitle><![CDATA[Plantronics Voyager 5200 UC Earset - Wireless - Bluetooth - 98.4 ft6.80 kHz - Earbud, Over-the-ear - Monaural - In-ear - Noise Reduction, Echo Cancelling Microphone - Noise Canceling]]></WebsiteShortTitle>
       <Variety>  
           <GroupID>55552502</GroupID>
           <Options>
              <ItemVarietyOption>
                  <Name>Color</Name>
                  <Value>Red</Value>
              </ItemVarietyOption>
           </Options>>
      </Variety>
      </Item>
      <Item>
        <NeweggItemNumber>1B4-01S8-00011</NeweggItemNumber>
        <UPC>897337053751</UPC>
        <Condition>1</Condition>
        <PacksOrSets>1</PacksOrSets>
        <ManufacturerName><![CDATA[PrimoChill]]></ManufacturerName>
        <ManufacturerPartNumber><![CDATA[PC-V32K-NVG]]></ManufacturerPartNumber>
        <WebsiteShortTitle><![CDATA[PrimoChill Vue Premix - UV NV Green]]></WebsiteShortTitle>
       <Variety>
          <GroupID>30230202</GroupID>
          <Options>
              <ItemVarietyOption>
                   <Name>Color</Name>
                   <Value>Brown</Value>
              </ItemVarietyOption>
          </Options>>
      </Variety>
      </Item>
    </ItemList>
</ResponseBody>
<ResponseDate>02/16/2023 14:06:04</ResponseDate>
</NeweggAPIResponse>

Example: Json, Response

{
  "ResponseDate": "02/16/2023 14:06:04",
  "IsSuccess": true,
  "OperationType": "ItemLookupResponse",
  "SellerID": " A006",
  "ResponseBody": {
    "PageInfo": {
      "TotalCount": 3,
      "TotalPageCount": 1,
      "PageIndex": 1,
      "PageSize": 100
    },
    "RequestID": "27YV8H1HHRFLZ",
    "RequestDate": "02/16/2023 14:00:03",
    "ItemList": [
    {
        "ManufacturerName": "Plantronics",
        "ManufacturerPartNumber": "203500-105",
        "Condition": 1,
        "Note": "No match found."
      },  
    {
        "NeweggItemNumber": "0G6-0008-003W9",
        "UPC": "017229164116",
        "Condition": 1,
        "PacksOrSets": 1,
        "ManufacturerName": "Plantronics",
        "ManufacturerPartNumber": "206110-101",
        "WebsiteShortTitle": "Plantronics Voyager 5200 UC Earset - Wireless - Bluetooth - 98.4 ft6.80 kHz - Earbud, Over-the-ear - Monaural - In-ear - Noise Reduction, Echo Cancelling Microphone - Noise Canceling"
         "Variety": {
             "GroupID": 204142502,
             "Options": [
                 {
                     "Name": "Color",
                     "Value": "Blue"
                 }
             ]
         }
      },
    {
        "NeweggItemNumber": "1B4-01S8-00011",
        "UPC": "897337053751",
        "Condition": 1,
        "PacksOrSets": 1,
        "ManufacturerName": "PrimoChill",
        "ManufacturerPartNumber": "PC-V32K-NVG",
        "WebsiteShortTitle": "PrimoChill Vue Premix - UV NV Green"
      },
    ]
  }
}

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