Get customer coupons

curl --request GET \
  --url https://{host}/promotion/v3/customers/{customerId}/coupons \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://{host}/promotion/v3/customers/{customerId}/coupons', 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/v3/customers/{customerId}/coupons",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://{host}/promotion/v3/customers/{customerId}/coupons"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{host}/promotion/v3/customers/{customerId}/coupons")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

{
  "coupons": [
    {
      "offerId": "82548f61-aa41-4f43-be23-b5156cc67e0b",
      "couponId": "8dacb059-13aa-4215-b1ec-9a4ff43da345",
      "posCouponId": null,
      "offerType": "appCoupon",
      "offerContent": {
        "title": "10% Off Coca-Cola & Fanta – Chain 1 Deal",
        "description": "Refresh your day with a cool discount! For a limited time, get 10% off Coca-Cola or Fanta when purchased without any other offers. This exclusive deal for Chain 1 is your ticket to crisp, bubbly savings—no stacking needed.",
        "brand": "Coca-Cola Refreshments",
        "imageUrl": "https://example.com/assets/coke_fanta_discount.jpg",
        "discountLabel": "10% Off Coca-Cola & Fanta",
        "normalPriceLabel": null,
        "pricePerUnitLabelEnabled": true,
        "unitOfMeasure": "L",
        "conditionLabel": "Buy 1 Coca-Cola or Fanta",
        "receiptDisplayText": "10% off Coca-Cola or Fanta",
        "tags": [],
        "icons": [],
        "autogenerateDiscountLabel": null
      },
      "validFrom": "2026-08-09T00:00:00Z",
      "validTo": "2026-08-15T00:00:00Z",
      "activationTime": null,
      "storeIds": [],
      "chainIds": [
        "1"
      ],
      "isRedeemed": false,
      "prices": {
        "currency": "EUR",
        "normalPrice": 5,
        "price": 4.5,
        "normalPricePerUnit": 10,
        "pricePerUnit": 9
      },
      "discount": {
        "priority": 5,
        "allowOtherDiscountsOnTop": false,
        "itemsApplicationType": "NonDiscountedItems",
        "impactLevel": "Line",
        "maxDiscountAmount": 5,
        "maxDiscountAmountPerCoupon": 0,
        "maxNumberApplyPerReceipt": 1,
        "applyOnHighestPrice": false,
        "applicationType": "OnThreshold",
        "discountType": "SimpleLine",
        "checkoutTypes": null,
        "rewardRedemptionSettings": null,
        "rules": [
          {
            "type": "Percentage",
            "value": 0.1,
            "thresholdType": "Quantity",
            "thresholdValue": 1,
            "affiliations": [
              {
                "type": "Product",
                "id": null,
                "identifiers": [
                  "coca-cola",
                  "fanta"
                ],
                "applicationType": "Include"
              }
            ]
          }
        ]
      },
      "redemptionLimit": 1,
      "redeemedCount": 0,
      "displayPriority": 5,
      "deletedAt": null,
      "assignedBy": null
    }
  ]
}

Get customer coupons

Returns a customer’s coupons that are not expired, have been assigned, and have not yet been picked up in store.

Filtering by store and chain

By default, all of the customer’s available coupons are returned, regardless of store or chain. The following optional filters narrow the results to a specific location:

storeId - Returns only coupons for offers that include this store. Coupons already assigned to the customer are included if they are not tied to a specific store, or if they are tied to this one.

chainId - Returns only coupons for offers that include this chain.

preferredStore - Filters the same way as storeId. Additionally returns the preferredStore-type coupons.

Notes:

storeId and chainId can be combined to narrow results to a specific store and chain at once.
preferredStore cannot be combined with storeId or chainId; sending them together returns an error (400 Bad Request).
preferredStore-type coupons are returned only when preferredStore is provided. Without it, no preferredStore-type coupons are returned. When provided, only the coupons available at that store are returned.

Selecting additional details

includedRelations requests extra information for each coupon. It is optional and more than one value can be provided at a time. Anything not requested is returned empty.

StoresAndChains - When included, each coupon lists the IDs of the stores and chains its offer applies to; when omitted, returns empty arrays.
Discount - When included, each coupon includes the discount details of its offer; when omitted, returns null.

Including already used coupons

By default, coupons already picked up in store are excluded. Setting queryRedeemed to true includes those as well, only if they are not expired.

GET

customers

{customerId}

coupons

Get customer coupons

curl --request GET \
  --url https://{host}/promotion/v3/customers/{customerId}/coupons \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://{host}/promotion/v3/customers/{customerId}/coupons', 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/v3/customers/{customerId}/coupons",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://{host}/promotion/v3/customers/{customerId}/coupons"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{host}/promotion/v3/customers/{customerId}/coupons")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

{
  "coupons": [
    {
      "offerId": "82548f61-aa41-4f43-be23-b5156cc67e0b",
      "couponId": "8dacb059-13aa-4215-b1ec-9a4ff43da345",
      "posCouponId": null,
      "offerType": "appCoupon",
      "offerContent": {
        "title": "10% Off Coca-Cola & Fanta – Chain 1 Deal",
        "description": "Refresh your day with a cool discount! For a limited time, get 10% off Coca-Cola or Fanta when purchased without any other offers. This exclusive deal for Chain 1 is your ticket to crisp, bubbly savings—no stacking needed.",
        "brand": "Coca-Cola Refreshments",
        "imageUrl": "https://example.com/assets/coke_fanta_discount.jpg",
        "discountLabel": "10% Off Coca-Cola & Fanta",
        "normalPriceLabel": null,
        "pricePerUnitLabelEnabled": true,
        "unitOfMeasure": "L",
        "conditionLabel": "Buy 1 Coca-Cola or Fanta",
        "receiptDisplayText": "10% off Coca-Cola or Fanta",
        "tags": [],
        "icons": [],
        "autogenerateDiscountLabel": null
      },
      "validFrom": "2026-08-09T00:00:00Z",
      "validTo": "2026-08-15T00:00:00Z",
      "activationTime": null,
      "storeIds": [],
      "chainIds": [
        "1"
      ],
      "isRedeemed": false,
      "prices": {
        "currency": "EUR",
        "normalPrice": 5,
        "price": 4.5,
        "normalPricePerUnit": 10,
        "pricePerUnit": 9
      },
      "discount": {
        "priority": 5,
        "allowOtherDiscountsOnTop": false,
        "itemsApplicationType": "NonDiscountedItems",
        "impactLevel": "Line",
        "maxDiscountAmount": 5,
        "maxDiscountAmountPerCoupon": 0,
        "maxNumberApplyPerReceipt": 1,
        "applyOnHighestPrice": false,
        "applicationType": "OnThreshold",
        "discountType": "SimpleLine",
        "checkoutTypes": null,
        "rewardRedemptionSettings": null,
        "rules": [
          {
            "type": "Percentage",
            "value": 0.1,
            "thresholdType": "Quantity",
            "thresholdValue": 1,
            "affiliations": [
              {
                "type": "Product",
                "id": null,
                "identifiers": [
                  "coca-cola",
                  "fanta"
                ],
                "applicationType": "Include"
              }
            ]
          }
        ]
      },
      "redemptionLimit": 1,
      "redeemedCount": 0,
      "displayPriority": 5,
      "deletedAt": null,
      "assignedBy": null
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Path Parameters

customerId

string

required

The id of the customer.

Query Parameters

includedRelations

enum<string>[]

List of relations that should be included.

Available options:

StoresAndChains,

Discount

queryRedeemed

boolean

default:false

Specifies if the redeemed coupons are included.

preferredStore

string

The preferred store of the customer.

storeId

string

The selected store to retrieve related available coupons.

chainId

string

The selected chain to retrieve related available coupons.

Response

coupons

object[]

required

All coupons that match the query. Never null, but can be empty.

Show child attributes

Last modified on August 10, 2026

⌘I