Keywords List

Search specified keywords, and query the campaign information.

Resource URL

Newegg.com: https://api.newegg.com/marketplace/sponsoredmgmt/campaign/keyword/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
campaignNumber Yes Integer The identifier of the campaign to which the keyword is associated
searchKeywordType No Enum KEYWORD, fuzzy match

It is used in conjunction with the keyword, and the value is passed at the same time or not at all

If it is not passed, it means that this condition is not filtered
keyword No String Restricts results to keywords that match the specified text exactly
activeStatus No Enum Available values:

  • Active:       Query the data of Processing, Delivering, Out of budget status
  • Inactive:    Query the data of Inactive and Ended states
pageInfo pageIndex Yes Integer Current page index (Default is 1)
pageSize Yes Integer How many records in a page  (Default is 20, Max is 9999999 per page)
sortField Yes String the field name of Sort， The default is InDate
sortType Yes String Default Desc, support Desc, Asc two sorting methods

Example: Json, Request

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

{
  "sellerId": "ANWT",
  "campaignNumber": 1171910,
  "groupNumber": 1171911,
  "searchKeywordType": null,
  "keyword": null,
  "activeStatus": null,
  "pageInfo": {
    "pageIndex": 1,
    "pageSize": 9999999,
    "sortField": null,
    "sortType": null
  }
}

Response Body

Attribute
Format
Description
campaignNumber Integer The identifier of the campaign to which the keyword is associated
campaignName String The name of the campaign to which the keyword is associated
groupNumber Integer The identifier of the ad group to which this keyword is associated
groupName String The name of the ad group to which this keyword is associated
keyword String The text of the expression to match against a search query
matchType The type of match. Available values:

  • 0:  Exact
  • 1:   Broad
  • 6:  Phrase
normalizedKeyword String Normalized Keyword
keywordUrl String keyword Url on Newegg site
suggBid Decimal The bid recommendation
suggBidLowest Decimal The lower bound bid recommendation
suggBidMost Decimal The upper bound bid recommendation
searchVolume String keyword search Volume
competition Enum Competition level

Available values:

  • Low
  • Medium
  • High
bid Decimal Bid associated with this keyword.
activeStatus Enum Available values:

  • Active:       Query the data of Processing, Delivering, Out of budget status
  • Inactive:    Query the data of Inactive and Ended states
status String The Campaign Status Description

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

Example: Json, Response

{
  "rows": [
    {
      "campaignNumber": 0,
      "campaignName": null,
      "groupNumber": 0,
      "groupName": null,
      "keyword": "drill",
      "matchType": 3,
      "normalizedKeyword": "drill",
      "keywordUrl": "https://www.newegg.com/p/pl?d=drill",
      "suggBid": null,
      "suggBidLowest": null,
      "suggBidMost": null,
      "searchVolume": null,
      "competition": null,
      "bid": 0.35,
      "activeStatus": "Active",
      "status": "Delivering",
      "declineReason": null
    }
],
totalRows: 1
}

Last updated: June 29, 2022