Skip to main content

Voyado Engage

Get promotions for contact

With this endpoint you can fetch all available promotions assigned to a contact. A promotion can be of different types which are explained further down in Redemption channels.

The API requires you to have the unique id of the customer. If you don’t have the contactId required for the call you can use this endpoint in order to fetch the id.

GET available promotions

Endpoint/api/v2/contacts/{contactId}/promotions

Request URL example

https://voyadodemoeng.voyado.com/api/v2/contacts/67ea9958-0e09-484f-b4c4-aa3e00e1e24c/promotions?redemptionChannelType=ECOM

Response example

[
  {
    "id": "a08c6a49-41b1-4f04-978f-adce009e081a",
    "externalId": 123214-413434-413443,
    "type": "Multichannel",
    "name": "3 for 2 Jeans",
    "expiresOn": null,
    "heading": null,
    "description": null,
    "redeemed": false,
    "redeemedOn": null,
    "imageUrl": null,
    "link": null,
    "redemptionChannels": [
      {
        "type": "ECOM",
        "valueType": "EXTERNALOFFER",
        "value": "DISCOUNTCODE",
        "instruction": “This is just an instruction”
      }
    ]
  },
  {
    "id": "594d98e1-ef73-40e3-9799-add400eaab05",
    "externalId": null,
    "type": "Multichannel",
    "name": "20% off t-shirts",
    "expiresOn": "2023-11-02T23:59:59+01:00",
    "heading": "You get a discount!",
    "description": "Hope you will enjoy this gift. ",
    "redeemed": false,
    "redeemedOn": null,
    "imageUrl": "https://images.eclub.se/images/voyadodemoeng/64DC1720689E4F5A0E1EAD92F3E9A6AFC0863D18.jpg",
    "link": "https://www.casall.com/sv-se/man/t-shirts/mfavouritetee-901-s-21350901003",
    "redemptionChannels": [
      {
        "type": "POS",
        "valueType": "PERCENT",
        "value": 20,
        "instruction": null
      }
    ]
  },
  {
    "id": "3cb87804-6b3b-4f24-a15a-ae8a00e0eacf",
    "externalId": null,
    "type": "Multichannel",
    "name": "Monetary discount 10€",
    "expiresOn": "2022-05-15T23:59:59+02:00",
    "heading": null,
    "description": null,
    "redeemed": true,
    "redeemedOn": "2022-05-03T13:39:49+02:00",
    "imageUrl": null,
    "link": null,
    "redemptionChannels": [
      {
        "type": "POS",
        "valueType": "MONEY",
        "value": {
            "currency": "EUR",
            "amount": 10
          }
        "instruction": null
      }
    ]
  }
]

Redemption channels

Specifies if a promotion is a percentage, monetary amount to be withdrawn from the total amount of the receipt or an external discount code which refers to a price rule in your platform.

redemptionChannels.type declares which channel the promotion applies to.

redemptionChannels.valueType declares which type of discount we want to assign (percentage, monetary or external code).

redemptionChannels.value is the percentage, monetary amount or the external code referring to the external price rule. With a monetary discount we also expose the group currency set in Voyado for the specific client.

redemptionChannels.instruction is an instruction that can be added to the promotion by the Voyado user to instruct store staff for example.

These can be displayed in all currencies declared for the client installation of Voyado.

POS offer with a percentage discount

      "redemptionChannels": [
        {
          "type": "POS",
          "valueType": "PERCENT",
          "value": 15,
          "instruction": “string”
        }

Ecom offer with an external discount code

"redemptionChannels": [
        {
          "type": "ECOM",
          "valueType": "EXTERNALOFFER",
          "value": "DISCOUNTCODE",
          "instruction": “string”
        }

POS offer with a monetary discount

"redemptionChannels": [
        {
          "type": "POS",
          "valueType": "MONEY",
          "value": {
            "currency": "EUR",
            "amount": 10