Negative Keyword List

Search for negative keyword information.

Resource URL

Newegg.com: https://api.newegg.com/marketplace/sponsoredmgmt/campaign/negativekeyword/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
campaignNumber Yes Integer Restricts results to negative keywords associated with campaign specified by identifier
groupNumber Yes Integer Restricts results to negative keywords associated with ad group specified by identifier
keyword No String Restricts results to negative keywords that match the specified text
searchKeywordType No Enum Available values:

  • NEGATIVE_NAME
  • NEGATIVE_NUM
status No Enum Available values:

  • 0  Deactive
  • 1  Active
pageInfo pageIndex Yes Integer Current page index (Default is 1)
pageSize Yes Integer How many record(s) in a page (Default is 20 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/negativekeyword/search?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json

{
  "sellerId": "AMZW",
  "campaignNumber": 945425,
  "groupNumber": 945426,
  "keyword": null,
  "searchKeywordType": "NEGATIVE_NAME",
  "status": null,
  "pageInfo": {
    "pageIndex": 1,
    "pageSize": 20,
    "sortField": null,
    "sortType": null
  }
}

Response Body

Attribute
Format·
Description
transactionNumber Integer The identifier of the negative keyword
keyword String The text of the expression to match against a search query
formatKeyword String Format of the negative Keyword
keywordType Integer Type of negative Keyword

Available values:

  • 0:  exact match
  • 6:   phrase match
status Integer Status of negative Keyword

Available values:

  • 0: Deactive
  • 1:  Active
totalRows Integer Total number of the records

Example: Json, Response

{
  "header": [
    {
      "msg": "search negative keyword success",
      "bizCode": "055"
    }
  ],
  "rows": [
    {
      "transactionNumber": 1181962,
      "keyword": "logitech webcam",
      "formatKeyword": "logitech|webcam",
      "keywordType": 0,
      "status": 1
    },
    {
      "transactionNumber": 1181961,
      "keyword": "logitech webcam",
      "formatKeyword": "logitech|webcam",
      "keywordType": 6,
      "status": 1
    }
  ],
  "totalRows": 2
}

Last updated: June 29, 2022