Получение списка триггерных промоакций

Описание

Возвращает список триггерных промоакций программы лояльности. Поддерживается пагинация и фильтрация по активности.

URL-адрес

Метод: POST

https://example.com/api/v1.1/loyalty/trigger_promotions

Параметры запроса

Параметр	Тип	Пример	Обязательный	Описание
token	string	"abc123def456"	Да	API-токен
loyalty_program_id	int	123	Да	Идентификатор программы лояльности
from_id	int	0	Нет	ID промоакции для пагинации (записи с ID > from_id)
limit	int	20	Нет	Количество записей (1–100), по умолчанию 20
is_active	boolean	true	Нет	Фильтр по активности: true — активные, false — неактивные, не указан — все

Пример запроса

JSON

{
  "token": "abc123def456",
  "loyalty_program_id": 123,
  "limit": 20,
  "is_active": true
}

XML

<xml>
  <token>abc123def456</token>
  <loyalty_program_id>123</loyalty_program_id>
  <limit>20</limit>
  <is_active>true</is_active>
</xml>

Пример ответа

JSON

{
  "data": [
    {
      "id": 5,
      "name": "Триггерная акция: Бонус за покупку",
      "description": "Начисление бонусов за каждую покупку",
      "external_id": "trigger_promo_2023_q3",
      "start_date": "2023-09-01T00:00:00Z",
      "end_date": "2023-09-30T23:59:59Z",
      "is_active": true,
      "redeem_rules": [
        {
          "points_currency_iid": 1,
          "points_currency_eid": "curr1",
          "static_amount": "100.16",
          "min_amount": "50",
          "max_amount": "500"
        }
      ],
      "accrual_rules": [
        {
          "points_currency_iid": 1,
          "points_currency_eid": "curr1",
          "static_amount": "100",
          "min_amount": "50",
          "max_amount": "500"
        }
      ]
    }
  ],
  "next_from_id": 8,
  "total_count": 134,
  "error": 0,
  "error_text": "Successful operation"
}

XML

<xml>
  <data>
    <id>5</id>
    <name>Триггерная акция: Бонус за покупку</name>
    <description>Начисление бонусов за каждую покупку</description>
    <external_id>trigger_promo_2023_q3</external_id>
    <start_date>2023-09-01T00:00:00Z</start_date>
    <end_date>2023-09-30T23:59:59Z</end_date>
    <is_active>true</is_active>
  </data>
  <next_from_id>8</next_from_id>
  <total_count>134</total_count>
  <error>0</error>
  <error_text>Successful operation</error_text>
</xml>

Возвращаемые параметры

Параметр	Тип	Описание
error	int	Код ошибки
error_text	string	Текст ошибки
id	int	Уникальный ID промоакции
name	string	Название промоакции
description	string	Описание промоакции
external_id	string	Внешний идентификатор промоакции
start_date	string (RFC3339)	Дата начала
end_date	string (RFC3339)	Дата окончания
is_active	boolean	Флаг активности
redeem_rules	array	Правила списания (тип баллов, значения)
accrual_rules	array	Правила начисления (тип баллов, значения)
next_from_id	int	ID для следующей страницы
total_count	int	Общее количество промоакций