v6 - Promotions - Demo Endpoints

Get list of promotions with multiple entries

Get list of promotions based on promotion type awareness.

GET /retailer-demo/promotions?promotion-type=PRICE_OFF&promotion-type=AWARENESS&page=1

  • Request

  • Response

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

This endpoint has no request body.

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

Status: 200 OK

{
  "promotions" : [ {
    "promotionId" : "544289",
    "title" : "FuturePromoTest",
    "startDateTime" : "2021-04-24T00:00:00+02:00",
    "endDateTime" : "2021-05-20T00:00:00+02:00",
    "countries" : [ {
      "countryCode" : "NL"
    }, {
      "countryCode" : "BE"
    } ],
    "promotionType" : "PRICE_OFF",
    "products" : [ {
      "ean" : "0734646158893"
    }, {
      "ean" : "3600531117078"
    } ],
    "retailerSpecificPromotion" : false,
    "campaign" : {
      "name" : "Deals",
      "startDateTime" : "2013-07-01T00:00:00+02:00"
    }
  }, {
    "promotionId" : "544242",
    "title" : "Korting op TEST",
    "startDateTime" : "2021-04-23T00:00:00+02:00",
    "endDateTime" : "2021-05-07T00:00:00+02:00",
    "countries" : [ {
      "countryCode" : "NL"
    }, {
      "countryCode" : "BE"
    } ],
    "promotionType" : "PRICE_OFF",
    "products" : [ {
      "ean" : "4015600865863"
    }, {
      "ean" : "3600531117078"
    } ],
    "retailerSpecificPromotion" : false,
    "campaign" : {
      "name" : "CampaignForSDDTest",
      "startDateTime" : "2020-08-21T00:00:00+02:00"
    }
  }, {
    "promotionId" : "544329",
    "title" : "test_linda",
    "startDateTime" : "2021-05-06T00:00:00+02:00",
    "endDateTime" : "2021-05-07T00:00:00+02:00",
    "countries" : [ {
      "countryCode" : "NL"
    }, {
      "countryCode" : "BE"
    } ],
    "promotionType" : "PRICE_OFF",
    "products" : [ {
      "ean" : "4015600865863"
    }, {
      "ean" : "0734646158893"
    }, {
      "ean" : "3600531117078"
    } ],
    "retailerSpecificPromotion" : false,
    "campaign" : {
      "name" : "Deals",
      "startDateTime" : "2013-07-01T00:00:00+02:00"
    }
  } ]
}

Get list of promotions with a single entry

Get list of promotions based on promotion type price off.

GET /retailer-demo/promotions?promotion-type=PRICE_OFF&page=1

  • Request

  • Response

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

This endpoint has no request body.

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

Status: 200 OK

{
  "promotions" : [ {
    "promotionId" : "533736",
    "title" : "Promotion title",
    "startDateTime" : "2020-09-10T00:00:00+02:00",
    "endDateTime" : "2021-09-01T00:00:00+02:00",
    "countries" : [ {
      "countryCode" : "NL"
    }, {
      "countryCode" : "BE"
    } ],
    "promotionType" : "PRICE_OFF",
    "products" : [ {
      "ean" : "9789056725716"
    } ],
    "retailerSpecificPromotion" : false,
    "campaign" : {
      "name" : "Deals",
      "startDateTime" : "2013-07-01T00:00:00+02:00"
    }
  } ]
}

Get promotion by promotion id

Get promotion by promotion id 533735 with promotion type price off.

GET /retailer-demo/promotions/533736

  • Request

  • Response

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

This endpoint has no request body.

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

Status: 200 OK

{
  "promotionId" : "533736",
  "title" : "Test Promotion",
  "startDateTime" : "2020-09-10T00:00:00+02:00",
  "endDateTime" : "2021-09-01T00:00:00+02:00",
  "countries" : [ {
    "countryCode" : "NL"
  }, {
    "countryCode" : "BE"
  } ],
  "promotionType" : "PRICE_OFF",
  "products" : [ {
    "ean" : "9789056725716",
    "relevanceScores" : [ {
      "countryCode" : "NL",
      "relevanceScore" : 10
    }, {
      "countryCode" : "BE",
      "relevanceScore" : 10
    } ],
    "bestSellingOffers" : [ {
      "countryCode" : "NL",
      "unitPrice" : "24.40"
    }, {
      "countryCode" : "BE",
      "unitPrice" : "25.00"
    } ]
  } ],
  "retailerSpecificPromotion" : false,
  "campaign" : {
    "name" : "Deals",
    "startDateTime" : "2013-07-01T00:00:00+02:00"
  }
}