Create a New Campaign

Create a new campaign.

Resource URL

Newegg.com: https://api.newegg.com/marketplace/sponsoredmgmt/campaign/create?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
currencyCode Yes String The currency Code
campaignName Yes String The name of the campaign, the length is limited to 200 characters, the campaign Name under each Seller cannot be duplicate
startDate Yes DateTime A starting date for the campaign to go live
endDate No DateTime An ending date for the campaign to stop running
dailyBudget Yes Decimal A daily budget for the campaign
totalBudget No Decimal A total budget for the campaign
groupName Yes String The name of the ad group, the length is displayed as 200 characters, the groupName under the same campaign cannot be duplicate
products Yes String Products collection, the minimum is 1, the maximum is 10000,

the products under the same ad group cannot be duplicate, only the product of seller ID  can be added
keywords keyword Yes String The keyword text.

The minimum value is 1, and the maximum value is 1000. The keywords under the same ad group cannot be duplicate
normalizedKeyword Yes String Normalized Keyword
suggBid No Decimal The bid recommendation
suggBidLowest No Decimal The lower bound bid recommendation
suggBidMost No Decimal The upper bound bid recommendation
bid Yes Decimal Bid set by seller for the keyword for this campaign ad group
matchType Yes Integer The type of match. Available values:

  • 0:  Exact
  • 1:   Broad
  • 6:  Phrase
type Yes Integer The campaign type. Available values:

  • 0: manual targeting
  • 1:  auto targeting
defaultBid No Decimal If Type = 1 – auto targeting

Bidding of automatic targeting ads set by seller
matchTypes matchType Yes Integer The type of match. Available values:

  • 2:  Near match
  • 3:  Loose match
  • 4:  Substitute
  • 5:  Complements
activeStatus Yes Enum Match Types of active status. Available values:

  • Active
  • Inactive
bid Yes Decimal Bidding set by each algorithm of campaign type
negativeKeywords keyword Yes String The text of the expression to match against a search query
keywordType Yes Enum The type of match. Available values

  • 0:  exact match
  • 6:  phrase match
status Yes Integer The Status of the negative keyword. Available values

  • 0: Deactive
  • 1: Active
groupType No Integer The group type of the campaign. Available valuess:

  • 0: Keyword  targeting
  • 1:  Product targeting
  • 2: On-site Product Targeting
  • 3: Off-site Product Targeting
relevantProducts type Yes Integer The type of relevant. Available values:

  • 0: product
  • 1: category
relevantCode Yes String If type of relevant = 0 (product) , this element value for Newegg Item#,

If type of relevant = 1 (category) , this element value is Newegg Item#s categoryCode
currentBid No Decimal If type of relevant = 0 (product) , this element value is offer a price for product

If type of relevant = 1 (category) , this element value is null
status No Integer The status of relevant. Available values:

  • 1 – PAUSED
  • 2 – ENABLED
  • 3 – DELETE
  • 4 – ARREARS
categoryRefine No Refine category data

  • If Type = 0 (product), this element value is null
  • If Type = 1 (category), this element value 
categoryRefine brand_id No String Product’s brand
low_price No Decimal price_range
high_price No Decimal price_range
review_low_ratings No Integer review egg ratings default is 0
review_high_ratings No Integer review egg ratings default is 5
status No Integer The Status of category Refine. Available values:

  • 1:  PAUSED
  • 2:  ENABLED
  • 3:  DELETE
  • 4:  ARREARS
offSiteBid No Decimal off-site bid amount

Example: Json, Request

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

{
  "sellerId": "AXER",
  "countryCode": "USA",
  "currencyCode": "USD",
  "campaignName": "General Promotion",
  "startDate": "2022-06-15 00:00:00",
  "endDate": null,
  "dailyBudget": 2,
  "totalBudget": null,
  "groupName": "1",
  "products": [
    "9SIAXERJ571971",
    "9SIAXERHTU3073"
  ],
  "keywords": [],
  "type": 1,
  "defaultBid": 0.48,
  "matchTypes": [
    {
      "matchType": 2,
      "activeStatus": "Active",
      "bid": 0.39
    },
    {
      "matchType": 3,
      "activeStatus": "Inactive",
      "bid": 0.4
    },
    {
      "matchType": 4,
      "activeStatus": "Active",
      "bid": 0.2
    },
    {
      "matchType": 5,
      "activeStatus": "Inactive",
      "bid": 0.225
    }
  ],
 
  "negativeKeywords": [],
  "video": null,
  "groupType": 0,
  "relevantProducts": null,
  "offSiteBid": null,
  "displayMatchType": null
 
}

Response Body

Attribute
Format
Description
biz code String Available values:

  • 001:  create campaign success
  • 002:  campaign name over 200 in length or repetition,
  • 004:  the item below the same group cannot be repeated
  • 005:  the keyword below the same group cannot be repeated
msg String return message info

Example: Json, Response

{
  "header": [
    {
      "msg": "create campaign success",
      "bizCode": "001",
      "content": [
        "General Promotion"
      ]
    }
  ]
}

Last updated: June 29, 2022