Keywords Suggest

Get suggested keywords and suggested bids.

Resource URL

Newegg.com: https://api.newegg.com/marketplace/sponsoredmgmt/campaign/keyword/getsuggest?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
itemList Yes String A list of the seller’s products to bid recommendations clauses.
keywordList No String Either or both with the itemList parameter
When entering itemList, return a list of keywords associated with item
When entering a keyword, return the corresponding keyword
sponsorType No Integer Available values

  • 0: Sponsor Products (Default)
  • 1: Sponsor Headlines
  • 2: Sponsor Video
type No Integer Available values

  • 0：MANUAL (Default)
  • 1：AUTO
costModel No Integer Available values

  • 0: CPM
  • 1: CPC

Example: Json, Request

POST https://api.newegg.com/marketplace/sponsoredmgmt/campaign/keyword/getsuggest?sellerid={sellerid}
Content-Type: application/json
Accept: application/json
Authorization: 2d9da3949bdffd8594e9fa8a77764ce1
SecretKey: 55F55BC1-5E65-401B-BB1D-E29B0A19B734  
 
{
   "itemList":[
      "9SIABFSFEM7860"
   ],
   "keywordList":[
       
   ],
   "sponsorType":0,
   "type":0,
   "costModel":null
}

Response Body

Attribute
Format
Description
suggBidMost Decimal The upper bound bid recommendation.
suggBidLowest Decimal The lower bound bid recommendation.
suggBid Decimal The bid recommendation.
status Integer Available values

  • 0:  Deactive
  • 1:  Active
searchVolume String keyword search Volume
normalizedKeyword String Normalized Keyword
matchType Integer The type of match. Available values:

  • 0:  Exact
  • 1:  Broad
  • 6:  Phrase
matchType Integer The type of match. Available values:

  • 2:  Near match
  • 3:  Loose match
  • 4:  Substitute
  • 5:  Complements
keywordUrl String keyword Url on Newegg site
keyword String The text of the expression to match against item search query.
items String seller’ s product
declineReason String The decline reason
competition Enum Competition level
Available values:

  • Low
  • Medium
  • High
bid Decimal Bid associated with this keyword.
activeStatus Enum Match Types of active status. Available values:

  • Active
  • Inactive

Example: Json, Response

{
   "header":[
      {
         "msg":"fetch auto ml keywords success!",
         "bizCode":"200"
      }
   ],
   "rows":[
      {
         "keyword":"3060",
         "normalizedKeyword":"3060",
         "items":[
            "9SIABFSFEM7860"
         ],
         "keywordUrl":"https://www.newegg.com/p/pl?d=3060",
         "suggBid":0.47,
         "suggBidLowest":0.47,
         "suggBidMost":1.0,
         "bid":null,
         "matchType":0,
         "searchVolume":"10000+",
         "competition":"High"
      },
      {
         "keyword":"3060 ti",
         "normalizedKeyword":"3060|ti",
         "items":[
            "9SIABFSFEM7860"
         ],
         "keywordUrl":"https://www.newegg.com/p/pl?d=3060 ti",
         "suggBid":0.46,
         "suggBidLowest":0.46,
         "suggBidMost":0.98,
         "bid":null,
         "matchType":0,
         "searchVolume":"3000+",
         "competition":"Low"
      },
      {
         "keyword":"3060 ti",
         "normalizedKeyword":"3060|ti",
         "items":[
            "9SIABFSFEM7860"
         ],
         "keywordUrl":"https://www.newegg.com/p/pl?d=3060 ti",
         "suggBid":0.46,
         "suggBidLowest":0.46,
         "suggBidMost":0.72,
         "bid":null,
         "matchType":1,
         "searchVolume":"3000+",
         "competition":"Low"
      },
      {
         "keyword":"3060 ti",
         "normalizedKeyword":"3060|ti",
         "items":[
            "9SIABFSFEM7860"
         ],
         "keywordUrl":"https://www.newegg.com/p/pl?d=3060 ti",
         "suggBid":0.46,
         "suggBidLowest":0.46,
         "suggBidMost":0.85,
         "bid":null,
         "matchType":6,
         "searchVolume":"3000+",
         "competition":"Low"
      }
   ],
   "totalRows":4,
   "suggBid":0.47,
   "suggBidLowest":0.46,
   "suggBidMost":1.0,
   "matchTypes":[
      {
         "matchType":2,
         "matchTypeName":"Close match",
         "suggBid":1.75,
         "suggBidLowest":0.4,
         "suggBidMost":3.1,
         "bid":null,
         "activeStatus":null,
         "status":null,
         "declineReason":null
      },
      {
         "matchType":3,
         "matchTypeName":"Loose match",
         "suggBid":0.45,
         "suggBidLowest":0.4,
         "suggBidMost":0.5,
         "bid":null,
         "activeStatus":null,
         "status":null,
         "declineReason":null
      },
      {
         "matchType":4,
         "matchTypeName":"Substitutes",
         "suggBid":0.255,
         "suggBidLowest":0.19,
         "suggBidMost":0.32,
         "bid":null,
         "activeStatus":null,
         "status":null,
         "declineReason":null
      },
      {
         "matchType":5,
         "matchTypeName":"Complements",
         "suggBid":0.31,
         "suggBidLowest":0.24,
         "suggBidMost":0.38,
         "bid":null,
         "activeStatus":null,
         "status":null,
         "declineReason":null
      }
   ]
}

Last updated: October 03, 2022