Create coupon

curl --request POST \
  --url https://{host}/promotion/v2/coupons/assign \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "memberId": "<string>",
  "campaignId": "<string>",
  "reservationId": "<string>",
  "pickUpEndDate": "2023-11-07T05:31:56Z",
  "visibleFrom": "2023-11-07T05:31:56Z",
  "storeId": "<string>",
  "assignedBy": "<string>"
}
'

import requests

url = "https://{host}/promotion/v2/coupons/assign"

payload = {
    "memberId": "<string>",
    "campaignId": "<string>",
    "reservationId": "<string>",
    "pickUpEndDate": "2023-11-07T05:31:56Z",
    "visibleFrom": "2023-11-07T05:31:56Z",
    "storeId": "<string>",
    "assignedBy": "<string>"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json-patch+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    memberId: '<string>',
    campaignId: '<string>',
    reservationId: '<string>',
    pickUpEndDate: '2023-11-07T05:31:56Z',
    visibleFrom: '2023-11-07T05:31:56Z',
    storeId: '<string>',
    assignedBy: '<string>'
  })
};

fetch('https://{host}/promotion/v2/coupons/assign', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/promotion/v2/coupons/assign",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'memberId' => '<string>',
    'campaignId' => '<string>',
    'reservationId' => '<string>',
    'pickUpEndDate' => '2023-11-07T05:31:56Z',
    'visibleFrom' => '2023-11-07T05:31:56Z',
    'storeId' => '<string>',
    'assignedBy' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json-patch+json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/promotion/v2/coupons/assign"

	payload := strings.NewReader("{\n  \"memberId\": \"<string>\",\n  \"campaignId\": \"<string>\",\n  \"reservationId\": \"<string>\",\n  \"pickUpEndDate\": \"2023-11-07T05:31:56Z\",\n  \"visibleFrom\": \"2023-11-07T05:31:56Z\",\n  \"storeId\": \"<string>\",\n  \"assignedBy\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json-patch+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{host}/promotion/v2/coupons/assign")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"memberId\": \"<string>\",\n  \"campaignId\": \"<string>\",\n  \"reservationId\": \"<string>\",\n  \"pickUpEndDate\": \"2023-11-07T05:31:56Z\",\n  \"visibleFrom\": \"2023-11-07T05:31:56Z\",\n  \"storeId\": \"<string>\",\n  \"assignedBy\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/promotion/v2/coupons/assign")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n  \"memberId\": \"<string>\",\n  \"campaignId\": \"<string>\",\n  \"reservationId\": \"<string>\",\n  \"pickUpEndDate\": \"2023-11-07T05:31:56Z\",\n  \"visibleFrom\": \"2023-11-07T05:31:56Z\",\n  \"storeId\": \"<string>\",\n  \"assignedBy\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "campaignId": "<string>",
  "couponId": "<string>",
  "campaignType": "<string>",
  "storeIds": [
    "<string>"
  ],
  "chainIds": [
    "<string>"
  ],
  "posCouponId": "<string>",
  "campaignContent": {
    "iconTags": [
      {
        "name": "<string>",
        "iconUrl": "<string>"
      }
    ],
    "title": "<string>",
    "description": "<string>",
    "brand": "<string>",
    "imageUrl": "<string>",
    "discountLabel": "<string>",
    "normalPriceLabel": "<string>",
    "pricePerUnitLabelEnabled": true,
    "unitOfMeasure": "<string>",
    "conditionLabel": "<string>",
    "receiptDisplayText": "<string>",
    "tags": [
      "<string>"
    ],
    "icons": [
      "<string>"
    ],
    "autogenerateDiscountLabel": true
  },
  "validFrom": "2023-11-07T05:31:56Z",
  "validTo": "2023-11-07T05:31:56Z",
  "activationTime": "2023-11-07T05:31:56Z",
  "isRedeemed": true,
  "prices": {
    "currency": "<string>",
    "normalPrice": 50000000,
    "price": 123,
    "normalPricePerUnit": 50000000,
    "pricePerUnit": 123
  },
  "discount": {
    "priority": 123,
    "allowOtherDiscountsOnTop": true,
    "itemsApplicationType": "AllItems",
    "impactLevel": "Line",
    "maxDiscountAmount": 123,
    "maxDiscountAmountPerCoupon": 123,
    "maxNumberApplyPerReceipt": 123,
    "maxNumberApplyPerReceiptDecimal": 123,
    "applyOnHighestPrice": true,
    "applicationType": "OnThreshold",
    "discountType": "Unknown",
    "checkoutTypes": [
      "<string>"
    ],
    "rewardRedemptionSettings": {
      "redeemableFrom": "2023-11-07T05:31:56Z",
      "redeemableTo": "2023-11-07T05:31:56Z",
      "redeemableForDays": 123
    },
    "rules": [
      {
        "type": "FixedPrice",
        "value": 50000000,
        "thresholdType": "Quantity",
        "thresholdValue": 50000000,
        "affiliations": [
          {
            "type": "Product",
            "id": "<string>",
            "applicationType": "Include"
          }
        ]
      }
    ]
  },
  "redemptionLimit": 123,
  "redeemedCount": 123,
  "displayPriority": 123,
  "deletedAt": "2023-11-07T05:31:56Z",
  "assignedBy": "<string>"
}

{
  "name": "<string>",
  "message": "<string>",
  "details": null
}

{
  "name": "<string>",
  "message": "<string>",
  "details": null
}

Create coupon

Create coupon for the offer (optionally activate)

Assigned coupon is displayed in app immediately if VisibleFrom is null, or after VisibleFrom datetime, if it is not null.

Coupon assignment can fail if selected campaign has TotalCoupons set and specified amount of coupons is already reached. If coupon was previously reserved and reservation did not expire, it is guaranteed that assignment will succeed too.

If coupon was reserved, it will not be possible to change any fields during assignment.

POST

coupons

assign

Create coupon

curl --request POST \
  --url https://{host}/promotion/v2/coupons/assign \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "memberId": "<string>",
  "campaignId": "<string>",
  "reservationId": "<string>",
  "pickUpEndDate": "2023-11-07T05:31:56Z",
  "visibleFrom": "2023-11-07T05:31:56Z",
  "storeId": "<string>",
  "assignedBy": "<string>"
}
'

import requests

url = "https://{host}/promotion/v2/coupons/assign"

payload = {
    "memberId": "<string>",
    "campaignId": "<string>",
    "reservationId": "<string>",
    "pickUpEndDate": "2023-11-07T05:31:56Z",
    "visibleFrom": "2023-11-07T05:31:56Z",
    "storeId": "<string>",
    "assignedBy": "<string>"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json-patch+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    memberId: '<string>',
    campaignId: '<string>',
    reservationId: '<string>',
    pickUpEndDate: '2023-11-07T05:31:56Z',
    visibleFrom: '2023-11-07T05:31:56Z',
    storeId: '<string>',
    assignedBy: '<string>'
  })
};

fetch('https://{host}/promotion/v2/coupons/assign', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/promotion/v2/coupons/assign",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'memberId' => '<string>',
    'campaignId' => '<string>',
    'reservationId' => '<string>',
    'pickUpEndDate' => '2023-11-07T05:31:56Z',
    'visibleFrom' => '2023-11-07T05:31:56Z',
    'storeId' => '<string>',
    'assignedBy' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json-patch+json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/promotion/v2/coupons/assign"

	payload := strings.NewReader("{\n  \"memberId\": \"<string>\",\n  \"campaignId\": \"<string>\",\n  \"reservationId\": \"<string>\",\n  \"pickUpEndDate\": \"2023-11-07T05:31:56Z\",\n  \"visibleFrom\": \"2023-11-07T05:31:56Z\",\n  \"storeId\": \"<string>\",\n  \"assignedBy\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json-patch+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{host}/promotion/v2/coupons/assign")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"memberId\": \"<string>\",\n  \"campaignId\": \"<string>\",\n  \"reservationId\": \"<string>\",\n  \"pickUpEndDate\": \"2023-11-07T05:31:56Z\",\n  \"visibleFrom\": \"2023-11-07T05:31:56Z\",\n  \"storeId\": \"<string>\",\n  \"assignedBy\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/promotion/v2/coupons/assign")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n  \"memberId\": \"<string>\",\n  \"campaignId\": \"<string>\",\n  \"reservationId\": \"<string>\",\n  \"pickUpEndDate\": \"2023-11-07T05:31:56Z\",\n  \"visibleFrom\": \"2023-11-07T05:31:56Z\",\n  \"storeId\": \"<string>\",\n  \"assignedBy\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "campaignId": "<string>",
  "couponId": "<string>",
  "campaignType": "<string>",
  "storeIds": [
    "<string>"
  ],
  "chainIds": [
    "<string>"
  ],
  "posCouponId": "<string>",
  "campaignContent": {
    "iconTags": [
      {
        "name": "<string>",
        "iconUrl": "<string>"
      }
    ],
    "title": "<string>",
    "description": "<string>",
    "brand": "<string>",
    "imageUrl": "<string>",
    "discountLabel": "<string>",
    "normalPriceLabel": "<string>",
    "pricePerUnitLabelEnabled": true,
    "unitOfMeasure": "<string>",
    "conditionLabel": "<string>",
    "receiptDisplayText": "<string>",
    "tags": [
      "<string>"
    ],
    "icons": [
      "<string>"
    ],
    "autogenerateDiscountLabel": true
  },
  "validFrom": "2023-11-07T05:31:56Z",
  "validTo": "2023-11-07T05:31:56Z",
  "activationTime": "2023-11-07T05:31:56Z",
  "isRedeemed": true,
  "prices": {
    "currency": "<string>",
    "normalPrice": 50000000,
    "price": 123,
    "normalPricePerUnit": 50000000,
    "pricePerUnit": 123
  },
  "discount": {
    "priority": 123,
    "allowOtherDiscountsOnTop": true,
    "itemsApplicationType": "AllItems",
    "impactLevel": "Line",
    "maxDiscountAmount": 123,
    "maxDiscountAmountPerCoupon": 123,
    "maxNumberApplyPerReceipt": 123,
    "maxNumberApplyPerReceiptDecimal": 123,
    "applyOnHighestPrice": true,
    "applicationType": "OnThreshold",
    "discountType": "Unknown",
    "checkoutTypes": [
      "<string>"
    ],
    "rewardRedemptionSettings": {
      "redeemableFrom": "2023-11-07T05:31:56Z",
      "redeemableTo": "2023-11-07T05:31:56Z",
      "redeemableForDays": 123
    },
    "rules": [
      {
        "type": "FixedPrice",
        "value": 50000000,
        "thresholdType": "Quantity",
        "thresholdValue": 50000000,
        "affiliations": [
          {
            "type": "Product",
            "id": "<string>",
            "applicationType": "Include"
          }
        ]
      }
    ]
  },
  "redemptionLimit": 123,
  "redeemedCount": 123,
  "displayPriority": 123,
  "deletedAt": "2023-11-07T05:31:56Z",
  "assignedBy": "<string>"
}

{
  "name": "<string>",
  "message": "<string>",
  "details": null
}

{
  "name": "<string>",
  "message": "<string>",
  "details": null
}

Authorizations

Authorization

string

header

required

Opaque Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Body

The coupon to create.

memberId

string

required

Id of customer. Part of idempotency key

Required string length: 1 - 36

campaignId

string

required

Id of active or scheduled promotion campaign. Part of idempotency key

Required string length: 1 - 255

reservationId

string

required

Unique external identifier for coupon. Part of idempotency key.

Required string length: 1 - 100

pickUpEndDate

string<date-time> | null

Final datetime, at which coupon can be picked up in store. If not provided, coupon is valid till the end of campaign. Once coupon is assigned or reserved, the field cannot be changed.

visibleFrom

string<date-time> | null

Datetime starting from which coupon will be displayed in the app. If not provided, coupon will be displayed immediately after coupon is assigned or when campaign becomes Active, whichever one of these dates is later.

storeId

string | null

StoreId optional override defines in which store assigned Coupon could only be used. It should be one from the set of stores/chains configured in Offer.

assignedBy

string | null

Name of the person or system that assigned the coupon.

Response

Coupon details

campaignId

string

required

ID of Promotion Campaign

Required string length: 1 - 255

couponId

string

required

ID of Coupon

Required string length: 1 - 50

campaignType

string

required

Customer specific campaign type. Determines how or by which service campaign will be used. Types used so far: game, appCoupon, gift, preferredStore, memberOffer, stampCard, stickersCampaign.

Required string length: 1 - 255

storeIds

string[]

required

List of Store Ids where Promotion campaign is available. Mutually exclusive with ChainIds. Never null, but can be empty.

chainIds

string[]

required

List of Chain Ids where Promotion campaign is available. Mutually exclusive with StoreIds. Never null, but can be empty.

posCouponId

string | null

Id of Coupon on POS. Can be the same as CouponId or different, depending on Coupon system used downstream. Null before coupon is activated, not null after the successful activation.

Maximum string length: 100

campaignContent

object

Show child attributes

validFrom

string<date-time>

Date when this coupon becomes visible and usable in store after activation

validTo

string<date-time>

Date when this coupon expires and cannot be picked up in the store

activationTime

string<date-time> | null

Date when this coupon has been activated

isRedeemed

boolean

Has this coupon been redeemed (collected in the store). Is true only coupon is redeemed to the limit

prices

object

Show child attributes

discount

object

Show child attributes

redemptionLimit

integer<int32>

Specifies how many times coupon can be redeemed in store. Each redemption is a separate purchase. 0, or positive integer, with 0 meaning unlimited redemptions

redeemedCount

integer<int32>

Specifies how many times coupon was already redeemed in store. 0 when coupon was not redeemed, postive integer with count of usages otherwise.

displayPriority

integer<int32>

Controlls the order in which coupons are returned to the mobile app. Lower number means higher priority

deletedAt

string<date-time> | null

Date when this coupon has been deleted

assignedBy

string | null

Name of the person or system that assigned the coupon

Last modified on August 10, 2026

⌘I