Campaign List

List campaigns based on specified query conditions Campaign Name, Active Status, Date Range, and other query-related campaign information.

Resource URL

Newegg.com: https://api.newegg.com/marketplace/sponsoredmgmt/campaign/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 No String The country for your Campaign. Only the ISO standard 3-digit codes are accepted.  Like USA
searchKeywordType No Enum Available values

  • CAMPAIGN_NAME
  • CAMPAIGN_NUM
keyword No String If searchKeywordType for CAMPAIGN_NUM , The returned the identifier of the campaign.
If searchKeywordType for CAMPAIGN_NAME, The returned includes any campaign with the specified name using an fuzzy string match.
type No Integer The campaign type. Available values:

  • 0: manual targeting for a product campaign
  • 1: auto-targeting for a product campaign
sponsorType No Integer The type of sponsor of the campaign.
Available values

  • 0: Sponsored Products
  • 1: Sponsored Headlines
  • 2: Sponsored Video
  • 3: Sponsor display
  • 4: Offsite Ads
displayType No Integer If sponsorType = 3
Available values

  • 2: On-site Product Targeting
  • 3: Off-site Product Targeting
activeStatus No Enum The returned is filtered to include only campaigns with one of the values
Available values

  • Active: Query the data of Processing, Delivering, Out of budget status
  • Inactive: Query the data of Inactive and Ended states
fromDate Yes String The starting date of the campaign
toDate Yes String The end date of the campaign
pageInfo pageIndex Yes Integer Current page index (Default is 1)
pageSize Yes Integer How many record(s) in a page (Max 100 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/search?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json

{
  "sellerId": "AN9A"，
  "countryCode": null,
  "searchKeywordType": "CAMPAIGN_NUM",
  "keyword": "1168452",
  "type": null,
  "sponsorType": null,
  "displayType" :null,
  "activeStatus": null,
  "pageInfo": null
}

Response Body

Attribute Format Description
campaignNumber Integer The Number of the campaign
campaignName String The name of the campaign
countryCode String The campaign country code
type Integer The type of targeting of the campaign
Available values

  • 0: manual targeting.
  • 1: auto-targeting
  • 2: brand headlines manual
  • 3: brand headlines auto
  • 4: video manual
  • 5: video auto
  • 6: Sponsored Display
activeStatus String The campaigns status

  • 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
startDate String  The starting date of the campaign
endDate String The ending date of the campaign to stop running
budget Decimal The total amount is to spend on this ad
dailyBudget Decimal The amount  to spend on this ad per day
groupCount Integer How many groups under this campaign
inDate String The campaign creation data
inUser Integer The campaign creation user ID
displayType String The campaign display type
declineReason String The campaign declined reason
costModel Decimal Available values:

  • 0: CPM
  • 1: CPC
LastEditDate String The campaign’s last edit date

Example: Json, Response

{
  "header": [
    {
      "msg": "search campaigns success",
      "bizCode": "025"
    }
  ],
  "rows": [
    {
      "campaignNumber": 1149850,
      "campaignName": "Campaign-2022-05-04 10:52:30",
      "countryCode": "USA",
      "type": 0,
      "activeStatus": "Active",
      "status": "Delivering",
      "startDate": "2022-05-05 00:00:00",
      "endDate": null,
      "budget": 3000.0,
      "dailyBudget": 100.0,
      "groupCount": 1,
      "inDate": "Wed May 04 03:57:04 PDT 2022",
      "inUser": "93716284",
      "displayType": "0",
      "declineReason": null,
      "costModel": 0
    }
  ],
  "totalRows": 1
}

Last updated: June 29, 2022