v6 - Advertiser - Demo Endpoints

Create a campaign, with automatic targeting, manual bidding by keyword and status ENABLED

Creates a campaign with automatic targeting, manual bidding and status ENABLED.

POST /advertiser-demo/sponsored-products/campaigns

  • Request

  • Response

Accept: application/vnd.advertiser.v6+json
Content-Type: application/vnd.advertiser.v6+json
Authorization: Bearer token (omitted)

{
  "name" : "Campaign 003",
  "startDate" : "2022-01-01",
  "endDate" : "2022-12-31",
  "state" : "ENABLED",
  "targetingType" : "AUTO",
  "dailyBudget" : 13.0,
  "totalBudget" : 397.0,
  "countries" : [ {
    "countryCode" : "BE"
  } ],
  "bidding" : {
    "strategy" : "MANUAL_BY_KEYWORD",
    "defaultBid" : 1
  }
}

Content-Type: application/vnd.advertiser.v6+json

Status: 202 ACCEPTED

{
  "processStatusId" : "1",
  "eventType" : "CREATE_CAMPAIGN",
  "description" : "Create a campaign.",
  "status" : "PENDING",
  "createTimestamp" : "2021-09-06T14:28:43+02:00",
  "links" : [ {
    "rel" : "self",
    "href" : "http://api.bol.com/retailer-demo/process-status/1",
    "method" : "GET"
  } ]
}

Create a campaign, with automatic targeting, automatic bidding and status ENABLED

Creates a campaign with automatic targeting, automatic bidding and status ENABLED.

POST /advertiser-demo/sponsored-products/campaigns

  • Request

  • Response

Accept: application/vnd.advertiser.v6+json
Content-Type: application/vnd.advertiser.v6+json
Authorization: Bearer token (omitted)

{
  "name" : "Campaign 001.",
  "startDate" : "2022-01-01",
  "endDate" : "2022-12-31",
  "state" : "ENABLED",
  "targetingType" : "AUTO",
  "dailyBudget" : 15.0,
  "totalBudget" : 395.0,
  "countries" : [ {
    "countryCode" : "NL"
  }, {
    "countryCode" : "BE"
  } ],
  "bidding" : {
    "strategy" : "AUTO",
    "automaticBidDesiredAcosPercentage" : 15
  }
}

Content-Type: application/vnd.advertiser.v6+json

Status: 202 ACCEPTED

{
  "processStatusId" : "1",
  "eventType" : "CREATE_CAMPAIGN",
  "description" : "Create a campaign.",
  "status" : "PENDING",
  "createTimestamp" : "2021-09-06T14:28:43+02:00",
  "links" : [ {
    "rel" : "self",
    "href" : "http://api.bol.com/retailer-demo/process-status/1",
    "method" : "GET"
  } ]
}

Create a campaign, with manual targeting, automatic bidding and status ENABLED

Creates a campaign with manual targeting, automatic bidding and status ENABLED.

POST /advertiser-demo/sponsored-products/campaigns

  • Request

  • Response

Accept: application/vnd.advertiser.v6+json
Content-Type: application/vnd.advertiser.v6+json
Authorization: Bearer token (omitted)

{
  "name" : "Campaign 004",
  "startDate" : "2022-01-01",
  "endDate" : "2022-12-31",
  "state" : "ENABLED",
  "targetingType" : "MANUAL",
  "dailyBudget" : 14.0,
  "totalBudget" : 399.0,
  "countries" : [ {
    "countryCode" : "NL"
  }, {
    "countryCode" : "BE"
  } ],
  "bidding" : {
    "strategy" : "AUTO",
    "automaticBidDesiredAcosPercentage" : 19
  }
}

Content-Type: application/vnd.advertiser.v6+json

Status: 202 ACCEPTED

{
  "processStatusId" : "1",
  "eventType" : "CREATE_CAMPAIGN",
  "description" : "Create a campaign.",
  "status" : "PENDING",
  "createTimestamp" : "2021-09-06T14:28:43+02:00",
  "links" : [ {
    "rel" : "self",
    "href" : "http://api.bol.com/retailer-demo/process-status/1",
    "method" : "GET"
  } ]
}

Create a campaign, with manual targeting, automatic bidding and status PAUSED

Creates a campaign with manual targeting, automatic bidding and status PAUSED.

POST /advertiser-demo/sponsored-products/campaigns

  • Request

  • Response

Accept: application/vnd.advertiser.v6+json
Content-Type: application/vnd.advertiser.v6+json
Authorization: Bearer token (omitted)

{
  "name" : "Campaign 002",
  "startDate" : "2022-01-01",
  "endDate" : "2022-12-31",
  "state" : "PAUSED",
  "targetingType" : "MANUAL",
  "dailyBudget" : 14.0,
  "totalBudget" : 396.0,
  "countries" : [ {
    "countryCode" : "NL"
  } ],
  "bidding" : {
    "strategy" : "AUTO",
    "automaticBidDesiredAcosPercentage" : 10
  }
}

Content-Type: application/vnd.advertiser.v6+json

Status: 202 ACCEPTED

{
  "processStatusId" : "1",
  "eventType" : "CREATE_CAMPAIGN",
  "description" : "Create a campaign.",
  "status" : "PENDING",
  "createTimestamp" : "2021-09-06T14:28:43+02:00",
  "links" : [ {
    "rel" : "self",
    "href" : "http://api.bol.com/retailer-demo/process-status/1",
    "method" : "GET"
  } ]
}

Retrieve a list of campaigns

Retrieve a paginated list of campaigns.

GET /advertiser-demo/sponsored-products/campaigns?page=1

  • Request

  • Response

Accept: application/vnd.advertiser.v6+json
Content-Type: application/vnd.advertiser.v6+json
Authorization: Bearer token (omitted)

This endpoint has no request body.

Content-Type: application/vnd.advertiser.v6+json

Status: 200 OK

{
  "campaigns" : [ {
    "campaignId" : "123456",
    "name" : "My first campaign.",
    "startDate" : "2022-01-01",
    "endDate" : "2022-12-31",
    "state" : "ENABLED",
    "targetingType" : "AUTO",
    "dailyBudget" : 15.99,
    "totalBudget" : 395.99,
    "countries" : [ {
      "countryCode" : "NL"
    }, {
      "countryCode" : "BE"
    } ],
    "bidding" : {
      "strategy" : "AUTO",
      "automaticBidDesiredAcosPercentage" : 15
    }
  }, {
    "campaignId" : "456789",
    "name" : "My second campaign.",
    "startDate" : "2021-10-01",
    "endDate" : "2021-12-31",
    "state" : "PAUSED",
    "targetingType" : "MANUAL",
    "dailyBudget" : 14.99,
    "totalBudget" : 396.99,
    "countries" : [ {
      "countryCode" : "NL"
    } ],
    "bidding" : {
      "strategy" : "AUTO",
      "automaticBidDesiredAcosPercentage" : 10
    }
  } ]
}

Retrieve a campaign by campaign id

Retrieves campaign information by using campaign id 123456.

GET /advertiser-demo/sponsored-products/campaigns/123456

  • Request

  • Response

Accept: application/vnd.advertiser.v6+json
Content-Type: application/vnd.advertiser.v6+json
Authorization: Bearer token (omitted)

This endpoint has no request body.

Content-Type: application/vnd.advertiser.v6+json

Status: 200 OK

{
  "campaignId" : "123456",
  "name" : "My first campaign.",
  "startDate" : "2022-01-01",
  "endDate" : "2022-12-31",
  "state" : "ENABLED",
  "targetingType" : "AUTO",
  "dailyBudget" : 15.99,
  "totalBudget" : 395.99,
  "countries" : [ {
    "countryCode" : "NL"
  }, {
    "countryCode" : "BE"
  } ],
  "bidding" : {
    "strategy" : "AUTO",
    "automaticBidDesiredAcosPercentage" : 15
  }
}

Modify the state of an existing campaign

Modify the state of campaign with campaign id 123456 to "PAUSED".

PUT /advertiser-demo/sponsored-products/campaigns/123456

  • Request

  • Response

Accept: application/vnd.advertiser.v6+json
Content-Type: application/vnd.advertiser.v6+json
Authorization: Bearer token (omitted)

{
  "state" : "PAUSED"
}

Content-Type: application/vnd.advertiser.v6+json

Status: 202 ACCEPTED

{
  "processStatusId" : "1",
  "entityId" : "123456",
  "eventType" : "UPDATE_CAMPAIGN",
  "description" : "Update a campaign.",
  "status" : "PENDING",
  "createTimestamp" : "2021-09-06T14:28:43+02:00",
  "links" : [ {
    "rel" : "self",
    "href" : "http://api.bol.com/retailer-demo/process-status/1",
    "method" : "GET"
  } ]
}