Product List

Query related product information according to the specified item Title, Active Status, and Date Range.

Resource URL

Newegg.com: https://api.newegg.com/marketplace/sponsoredmgmt/campaign/product/search?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 Json Json 1000 request per hour

Request Body

Attribute Required? Format Description
sellerId Yes String Your seller ID on Newegg Marketplace
countryCode
Yes String The ISO standard 3-digit codes of the country
campaignNumber Yes Integer The campaign identifier Number
groupNumber Yes Integer The ad group identifier
searchKeywordType No Enum Available values:

  • GROUP_NAME — fuzzy matching, keyword only supports a single
  • GROUP_NUM  — exact match, keyword input group number is separated by commas to support batch query
keyword No String Restricts results to campaigns with the specified name.
activeStatus No Enum Restricts results to resources with the state within the specified.

Available values:

  • Active:    Query the data of Processing, Delivering, Out of budget status
  • Inactive: Query the data of Inactive and Ended states
countries Yes String[] The ISO standard 3-digit codes of the country
pageInfo pageIndex No Integer Current page index (Default is 1)
pageSize No Integer How many record(s) in a page (Max 100 per page)
sortField No String the field name of Sort, The default is InDate,
sortType No String Default Desc, support Desc, Asc two sorting methods

Example: Json, Request

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

{
  "sellerId": "AN9A",
  "countryCode": "USA",
  "campaignNumber": 1168452,
  "groupNumber": 1168453,
  "searchKeywordType": null,
  "keyword": null,
  "activeStatus": null,
  "countries": [
    "USA"
  ],
  "pageInfo": {
    "pageIndex": 1,
    "pageSize": 4,
    "sortField": "InDate",
    "sortType": "Desc"
  }
}

Response Body

Attribute
Format
Description
campaignNumber Integer The campaign identifier
campaignName String The campaign Name
groupNumber Integer The ad group identifier
groupName String The ad group Name
itemNumber String Newegg number of an item
itemTitle String Web title of an item
countryCode String The ISO standard 3-digit codes of the country
sellingPrice Decimal The actual selling price
primaryImgUrl String Primary Image URL
sellerPartNumber String Seller Part#
sellerName String Seller Name
activeStatus Enum Available values:

  • Active
  • Inactive
status String The Campaign Status Description

Available values:

  • Pending
  • Delivering
  • Processing
  • Out of budget
  • Inactive
  • Ended
declineReason String The campaign declined reason
totalRows Integer The number of the records

Example: Json, Response

{
  "rows": [
    {
      "campaignNumber": 1166512,
      "campaignName": "Campaign-2022-05-22 11:19:12",
      "groupNumber": 1166513,
      "groupName": "starnonntek",
      "itemNumber": "9SIB55YGFF8214",
      "itemTitle": "Mechanic Game Keyboard with Real RGB Backlight Foldable Wrist Rest 104 Key Blue Switch Retro Round Key cap, Black",
      "countryCode": "USA",
      "sellingPrice": null,
      "primaryImgUrl": null,
      "itemStatus": "ENABLED",
      "itemLink": null,
      "sellerPartNumber": null,
      "sellerID": null,
      "sellerName": null,
      "activeStatus": "Inactive",
      "status": "Ended",
      "declineReason": null
    }
  ],
  "totalRows": 1
}

Last updated: June 29, 2022