Submit Item Basic Info Report

Request an export of a seller’s item basic information (title, category, dimensions, images, variety, etc.) for all items in Newegg’s catalog. Unlike Item Lookup, the result is delivered as a downloadable report file rather than inline data.

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

Resource Information

Note: This submission is picked up and processed by a scheduled background job (not processed synchronously), so the practical throughput limit is governed by the job’s batch size rather than a per-request quota. Confirm the current gateway-level threshold with the API team before relying on a specific number.

Request Body

Example: XML, Request

POST https://api.newegg.com/marketplace/reportmgmt/report/submitrequest?sellerid={sellerid}
Authorization: {your_authorization_key}
SecretKey: {your_secret_key}
Content-Type: application/xml
Accept: application/xml

<NeweggAPIRequest>
  <IssueUser>a001</IssueUser>
  <OperationType>ItemBasicInfoReportRequest</OperationType>
  <RequestBody>
    <ItemBasicInfoReportCriteria>
      <RequestType>ITEM_BASIC_INFO_REPORT</RequestType>
      <Status>1</Status>
      <FileType>CSV</FileType>
    </ItemBasicInfoReportCriteria>
  </RequestBody>
</NeweggAPIRequest>

Example: Json, Request

POST https://api.newegg.com/marketplace/reportmgmt/report/submitrequest?sellerid={sellerid}
Authorization: {your_authorization_key}
SecretKey: {your_secret_key}
Content-Type: application/json
Accept: application/json

{
  "IssueUser": "a001",
  "OperationType": "ItemBasicInfoReportRequest",
  "RequestBody": {
    "ItemBasicInfoReportCriteria": {
      "RequestType": "ITEM_BASIC_INFO_REPORT",
      "Status": 1,
      "FileType": "CSV"
    }
  }
}

Response Body

Example: XML, Response

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

Example: Json, Response

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

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>CE003</Code>
    <Message>Json parsing error.</Message>
  </Error>
</Errors>

Example: Json, Response

[
  {
    "Code": "CE003",
    "Message": "Json parsing error."
  }
]