Содержание

ProBonus API: Акции и сегменты

Сегментные акции (v1 и устаревшая v0), триггерные акции, «Штампики N+1», промокоды, сегменты гостей.

Общие правила (адрес, авторизация, форматы, коды ошибок) — на странице ProBonus API. Справочник методов.

Список методов

Метод Адрес Назначение
GET /api/v1/promotions/action_for_copy Получение действия акции для копирования
POST /api/v1/promotions/activate Активация сегментной акции
POST /api/v1/promotions/deactivate Деактивация сегментной акции
POST /api/v1/promotions/delete Удаление сегментной акции
GET /api/v1/promotions/for_copy Получение сегментной акции для копирования
GET /api/v1/promotions/get Чтение сегментной акции по id
POST /api/v1/promotions/insert Добавление сегментной акции
GET /api/v1/promotions/list Список сегментных акций
POST /api/v1/promotions/update Изменение сегментной акции
POST /api/v0/promotions/activate Активация действия акции (v0, устаревший)
POST /api/v0/promotions/deactivate Деактивация действия акции (v0, устаревший)
POST /api/v0/promotions/delete Удаление действия акции (v0, устаревший)
GET /api/v0/promotions/get Чтение действия акции по id (v0, устаревший)
POST /api/v0/promotions/insert Добавление действия акции (v0, устаревший)
GET /api/v0/promotions/list Список действий акций (v0, устаревший)
POST /api/v0/promotions/update Изменение действия акции (v0, устаревший)
POST /api/v0/promotions_trigger/activate Активация триггерной акции
POST /api/v0/promotions_trigger/deactivate Деактивация триггерной акции
POST /api/v0/promotions_trigger/delete Удаление триггерной акции
GET /api/v0/promotions_trigger/get Чтение триггерной акции по id
POST /api/v0/promotions_trigger/insert Добавление триггерной акции
GET /api/v0/promotions_trigger/list Список триггерных акций
POST /api/v0/promotions_trigger/update Изменение триггерной акции
POST /api/v0/promo_stamps/delete Удаление элемента справочника "Штамипики (N+1)" по указанному id
GET /api/v0/promo_stamps/get Чтение элемента справочника "Штамипики (N+1)" по указанному id
POST /api/v0/promo_stamps/insert Добавление элемента справочника "Штамипики (N+1)"
GET /api/v0/promo_stamps/list Чтение списка элементов справочника "Штамипики (N+1)"
POST /api/v0/promo_stamps/update Обновление элемента справочника "Штамипики (N+1)" по указанному id
POST /api/v0/promocodes/activate Активация промокода по указанному id
POST /api/v0/promocodes/activate_code Активация промокода по коду активации
POST /api/v0/promocodes/deactivate Деактивация промокода по указанному id
POST /api/v0/promocodes/delete Удаление элемента справочника "Промокоды" по указанному id
GET /api/v0/promocodes/get Чтение элемента справочника "Промокоды" по указанному id
POST /api/v0/promocodes/insert Добавление элемента справочника "Промокоды"
GET /api/v0/promocodes/list Чтение списка элементов справочника "Промокоды"
GET /api/v0/promocodes/promocodes_available Получение списка доступных промокодов для счета
POST /api/v0/promocodes/update Обновление элемента справочника "Промокоды" по указанному id
POST /api/v0/segments/delete Удаление сегмента
GET /api/v0/segments/for_copy Получение сегмента для копирования
GET /api/v0/segments/get Чтение сегмента по id
GET /api/v0/segments/get_with_accounts_list Чтение сегмента вместе со списком счетов
POST /api/v0/segments/insert Добавление сегмента
GET /api/v0/segments/list Список сегментов
GET /api/v0/segments/list_by_account_id Сегменты, в которые входит счёт
GET /api/v0/segments/purchases/dishes_cache/list Список блюд из чеков (для сегментов по покупкам)
POST /api/v0/segments/refresh_accounts_list Пересчёт состава сегмента
POST /api/v0/segments/update Изменение сегмента

Сегментные акции (v1)

Получение действия акции для копирования

GET /api/v1/promotions/action_for_copy

Авторизация: требуется

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

Параметр Где Тип Обяз. Описание
id строка запроса integer да Идентификатор объекта

Ответ 200 — объект PromotionActionForCopyResponseDto:

Поле Тип Обяз. Описание
action DiscountTemporaryPromotionActionItemResponseDto или AddBonusesPromotionActionItemResponseDto или MailingPromotionActionItemResponseDto или AddCouponDishPromotionActionItemResponseDto или ResetBonusesPromotionActionItemResponseDto да Действие
segmentId integer Идентификатор сегмента
actuationTime time да

Активация сегментной акции

POST /api/v1/promotions/activate

Авторизация: требуется

Тело запроса — объект IdDto:

Поле Тип Обяз. Описание
id integer да Идентификатор

Ответ 204: без содержимого.

Деактивация сегментной акции

POST /api/v1/promotions/deactivate

Авторизация: требуется

Тело запроса — объект IdDto:

Поле Тип Обяз. Описание
id integer да Идентификатор

Ответ 204: без содержимого.

Удаление сегментной акции

POST /api/v1/promotions/delete

Авторизация: требуется

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

Параметр Где Тип Обяз. Описание
id строка запроса integer да Идентификатор объекта

Ответ 204: без содержимого.

Получение сегментной акции для копирования

GET /api/v1/promotions/for_copy

Авторизация: требуется

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

Параметр Где Тип Обяз. Описание
id строка запроса integer да Идентификатор объекта

Ответ 200 — объект PromotionResponseDto:

Поле Тип Обяз. Описание
id integer да Идентификатор акции
name string да Наименование
dateStart date да Дата начала
dateStop date Дата окончания
actuationType SegmentPromotionActuationType да Тип применения (единожды / раз в N дней / в N-й день месяца)
actuationPeriodicity integer Периодичность, дней; больше 0
actuationMonthDate integer День месяца срабатывания; мин. 1; макс. 31
actuationTime time да Время срабатывания
segmentId integer да Сегмент гостей
isActive boolean да Акция активна
actions массив DiscountTemporaryPromotionActionItemResponseDto или AddBonusesPromotionActionItemResponseDto или MailingPromotionActionItemResponseDto или AddCouponDishPromotionActionItemResponseDto или ResetBonusesPromotionActionItemResponseDto да Действия акции
lastActuation datetime Дата и время последнего срабатывания
nextActuation datetime Следующее срабатывание
lastActuationSpentTime number Длительность последнего срабатывания
indefinitely boolean Бессрочно (без срока действия)
segment BaseSegmentWithIdDto Сегмент

Чтение сегментной акции по id

GET /api/v1/promotions/get

Авторизация: требуется

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

Параметр Где Тип Обяз. Описание
id строка запроса integer да Идентификатор объекта

Ответ 200 — объект PromotionResponseDto:

Поле Тип Обяз. Описание
id integer да Идентификатор акции
name string да Наименование
dateStart date да Дата начала
dateStop date Дата окончания
actuationType SegmentPromotionActuationType да Тип применения (единожды / раз в N дней / в N-й день месяца)
actuationPeriodicity integer Периодичность, дней; больше 0
actuationMonthDate integer День месяца срабатывания; мин. 1; макс. 31
actuationTime time да Время срабатывания
segmentId integer да Сегмент гостей
isActive boolean да Акция активна
actions массив DiscountTemporaryPromotionActionItemResponseDto или AddBonusesPromotionActionItemResponseDto или MailingPromotionActionItemResponseDto или AddCouponDishPromotionActionItemResponseDto или ResetBonusesPromotionActionItemResponseDto да Действия акции
lastActuation datetime Дата и время последнего срабатывания
nextActuation datetime Следующее срабатывание
lastActuationSpentTime number Длительность последнего срабатывания
indefinitely boolean Бессрочно (без срока действия)
segment BaseSegmentWithIdDto Сегмент

Добавление сегментной акции

POST /api/v1/promotions/insert

Авторизация: требуется

Тело запроса — объект PromotionInsertDto:

Поле Тип Обяз. Описание
name string да Наименование
dateStart date да Дата начала
dateStop date Дата окончания
actuationType SegmentPromotionActuationType да Тип применения (единожды / раз в N дней / в N-й день месяца)
actuationPeriodicity integer Периодичность, дней; больше 0
actuationMonthDate integer День месяца срабатывания; мин. 1; макс. 31
actuationTime time да Время срабатывания
segmentId integer да Сегмент гостей
isActive boolean да Акция активна
actions массив DiscountTemporaryPromotionActionItemDto или AddBonusesPromotionActionItemDto или MailingPromotionActionItemDto или AddCouponDishPromotionActionItemDto или ResetBonusesPromotionActionItemDto да Действия акции

Ответ 200 — объект PromotionResponseDto:

Поле Тип Обяз. Описание
id integer да Идентификатор акции
name string да Наименование
dateStart date да Дата начала
dateStop date Дата окончания
actuationType SegmentPromotionActuationType да Тип применения (единожды / раз в N дней / в N-й день месяца)
actuationPeriodicity integer Периодичность, дней; больше 0
actuationMonthDate integer День месяца срабатывания; мин. 1; макс. 31
actuationTime time да Время срабатывания
segmentId integer да Сегмент гостей
isActive boolean да Акция активна
actions массив DiscountTemporaryPromotionActionItemResponseDto или AddBonusesPromotionActionItemResponseDto или MailingPromotionActionItemResponseDto или AddCouponDishPromotionActionItemResponseDto или ResetBonusesPromotionActionItemResponseDto да Действия акции
lastActuation datetime Дата и время последнего срабатывания
nextActuation datetime Следующее срабатывание
lastActuationSpentTime number Длительность последнего срабатывания
indefinitely boolean Бессрочно (без срока действия)
segment BaseSegmentWithIdDto Сегмент

Список сегментных акций

GET /api/v1/promotions/list

Авторизация: требуется

Ответ 200 — массив объектов PromotionResponseDto:

Поле Тип Обяз. Описание
id integer да Идентификатор акции
name string да Наименование
dateStart date да Дата начала
dateStop date Дата окончания
actuationType SegmentPromotionActuationType да Тип применения (единожды / раз в N дней / в N-й день месяца)
actuationPeriodicity integer Периодичность, дней; больше 0
actuationMonthDate integer День месяца срабатывания; мин. 1; макс. 31
actuationTime time да Время срабатывания
segmentId integer да Сегмент гостей
isActive boolean да Акция активна
actions массив DiscountTemporaryPromotionActionItemResponseDto или AddBonusesPromotionActionItemResponseDto или MailingPromotionActionItemResponseDto или AddCouponDishPromotionActionItemResponseDto или ResetBonusesPromotionActionItemResponseDto да Действия акции
lastActuation datetime Дата и время последнего срабатывания
nextActuation datetime Следующее срабатывание
lastActuationSpentTime number Длительность последнего срабатывания
indefinitely boolean Бессрочно (без срока действия)
segment BaseSegmentWithIdDto Сегмент

Изменение сегментной акции

POST /api/v1/promotions/update

Авторизация: требуется

Тело запроса — объект PromotionUpdateDto:

Поле Тип Обяз. Описание
name string да Наименование
dateStart date да Дата начала
dateStop date Дата окончания
actuationType SegmentPromotionActuationType да Тип применения (единожды / раз в N дней / в N-й день месяца)
actuationPeriodicity integer Периодичность, дней; больше 0
actuationMonthDate integer День месяца срабатывания; мин. 1; макс. 31
actuationTime time да Время срабатывания
segmentId integer да Сегмент гостей
isActive boolean да Акция активна
actions массив DiscountTemporaryPromotionActionItemDto или AddBonusesPromotionActionItemDto или MailingPromotionActionItemDto или AddCouponDishPromotionActionItemDto или ResetBonusesPromotionActionItemDto да Действия акции
id integer да Идентификатор акции
resetLastActuation boolean

Ответ 200 — объект PromotionResponseDto:

Поле Тип Обяз. Описание
id integer да Идентификатор акции
name string да Наименование
dateStart date да Дата начала
dateStop date Дата окончания
actuationType SegmentPromotionActuationType да Тип применения (единожды / раз в N дней / в N-й день месяца)
actuationPeriodicity integer Периодичность, дней; больше 0
actuationMonthDate integer День месяца срабатывания; мин. 1; макс. 31
actuationTime time да Время срабатывания
segmentId integer да Сегмент гостей
isActive boolean да Акция активна
actions массив DiscountTemporaryPromotionActionItemResponseDto или AddBonusesPromotionActionItemResponseDto или MailingPromotionActionItemResponseDto или AddCouponDishPromotionActionItemResponseDto или ResetBonusesPromotionActionItemResponseDto да Действия акции
lastActuation datetime Дата и время последнего срабатывания
nextActuation datetime Следующее срабатывание
lastActuationSpentTime number Длительность последнего срабатывания
indefinitely boolean Бессрочно (без срока действия)
segment BaseSegmentWithIdDto Сегмент

Действия акций (v0, устаревший формат)

Активация действия акции (v0, устаревший)

POST /api/v0/promotions/activate

Авторизация: требуется

Ответ 200: JSON (структура в схеме не описана).

Дополнительные коды ответа: 410 — Gone.

Деактивация действия акции (v0, устаревший)

POST /api/v0/promotions/deactivate

Авторизация: требуется

Ответ 200: JSON (структура в схеме не описана).

Дополнительные коды ответа: 410 — Gone.

Удаление действия акции (v0, устаревший)

POST /api/v0/promotions/delete

Авторизация: требуется

Ответ 200: JSON (структура в схеме не описана).

Дополнительные коды ответа: 410 — Gone.

Чтение действия акции по id (v0, устаревший)

GET /api/v0/promotions/get

Авторизация: требуется

Ответ 200: JSON (структура в схеме не описана).

Дополнительные коды ответа: 410 — Gone.

Добавление действия акции (v0, устаревший)

POST /api/v0/promotions/insert

Авторизация: требуется

Устаревший формат: одна акция — одно действие. Для новых интеграций используйте методы /api/v1/promotions/*.

Ответ 200: JSON (структура в схеме не описана).

Дополнительные коды ответа: 410 — Gone.

Список действий акций (v0, устаревший)

GET /api/v0/promotions/list

Авторизация: требуется

Ответ 200: JSON (структура в схеме не описана).

Дополнительные коды ответа: 410 — Gone.

Изменение действия акции (v0, устаревший)

POST /api/v0/promotions/update

Авторизация: требуется

Ответ 200: JSON (структура в схеме не описана).

Дополнительные коды ответа: 410 — Gone.

Триггерные акции

Активация триггерной акции

POST /api/v0/promotions_trigger/activate

Авторизация: требуется

Тело запроса — объект IdDto:

Поле Тип Обяз. Описание
id integer да Идентификатор

Ответ 204: без содержимого.

Деактивация триггерной акции

POST /api/v0/promotions_trigger/deactivate

Авторизация: требуется

Тело запроса — объект IdDto:

Поле Тип Обяз. Описание
id integer да Идентификатор

Ответ 204: без содержимого.

Удаление триггерной акции

POST /api/v0/promotions_trigger/delete

Авторизация: требуется

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

Параметр Где Тип Обяз. Описание
id строка запроса integer да Идентификатор объекта

Ответ 204: без содержимого.

Чтение триггерной акции по id

GET /api/v0/promotions_trigger/get

Авторизация: требуется

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

Параметр Где Тип Обяз. Описание
id строка запроса integer да Идентификатор объекта

Ответ 200 — WalletUpdatePromotionTriggerResponseDto или ReferralProgramRewardPromotionTriggerResponseDto или ReferralProgramRegistrationNotificationPromotionTriggerResponseDto или PromoStampPromotionTriggerResponseDto.

Добавление триггерной акции

POST /api/v0/promotions_trigger/insert

Авторизация: требуется

Тело запроса — WalletUpdatePromotionTriggerInsertDto или ReferralProgramRewardPromotionTriggerInsertDto или ReferralProgramRegistrationNotificationPromotionTriggerInsertDto или PromoStampPromotionTriggerInsertDto.

Ответ 200 — WalletUpdatePromotionTriggerResponseDto или ReferralProgramRewardPromotionTriggerResponseDto или ReferralProgramRegistrationNotificationPromotionTriggerResponseDto или PromoStampPromotionTriggerResponseDto.

Список триггерных акций

GET /api/v0/promotions_trigger/list

Авторизация: требуется

Ответ 200 — массив WalletUpdatePromotionTriggerResponseDto или ReferralProgramRewardPromotionTriggerResponseDto или ReferralProgramRegistrationNotificationPromotionTriggerResponseDto или PromoStampPromotionTriggerResponseDto.

Изменение триггерной акции

POST /api/v0/promotions_trigger/update

Авторизация: требуется

Тело запроса — WalletUpdatePromotionTriggerUpdateDto или ReferralProgramRewardPromotionTriggerUpdateDto или ReferralProgramRegistrationNotificationPromotionTriggerUpdateDto или PromoStampPromotionTriggerUpdateDto.

Ответ 200 — WalletUpdatePromotionTriggerResponseDto или ReferralProgramRewardPromotionTriggerResponseDto или ReferralProgramRegistrationNotificationPromotionTriggerResponseDto или PromoStampPromotionTriggerResponseDto.

Штампики (N+1)

Удаление элемента справочника "Штамипики (N+1)" по указанному id

POST /api/v0/promo_stamps/delete

Авторизация: требуется

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

Параметр Где Тип Обяз. Описание
id строка запроса integer Идентификатор объекта

Ответ 200: JSON (структура в схеме не описана).

Чтение элемента справочника "Штамипики (N+1)" по указанному id

GET /api/v0/promo_stamps/get

Авторизация: требуется

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

Параметр Где Тип Обяз. Описание
id строка запроса integer Идентификатор объекта

Ответ 200 — объект PromoStampsDto:

Поле Тип Обяз. Описание
name string(20) да Наименование (до 20 символов)
dateStart date да Начало действия
dateStop date Окончание действия (NULL — бессрочно)
promoDishCodes массив integer Коды акционных блюд
giftDishes массив PromoStampGiftDish Подарочные блюда
discountCode integer да Код скидки r_keeper для подарочного блюда (уникальная для каждой акции)
promoDishCount integer да «Порций купить» — N, количество акционных блюд для получения подарка
giftDishCount integer да «Подарочных порций» — количество подарков за цикл
hideProgressWithoutActivity boolean Не показывать прогресс гостям без покупок по акции; по умолчанию false
id integer да Идентификатор акции
isDeleted boolean да Признак удаления
accountGroups массив AccountGroupListItemDto да Группы счетов
restaurants массив RestaurantListItemDto да Рестораны

Добавление элемента справочника "Штамипики (N+1)"

POST /api/v0/promo_stamps/insert

Авторизация: требуется

Тело запроса — объект PromoStampsInsertDto:

Поле Тип Обяз. Описание
name string(20) да Наименование (до 20 символов)
dateStart date да Начало действия
dateStop date Окончание действия (NULL — бессрочно)
promoDishCodes массив integer Коды акционных блюд
giftDishes массив PromoStampGiftDish Подарочные блюда
discountCode integer да Код скидки r_keeper для подарочного блюда (уникальная для каждой акции)
promoDishCount integer да «Порций купить» — N, количество акционных блюд для получения подарка
giftDishCount integer да «Подарочных порций» — количество подарков за цикл
hideProgressWithoutActivity boolean Не показывать прогресс гостям без покупок по акции; по умолчанию false
accountGroups массив IdDto да Группы счетов
restaurants массив IdDto да Рестораны

Ответ 200 — объект PromoStampsDto:

Поле Тип Обяз. Описание
name string(20) да Наименование (до 20 символов)
dateStart date да Начало действия
dateStop date Окончание действия (NULL — бессрочно)
promoDishCodes массив integer Коды акционных блюд
giftDishes массив PromoStampGiftDish Подарочные блюда
discountCode integer да Код скидки r_keeper для подарочного блюда (уникальная для каждой акции)
promoDishCount integer да «Порций купить» — N, количество акционных блюд для получения подарка
giftDishCount integer да «Подарочных порций» — количество подарков за цикл
hideProgressWithoutActivity boolean Не показывать прогресс гостям без покупок по акции; по умолчанию false
id integer да Идентификатор акции
isDeleted boolean да Признак удаления
accountGroups массив AccountGroupListItemDto да Группы счетов
restaurants массив RestaurantListItemDto да Рестораны

Чтение списка элементов справочника "Штамипики (N+1)"

GET /api/v0/promo_stamps/list

Авторизация: требуется

Ответ 200 — массив объектов PromoStampsDto:

Поле Тип Обяз. Описание
name string(20) да Наименование (до 20 символов)
dateStart date да Начало действия
dateStop date Окончание действия (NULL — бессрочно)
promoDishCodes массив integer Коды акционных блюд
giftDishes массив PromoStampGiftDish Подарочные блюда
discountCode integer да Код скидки r_keeper для подарочного блюда (уникальная для каждой акции)
promoDishCount integer да «Порций купить» — N, количество акционных блюд для получения подарка
giftDishCount integer да «Подарочных порций» — количество подарков за цикл
hideProgressWithoutActivity boolean Не показывать прогресс гостям без покупок по акции; по умолчанию false
id integer да Идентификатор акции
isDeleted boolean да Признак удаления
accountGroups массив AccountGroupListItemDto да Группы счетов
restaurants массив RestaurantListItemDto да Рестораны

Обновление элемента справочника "Штамипики (N+1)" по указанному id

POST /api/v0/promo_stamps/update

Авторизация: требуется

Тело запроса — объект PromoStampsUpdateDto:

Поле Тип Обяз. Описание
name string(20) да Наименование (до 20 символов)
dateStart date да Начало действия
dateStop date Окончание действия (NULL — бессрочно)
promoDishCodes массив integer Коды акционных блюд
giftDishes массив PromoStampGiftDish Подарочные блюда
discountCode integer да Код скидки r_keeper для подарочного блюда (уникальная для каждой акции)
promoDishCount integer да «Порций купить» — N, количество акционных блюд для получения подарка
giftDishCount integer да «Подарочных порций» — количество подарков за цикл
hideProgressWithoutActivity boolean Не показывать прогресс гостям без покупок по акции; по умолчанию false
accountGroups массив IdDto да Группы счетов
restaurants массив IdDto да Рестораны
id integer да Идентификатор акции

Ответ 200 — объект PromoStampsDto:

Поле Тип Обяз. Описание
name string(20) да Наименование (до 20 символов)
dateStart date да Начало действия
dateStop date Окончание действия (NULL — бессрочно)
promoDishCodes массив integer Коды акционных блюд
giftDishes массив PromoStampGiftDish Подарочные блюда
discountCode integer да Код скидки r_keeper для подарочного блюда (уникальная для каждой акции)
promoDishCount integer да «Порций купить» — N, количество акционных блюд для получения подарка
giftDishCount integer да «Подарочных порций» — количество подарков за цикл
hideProgressWithoutActivity boolean Не показывать прогресс гостям без покупок по акции; по умолчанию false
id integer да Идентификатор акции
isDeleted boolean да Признак удаления
accountGroups массив AccountGroupListItemDto да Группы счетов
restaurants массив RestaurantListItemDto да Рестораны

Промокоды

Активация промокода по указанному id

POST /api/v0/promocodes/activate

Авторизация: требуется

Тело запроса — объект IdDto:

Поле Тип Обяз. Описание
id integer да Идентификатор

Ответ 204: без содержимого.

Активация промокода по коду активации

POST /api/v0/promocodes/activate_code

Авторизация: требуется

Тело запроса — объект PromocodeActivationRequest:

Поле Тип Обяз. Описание
accountId integer да Счёт гостя
activationPhrase string да

Ответ 200 — объект PromocodeActivationResponse:

Поле Тип Обяз. Описание
success boolean да Признак успешного выполнения
message string да Сообщение
promotionActionId integer Действие-промокод

Деактивация промокода по указанному id

POST /api/v0/promocodes/deactivate

Авторизация: требуется

Тело запроса — объект IdDto:

Поле Тип Обяз. Описание
id integer да Идентификатор

Ответ 204: без содержимого.

Удаление элемента справочника "Промокоды" по указанному id

POST /api/v0/promocodes/delete

Авторизация: требуется

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

Параметр Где Тип Обяз. Описание
id строка запроса integer да Идентификатор объекта

Ответ 204: без содержимого.

Чтение элемента справочника "Промокоды" по указанному id

GET /api/v0/promocodes/get

Авторизация: требуется

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

Параметр Где Тип Обяз. Описание
id строка запроса integer да Идентификатор объекта

Ответ 200 — объект PromocodeResponseDto:

Поле Тип Обяз. Описание
type PromotionType да Тип
name string да Наименование
dateStart date да Дата начала
dateStop date Дата окончания
parameters AddCouponDishPromotionParametersResponseDto или AddBonusesPromotionParametersResponseDto или DiscountTemporaryPromotionParametersResponseDto Параметры (JSON)
isActive boolean да Активен
activationPhrase string да мин. длина 1
activationMessage string
accountGroupIds массив integer Список идентификаторов групп счетов
id integer да Идентификатор
activationType integer
lastActuation datetime
nextActuation datetime Следующее срабатывание
lastActuationSpentTime number
indefinitely boolean Бессрочно (без срока действия)

Добавление элемента справочника "Промокоды"

POST /api/v0/promocodes/insert

Авторизация: требуется

Тело запроса — DiscountTemporaryPromocodeDto или AddBonusesPromocodeDto или AddCouponDishPromocodeDto.

Ответ 200 — объект PromocodeResponseDto:

Поле Тип Обяз. Описание
type PromotionType да Тип
name string да Наименование
dateStart date да Дата начала
dateStop date Дата окончания
parameters AddCouponDishPromotionParametersResponseDto или AddBonusesPromotionParametersResponseDto или DiscountTemporaryPromotionParametersResponseDto Параметры (JSON)
isActive boolean да Активен
activationPhrase string да мин. длина 1
activationMessage string
accountGroupIds массив integer Список идентификаторов групп счетов
id integer да Идентификатор
activationType integer
lastActuation datetime
nextActuation datetime Следующее срабатывание
lastActuationSpentTime number
indefinitely boolean Бессрочно (без срока действия)

Чтение списка элементов справочника "Промокоды"

GET /api/v0/promocodes/list

Авторизация: требуется

Ответ 200 — массив объектов PromocodeResponseDto:

Поле Тип Обяз. Описание
type PromotionType да Тип
name string да Наименование
dateStart date да Дата начала
dateStop date Дата окончания
parameters AddCouponDishPromotionParametersResponseDto или AddBonusesPromotionParametersResponseDto или DiscountTemporaryPromotionParametersResponseDto Параметры (JSON)
isActive boolean да Активен
activationPhrase string да мин. длина 1
activationMessage string
accountGroupIds массив integer Список идентификаторов групп счетов
id integer да Идентификатор
activationType integer
lastActuation datetime
nextActuation datetime Следующее срабатывание
lastActuationSpentTime number
indefinitely boolean Бессрочно (без срока действия)

Получение списка доступных промокодов для счета

GET /api/v0/promocodes/promocodes_available

Авторизация: требуется

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

Параметр Где Тип Обяз. Описание
account_id строка запроса string да Account identifier (card number, phone, etc.)

Ответ 200 — объект PromocodeAvailableResponse:

Поле Тип Обяз. Описание
promocodesAvailable boolean да Доступные промокоды

Обновление элемента справочника "Промокоды" по указанному id

POST /api/v0/promocodes/update

Авторизация: требуется

Тело запроса — DiscountTemporaryPromocodeUpdateDto или AddBonusesPromocodeUpdateDto или AddCouponDishPromocodeUpdateDto.

Ответ 200 — объект PromocodeResponseDto:

Поле Тип Обяз. Описание
type PromotionType да Тип
name string да Наименование
dateStart date да Дата начала
dateStop date Дата окончания
parameters AddCouponDishPromotionParametersResponseDto или AddBonusesPromotionParametersResponseDto или DiscountTemporaryPromotionParametersResponseDto Параметры (JSON)
isActive boolean да Активен
activationPhrase string да мин. длина 1
activationMessage string
accountGroupIds массив integer Список идентификаторов групп счетов
id integer да Идентификатор
activationType integer
lastActuation datetime
nextActuation datetime Следующее срабатывание
lastActuationSpentTime number
indefinitely boolean Бессрочно (без срока действия)

Сегменты

Удаление сегмента

POST /api/v0/segments/delete

Авторизация: требуется

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

Параметр Где Тип Обяз. Описание
id строка запроса integer да Идентификатор объекта
delete_related_promotions строка запроса boolean Удалить также акции, использующие сегмент; по умолчанию false

Ответ 204: без содержимого.

Получение сегмента для копирования

GET /api/v0/segments/for_copy

Авторизация: требуется

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

Параметр Где Тип Обяз. Описание
id строка запроса integer да Идентификатор объекта

Ответ 200 — IdleAccountsSegmentResponseDto или TopGuestsSegmentResponseDto или BonusBurnSegmentResponseDto или BirthdaySegmentResponseDto или SexAgeAccountGroupSegmentResponseDto или AllGuestsSegmentResponseDto или BonusesLeftSegmentResponseDto или ManualByListSegmentResponseDto или ManualBySelectedAccountsSegmentResponseDto или CompositeSegmentResponseDto или PurchasesSegmentResponseDto.

Чтение сегмента по id

GET /api/v0/segments/get

Авторизация: требуется

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

Параметр Где Тип Обяз. Описание
id строка запроса integer да Идентификатор объекта

Ответ 200 — IdleAccountsSegmentResponseDto или TopGuestsSegmentResponseDto или BonusBurnSegmentResponseDto или BirthdaySegmentResponseDto или SexAgeAccountGroupSegmentResponseDto или AllGuestsSegmentResponseDto или BonusesLeftSegmentResponseDto или ManualByListSegmentResponseDto или ManualBySelectedAccountsSegmentResponseDto или CompositeSegmentResponseDto или PurchasesSegmentResponseDto.

Чтение сегмента вместе со списком счетов

GET /api/v0/segments/get_with_accounts_list

Авторизация: требуется

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

Параметр Где Тип Обяз. Описание
id строка запроса integer да Идентификатор объекта

Ответ 200 — IdleAccountsSegmentResponseWithAccountsListDto или BonusBurnSegmentResponseWithAccountsListDto или BirthdaySegmentResponseWithAccountsListDto или SexAgeAccountGroupSegmentResponseWithAccountsListDto или AllGuestsSegmentResponseWithAccountsListDto или TopGuestsSegmentResponseWithAccountsListDto или BonusesLeftSegmentResponseWithAccountsListDto или ManualByListSegmentResponseWithAccountsListDto или ManualBySelectedAccountsSegmentResponseWithAccountsListDto или CompositeSegmentResponseWithAccountsListDto или PurchasesSegmentResponseWithAccountsListDto.

Добавление сегмента

POST /api/v0/segments/insert

Авторизация: требуется

Тело запроса — IdleAccountsSegmentDto или TopGuestsSegmentDto или BonusBurnSegmentDto или BirthdaySegmentDto или SexAgeAccountGroupSegmentDto или BonusesLeftSegmentDto или ManualByListSegmentDto или ManualBySelectedAccountsSegmentDto или CompositeSegmentDto или PurchasesSegmentDto.

Ответ 200 — IdleAccountsSegmentResponseDto или TopGuestsSegmentResponseDto или BonusBurnSegmentResponseDto или BirthdaySegmentResponseDto или SexAgeAccountGroupSegmentResponseDto или AllGuestsSegmentResponseDto или BonusesLeftSegmentResponseDto или ManualByListSegmentResponseDto или ManualBySelectedAccountsSegmentResponseDto или CompositeSegmentResponseDto или PurchasesSegmentResponseDto.

Список сегментов

GET /api/v0/segments/list

Авторизация: требуется

Ответ 200 — массив объектов BaseSegmentWithAccountsCountDto:

Поле Тип Обяз. Описание
name string да Наименование
type integer да Тип
parameters object или object Параметры (JSON)
id integer да Идентификатор
lastUpdate datetime Дата последнего пересчёта состава
system boolean да Системный элемент
relatedPromotions массив SegmentRelatedPromotionDto Акции, связанные с объектом
accountsCount integer да Количество счетов
percentOfTotalAccounts string да Доля от общего числа счетов, %

Сегменты, в которые входит счёт

GET /api/v0/segments/list_by_account_id

Авторизация: требуется

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

Параметр Где Тип Обяз. Описание
account_id строка запроса integer да Идентификатор счёта

Ответ 200 — массив объектов BaseSegmentWithAccountsCountDto:

Поле Тип Обяз. Описание
name string да Наименование
type integer да Тип
parameters object или object Параметры (JSON)
id integer да Идентификатор
lastUpdate datetime Дата последнего пересчёта состава
system boolean да Системный элемент
relatedPromotions массив SegmentRelatedPromotionDto Акции, связанные с объектом
accountsCount integer да Количество счетов
percentOfTotalAccounts string да Доля от общего числа счетов, %

Список блюд из чеков (для сегментов по покупкам)

GET /api/v0/segments/purchases/dishes_cache/list

Авторизация: требуется

Ответ 200 — массив объектов PurchasesDishCacheItemDto:

Поле Тип Обяз. Описание
name string да Наименование

Пересчёт состава сегмента

POST /api/v0/segments/refresh_accounts_list

Авторизация: требуется

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

Параметр Где Тип Обяз. Описание
id строка запроса integer да Идентификатор объекта

Ответ 200 — IdleAccountsSegmentResponseDto или TopGuestsSegmentResponseDto или BonusBurnSegmentResponseDto или BirthdaySegmentResponseDto или SexAgeAccountGroupSegmentResponseDto или AllGuestsSegmentResponseDto или BonusesLeftSegmentResponseDto или ManualByListSegmentResponseDto или ManualBySelectedAccountsSegmentResponseDto или CompositeSegmentResponseDto или PurchasesSegmentResponseDto.

Изменение сегмента

POST /api/v0/segments/update

Авторизация: требуется

Тело запроса — IdleAccountsSegmentUpdateDto или TopGuestsSegmentUpdateDto или BonusBurnSegmentUpdateDto или BirthdaySegmentUpdateDto или SexAgeAccountGroupSegmentUpdateDto или BonusesLeftSegmentUpdateDto или CompositeSegmentUpdateDto или PurchasesSegmentUpdateDto.

Ответ 200 — IdleAccountsSegmentResponseDto или TopGuestsSegmentResponseDto или BonusBurnSegmentResponseDto или BirthdaySegmentResponseDto или SexAgeAccountGroupSegmentResponseDto или AllGuestsSegmentResponseDto или BonusesLeftSegmentResponseDto или ManualByListSegmentResponseDto или ManualBySelectedAccountsSegmentResponseDto или CompositeSegmentResponseDto или PurchasesSegmentResponseDto.

Модели данных

Вложенные объекты и перечисления, на которые ссылаются методы этого раздела.

AccountGroupListItemDto

Поле Тип Обяз. Описание
id integer да Идентификатор группы
name string(100) да Наименование группы
haveTemplate boolean да

AddBonusesPromocodeDto

Поле Тип Обяз. Описание
type integer Тип
name string да Наименование
dateStart date да Дата начала
dateStop date Дата окончания
parameters AddBonusesPromotionParametersDto да Параметры (JSON)
isActive boolean да Активен
activationPhrase string да мин. длина 1
activationMessage string
accountGroupIds массив integer Список идентификаторов групп счетов

AddBonusesPromocodeUpdateDto

Поле Тип Обяз. Описание
type integer Тип
name string да Наименование
dateStart date да Дата начала
dateStop date Дата окончания
parameters AddBonusesPromotionParametersDto да Параметры (JSON)
isActive boolean да Активен
activationPhrase string да мин. длина 1
activationMessage string
accountGroupIds массив integer Список идентификаторов групп счетов
id integer да Идентификатор

AddBonusesPromotionActionItemDto

Поле Тип Обяз. Описание
id integer Идентификатор
delayMinutes integer Сдвиг запуска относительно начала акции, минут; мин. 0; макс. 720; по умолчанию 0
type integer Тип
parameters AddBonusesPromotionParametersDto да Параметры (JSON)

AddBonusesPromotionActionItemResponseDto

Поле Тип Обяз. Описание
id integer Идентификатор
delayMinutes integer Сдвиг запуска относительно начала акции, минут; мин. 0; макс. 720; по умолчанию 0
type integer Тип
parameters AddBonusesPromotionParametersResponseDto да Параметры (JSON)

AddBonusesPromotionParametersDto

Поле Тип Обяз. Описание
amount number да Сумма, руб.
lateIssueDays integer Отложенное начисление: через сколько дней бонусы станут доступны; больше 0
lifetimeType BonusLifetimeType Тип срока жизни бонусов; по умолчанию 1
lifetime integer Срок жизни начисленных бонусов, дней; мин. 1

AddBonusesPromotionParametersResponseDto

Поле Тип Обяз. Описание
amount number да Сумма, руб.
lateIssueDays integer Отложенное начисление: через сколько дней бонусы станут доступны; больше 0
lifetimeType BonusLifetimeType Тип срока жизни бонусов; по умолчанию 1
lifetime integer Срок жизни начисленных бонусов, дней; мин. 1

AddCouponDishPromocodeDto

Поле Тип Обяз. Описание
type integer Тип
name string да Наименование
dateStart date да Дата начала
dateStop date Дата окончания
parameters AddCouponDishPromotionParametersDto да Параметры (JSON)
isActive boolean да Активен
activationPhrase string да мин. длина 1
activationMessage string
accountGroupIds массив integer Список идентификаторов групп счетов

AddCouponDishPromocodeUpdateDto

Поле Тип Обяз. Описание
type integer Тип
name string да Наименование
dateStart date да Дата начала
dateStop date Дата окончания
parameters AddCouponDishPromotionParametersDto да Параметры (JSON)
isActive boolean да Активен
activationPhrase string да мин. длина 1
activationMessage string
accountGroupIds массив integer Список идентификаторов групп счетов
id integer да Идентификатор

AddCouponDishPromotionActionItemDto

Поле Тип Обяз. Описание
id integer Идентификатор
delayMinutes integer Сдвиг запуска относительно начала акции, минут; мин. 0; макс. 720; по умолчанию 0
type integer Тип
parameters AddCouponDishPromotionParametersDto да Параметры (JSON)

AddCouponDishPromotionActionItemResponseDto

Поле Тип Обяз. Описание
id integer Идентификатор
delayMinutes integer Сдвиг запуска относительно начала акции, минут; мин. 0; макс. 720; по умолчанию 0
type integer Тип
parameters AddCouponDishPromotionParametersResponseDto да Параметры (JSON)

AddCouponDishPromotionParametersDto

Поле Тип Обяз. Описание
lifetime integer Срок жизни начисленных бонусов, дней; мин. 1
couponId integer да Идентификатор купона

AddCouponDishPromotionParametersResponseDto

Поле Тип Обяз. Описание
lifetime integer Срок жизни начисленных бонусов, дней; мин. 1
couponId integer да Идентификатор купона
isLifetime boolean Бессрочно

AllGuestsSegmentResponseDto

Поле Тип Обяз. Описание
name string да Наименование
type integer Тип
parameters object или object Параметры (JSON)
id integer да Идентификатор
lastUpdate datetime Дата последнего пересчёта состава
system boolean да Системный элемент
relatedPromotions массив SegmentRelatedPromotionDto Акции, связанные с объектом

AllGuestsSegmentResponseWithAccountsListDto

Поле Тип Обяз. Описание
name string да Наименование
type integer Тип
parameters object или object Параметры (JSON)
id integer да Идентификатор
lastUpdate datetime Дата последнего пересчёта состава
system boolean да Системный элемент
relatedPromotions массив SegmentRelatedPromotionDto Акции, связанные с объектом
accounts массив BaseSegmentResponseAccountListItemDto да Список счетов

BaseSegmentResponseAccountListItemDto

Поле Тип Обяз. Описание
accountId integer да Идентификатор счёта
fullName string да ФИО гостя
phone string Номер телефона
email string Адрес e-mail
accountGroupName string да Наименование группы счетов
accountGroupId integer да Идентификатор группы счетов

BaseSegmentWithIdDto

Поле Тип Обяз. Описание
name string да Наименование
type integer да Тип
parameters object или object Параметры (JSON)
id integer да Идентификатор

BirthdaySegmentDto

Поле Тип Обяз. Описание
name string да Наименование
type integer Тип
parameters BirthdaySegmentParametersDto да Параметры (JSON)

BirthdaySegmentParametersDto

Поле Тип Обяз. Описание
accountGroupIds массив integer Список идентификаторов групп счетов
birthdayInDays integer да День рождения через N дней

BirthdaySegmentParametersResponseDto

Поле Тип Обяз. Описание
accountGroupIds массив integer Список идентификаторов групп счетов
birthdayInDays integer да День рождения через N дней
allAccountGroups boolean Все группы счетов (без фильтра по группам)

BirthdaySegmentResponseDto

Поле Тип Обяз. Описание
name string да Наименование
type integer Тип
parameters BirthdaySegmentParametersResponseDto да Параметры (JSON)
id integer да Идентификатор
lastUpdate datetime Дата последнего пересчёта состава
system boolean да Системный элемент
relatedPromotions массив SegmentRelatedPromotionDto Акции, связанные с объектом

BirthdaySegmentResponseWithAccountsListDto

Поле Тип Обяз. Описание
name string да Наименование
type integer Тип
parameters BirthdaySegmentParametersResponseDto да Параметры (JSON)
id integer да Идентификатор
lastUpdate datetime Дата последнего пересчёта состава
system boolean да Системный элемент
relatedPromotions массив SegmentRelatedPromotionDto Акции, связанные с объектом
accounts массив BaseSegmentResponseAccountListItemDto да Список счетов

BirthdaySegmentUpdateDto

Поле Тип Обяз. Описание
name string да Наименование
type integer Тип
parameters BirthdaySegmentParametersDto да Параметры (JSON)
id integer да Идентификатор

BonusBurnSegmentDto

Поле Тип Обяз. Описание
name string да Наименование
type integer Тип
parameters BonusBurnSegmentParametersDto да Параметры (JSON)

BonusBurnSegmentParametersDto

Поле Тип Обяз. Описание
accountGroupIds массив integer Список идентификаторов групп счетов
daysToBurn integer да Дней до сгорания бонусов
sumToBurnMoreThen number да Сумма к сгоранию больше, руб.
bonusBalanceMoreThen number да Баланс бонусов больше, руб.

BonusBurnSegmentParametersResponseDto

Поле Тип Обяз. Описание
accountGroupIds массив integer Список идентификаторов групп счетов
daysToBurn integer да Дней до сгорания бонусов
sumToBurnMoreThen number да Сумма к сгоранию больше, руб.
bonusBalanceMoreThen number да Баланс бонусов больше, руб.
allAccountGroups boolean Все группы счетов (без фильтра по группам)

BonusBurnSegmentResponseDto

Поле Тип Обяз. Описание
name string да Наименование
type integer Тип
parameters BonusBurnSegmentParametersResponseDto да Параметры (JSON)
id integer да Идентификатор
lastUpdate datetime Дата последнего пересчёта состава
system boolean да Системный элемент
relatedPromotions массив SegmentRelatedPromotionDto Акции, связанные с объектом

BonusBurnSegmentResponseWithAccountsListDto

Поле Тип Обяз. Описание
name string да Наименование
type integer Тип
parameters BonusBurnSegmentParametersResponseDto да Параметры (JSON)
id integer да Идентификатор
lastUpdate datetime Дата последнего пересчёта состава
system boolean да Системный элемент
relatedPromotions массив SegmentRelatedPromotionDto Акции, связанные с объектом
accounts массив BaseSegmentResponseAccountListItemDto да Список счетов

BonusBurnSegmentUpdateDto

Поле Тип Обяз. Описание
name string да Наименование
type integer Тип
parameters BonusBurnSegmentParametersDto да Параметры (JSON)
id integer да Идентификатор

BonusesLeftSegmentDto

Поле Тип Обяз. Описание
name string да Наименование
type integer Тип
parameters BonusesLeftSegmentParametersDto да Параметры (JSON)

BonusesLeftSegmentParametersDto

Поле Тип Обяз. Описание
accountGroupIds массив integer Список идентификаторов групп счетов
bonusesLeft integer да Остаток бонусов; мин. 0

BonusesLeftSegmentParametersResponseDto

Поле Тип Обяз. Описание
accountGroupIds массив integer Список идентификаторов групп счетов
bonusesLeft integer да Остаток бонусов; мин. 0
allAccountGroups boolean Все группы счетов (без фильтра по группам)

BonusesLeftSegmentResponseDto

Поле Тип Обяз. Описание
name string да Наименование
type integer Тип
parameters BonusesLeftSegmentParametersResponseDto да Параметры (JSON)
id integer да Идентификатор
lastUpdate datetime Дата последнего пересчёта состава
system boolean да Системный элемент
relatedPromotions массив SegmentRelatedPromotionDto Акции, связанные с объектом

BonusesLeftSegmentResponseWithAccountsListDto

Поле Тип Обяз. Описание
name string да Наименование
type integer Тип
parameters BonusesLeftSegmentParametersResponseDto да Параметры (JSON)
id integer да Идентификатор
lastUpdate datetime Дата последнего пересчёта состава
system boolean да Системный элемент
relatedPromotions массив SegmentRelatedPromotionDto Акции, связанные с объектом
accounts массив BaseSegmentResponseAccountListItemDto да Список счетов

BonusesLeftSegmentUpdateDto

Поле Тип Обяз. Описание
name string да Наименование
type integer Тип
parameters BonusesLeftSegmentParametersDto да Параметры (JSON)
id integer да Идентификатор

BonusLifetimeType

Перечисление (integer). Значения: 1, 2, 3.

CompositeSegmentDto

Поле Тип Обяз. Описание
name string да Наименование
type integer Тип
parameters CompositeSegmentParametersDto да Параметры (JSON)

CompositeSegmentParametersDto

Поле Тип Обяз. Описание
accountGroupIds массив integer Список идентификаторов групп счетов
sex integer Пол
fromAge integer Возраст от
toAge integer Возраст до
allRegistrationDates boolean Любая дата регистрации
registrationDateMode integer Режим отбора по дате регистрации
registrationDateValue date Значение для отбора по дате регистрации
registrationDateFrom date Дата регистрации с
registrationDateTo date Дата регистрации по
registrationDaysCount integer Регистрация за последние N дней
birthdayInDays integer День рождения через N дней
spendingFrom number Сумма потрат от, руб.; мин. 0; макс. 999999999.99
spendingTo number Сумма потрат до, руб.; мин. 0; макс. 999999999.99
spendingDaysCount integer Потраты за последние N дней
checksCountFrom integer Количество чеков от; мин. 0
checksCountTo integer Количество чеков до; мин. 0
checksDaysCount integer Чеки за последние N дней; больше 0; макс. 36500
visitsCountFrom integer Количество посещений от; мин. 0
visitsCountTo integer Количество посещений до; мин. 0
visitsDaysCount integer Посещения за последние N дней; больше 0; макс. 36500

CompositeSegmentParametersResponseDto

Поле Тип Обяз. Описание
accountGroupIds массив integer Список идентификаторов групп счетов
sex integer Пол
fromAge integer Возраст от
toAge integer Возраст до
allRegistrationDates boolean Любая дата регистрации
registrationDateMode integer Режим отбора по дате регистрации
registrationDateValue date Значение для отбора по дате регистрации
registrationDateFrom date Дата регистрации с
registrationDateTo date Дата регистрации по
registrationDaysCount integer Регистрация за последние N дней
birthdayInDays integer День рождения через N дней
spendingFrom number Сумма потрат от, руб.; мин. 0; макс. 999999999.99
spendingTo number Сумма потрат до, руб.; мин. 0; макс. 999999999.99
spendingDaysCount integer Потраты за последние N дней
checksCountFrom integer Количество чеков от; мин. 0
checksCountTo integer Количество чеков до; мин. 0
checksDaysCount integer Чеки за последние N дней; больше 0; макс. 36500
visitsCountFrom integer Количество посещений от; мин. 0
visitsCountTo integer Количество посещений до; мин. 0
visitsDaysCount integer Посещения за последние N дней; больше 0; макс. 36500
allAges boolean Все возрасты
allAccountGroups boolean Все группы счетов (без фильтра по группам)
allSexes boolean Любой пол
allBirthdays boolean Любая дата рождения
allSpendings boolean Любая сумма потрат
allChecks boolean Любое количество чеков
allVisits boolean Любое количество посещений

CompositeSegmentResponseDto

Поле Тип Обяз. Описание
name string да Наименование
type integer Тип
parameters CompositeSegmentParametersResponseDto да Параметры (JSON)
id integer да Идентификатор
lastUpdate datetime Дата последнего пересчёта состава
system boolean да Системный элемент
relatedPromotions массив SegmentRelatedPromotionDto Акции, связанные с объектом

CompositeSegmentResponseWithAccountsListDto

Поле Тип Обяз. Описание
name string да Наименование
type integer Тип
parameters CompositeSegmentParametersResponseDto да Параметры (JSON)
id integer да Идентификатор
lastUpdate datetime Дата последнего пересчёта состава
system boolean да Системный элемент
relatedPromotions массив SegmentRelatedPromotionDto Акции, связанные с объектом
accounts массив BaseSegmentResponseAccountListItemDto да Список счетов

CompositeSegmentUpdateDto

Поле Тип Обяз. Описание
name string да Наименование
type integer Тип
parameters CompositeSegmentParametersDto да Параметры (JSON)
id integer да Идентификатор

DiscountTemporaryPromocodeDto

Поле Тип Обяз. Описание
type integer Тип
name string да Наименование
dateStart date да Дата начала
dateStop date Дата окончания
parameters DiscountTemporaryPromotionParametersDto да Параметры (JSON)
isActive boolean да Активен
activationPhrase string да мин. длина 1
activationMessage string
accountGroupIds массив integer Список идентификаторов групп счетов

DiscountTemporaryPromocodeUpdateDto

Поле Тип Обяз. Описание
type integer Тип
name string да Наименование
dateStart date да Дата начала
dateStop date Дата окончания
parameters DiscountTemporaryPromotionParametersDto да Параметры (JSON)
isActive boolean да Активен
activationPhrase string да мин. длина 1
activationMessage string
accountGroupIds массив integer Список идентификаторов групп счетов
id integer да Идентификатор

DiscountTemporaryPromotionActionItemDto

Поле Тип Обяз. Описание
id integer Идентификатор
delayMinutes integer Сдвиг запуска относительно начала акции, минут; мин. 0; макс. 720; по умолчанию 0
type integer Тип
parameters DiscountTemporaryPromotionParametersDto да Параметры (JSON)

DiscountTemporaryPromotionActionItemResponseDto

Поле Тип Обяз. Описание
id integer Идентификатор
delayMinutes integer Сдвиг запуска относительно начала акции, минут; мин. 0; макс. 720; по умолчанию 0
type integer Тип
parameters DiscountTemporaryPromotionParametersResponseDto да Параметры (JSON)

DiscountTemporaryPromotionParametersDto

Поле Тип Обяз. Описание
rkCode integer Код скидки (бонуса) r_keeper
rkBonusTypeCode integer Код типа бонуса r_keeper
lifetime integer да Срок жизни начисленных бонусов, дней; мин. 1

DiscountTemporaryPromotionParametersResponseDto

Поле Тип Обяз. Описание
rkCode integer Код скидки (бонуса) r_keeper
rkBonusTypeCode integer Код типа бонуса r_keeper
lifetime integer да Срок жизни начисленных бонусов, дней; мин. 1
isRkCodeBonus boolean Код r_keeper является бонусом (а не скидкой)

IdDto

Поле Тип Обяз. Описание
id integer да Идентификатор

IdleAccountsSegmentDto

Поле Тип Обяз. Описание
name string да Наименование
type integer Тип
parameters IdleAccountsSegmentParametersDto да Параметры (JSON)

IdleAccountsSegmentParametersDto

Поле Тип Обяз. Описание
accountGroupIds массив integer Список идентификаторов групп счетов
lastVisitDays integer да Дней с последнего визита

IdleAccountsSegmentParametersResponseDto

Поле Тип Обяз. Описание
accountGroupIds массив integer Список идентификаторов групп счетов
lastVisitDays integer да Дней с последнего визита
allAccountGroups boolean Все группы счетов (без фильтра по группам)

IdleAccountsSegmentResponseDto

Поле Тип Обяз. Описание
name string да Наименование
type integer Тип
parameters IdleAccountsSegmentParametersResponseDto да Параметры (JSON)
id integer да Идентификатор
lastUpdate datetime Дата последнего пересчёта состава
system boolean да Системный элемент
relatedPromotions массив SegmentRelatedPromotionDto Акции, связанные с объектом

IdleAccountsSegmentResponseWithAccountsListDto

Поле Тип Обяз. Описание
name string да Наименование
type integer Тип
parameters IdleAccountsSegmentParametersResponseDto да Параметры (JSON)
id integer да Идентификатор
lastUpdate datetime Дата последнего пересчёта состава
system boolean да Системный элемент
relatedPromotions массив SegmentRelatedPromotionDto Акции, связанные с объектом
accounts массив BaseSegmentResponseAccountListItemDto да Список счетов

IdleAccountsSegmentUpdateDto

Поле Тип Обяз. Описание
name string да Наименование
type integer Тип
parameters IdleAccountsSegmentParametersDto да Параметры (JSON)
id integer да Идентификатор

MailingChannelType

Перечисление (integer). Значения: 0, 1, 2, 3, 4.

MailingPromotionActionItemDto

Поле Тип Обяз. Описание
id integer Идентификатор
delayMinutes integer Сдвиг запуска относительно начала акции, минут; мин. 0; макс. 720; по умолчанию 0
type integer Тип
parameters MailingPromotionParametersDto да Параметры (JSON)

MailingPromotionActionItemResponseDto

Поле Тип Обяз. Описание
id integer Идентификатор
delayMinutes integer Сдвиг запуска относительно начала акции, минут; мин. 0; макс. 720; по умолчанию 0
type integer Тип
parameters MailingPromotionParametersResponseDto да Параметры (JSON)

MailingPromotionParametersDto

Поле Тип Обяз. Описание
textTemplate string Шаблон сообщения; подстановки {promo_stamp_name}, {event_kind}, {stamp_progress}
channels массив MailingChannelType да Каналы рассылки
sendByPriority boolean да Отправлять по приоритету каналов
subject string Тема
walletTextTemplate string Шаблон текста для Wallet
buttonEnabled boolean Показывать кнопку; по умолчанию false
buttonText string(256) Текст кнопки
buttonUrl string Ссылка кнопки
media массив string Файлы (изображения)

MailingPromotionParametersResponseDto

Поле Тип Обяз. Описание
textTemplate string Шаблон сообщения; подстановки {promo_stamp_name}, {event_kind}, {stamp_progress}
channels массив MailingChannelType да Каналы рассылки
sendByPriority boolean да Отправлять по приоритету каналов
subject string Тема
walletTextTemplate string Шаблон текста для Wallet
buttonEnabled boolean Показывать кнопку; по умолчанию false
buttonText string(256) Текст кнопки
buttonUrl string Ссылка кнопки
mediaIds массив integer Список идентификаторов файлов
media массив string Файлы (изображения)

ManualByListSegmentDto

Поле Тип Обяз. Описание
name string да Наименование
type integer Тип
parameters ManualByListSegmentParametersDto да Параметры (JSON)

ManualByListSegmentParametersDto

Поле Тип Обяз. Описание
accountGroupIds массив integer Список идентификаторов групп счетов
searchField ManualByListSegmentSearchField да Поле для поиска
searchItems массив string да Строки для поиска
exactMatch boolean да Точное совпадение

ManualByListSegmentParametersResponseDto

Поле Тип Обяз. Описание
accountGroupIds массив integer Список идентификаторов групп счетов
searchField ManualByListSegmentSearchField да Поле для поиска
searchItems массив string да Строки для поиска
exactMatch boolean да Точное совпадение
allAccountGroups boolean Все группы счетов (без фильтра по группам)

ManualByListSegmentResponseDto

Поле Тип Обяз. Описание
name string да Наименование
type integer Тип
parameters ManualByListSegmentParametersResponseDto да Параметры (JSON)
id integer да Идентификатор
lastUpdate datetime Дата последнего пересчёта состава
system boolean да Системный элемент
relatedPromotions массив SegmentRelatedPromotionDto Акции, связанные с объектом

ManualByListSegmentResponseWithAccountsListDto

Поле Тип Обяз. Описание
name string да Наименование
type integer Тип
parameters ManualByListSegmentParametersResponseDto да Параметры (JSON)
id integer да Идентификатор
lastUpdate datetime Дата последнего пересчёта состава
system boolean да Системный элемент
relatedPromotions массив SegmentRelatedPromotionDto Акции, связанные с объектом
accounts массив BaseSegmentResponseAccountListItemDto да Список счетов

ManualByListSegmentSearchField

Перечисление (string). Значения: phone, identifier, additionalInfo, printMessage, screenMessage, fullName.
Поле поиска в сегменте «Ручной по списку»: телефон, идентификатор, доп. информация, сообщение для печати, сообщение для экрана, ФИО

ManualBySelectedAccountsSegmentDto

Поле Тип Обяз. Описание
name string да Наименование
type integer Тип
parameters ManualBySelectedAccountsSegmentParametersDto да Параметры (JSON)

ManualBySelectedAccountsSegmentParametersDto

Поле Тип Обяз. Описание
searchItems массив integer да Строки для поиска

ManualBySelectedAccountsSegmentParametersResponseDto

Поле Тип Обяз. Описание
searchItems массив integer да Строки для поиска

ManualBySelectedAccountsSegmentResponseDto

Поле Тип Обяз. Описание
name string да Наименование
type integer Тип
parameters ManualBySelectedAccountsSegmentParametersResponseDto да Параметры (JSON)
id integer да Идентификатор
lastUpdate datetime Дата последнего пересчёта состава
system boolean да Системный элемент
relatedPromotions массив SegmentRelatedPromotionDto Акции, связанные с объектом

ManualBySelectedAccountsSegmentResponseWithAccountsListDto

Поле Тип Обяз. Описание
name string да Наименование
type integer Тип
parameters ManualBySelectedAccountsSegmentParametersResponseDto да Параметры (JSON)
id integer да Идентификатор
lastUpdate datetime Дата последнего пересчёта состава
system boolean да Системный элемент
relatedPromotions массив SegmentRelatedPromotionDto Акции, связанные с объектом
accounts массив BaseSegmentResponseAccountListItemDto да Список счетов

PromoStampGiftDish

Поле Тип Обяз. Описание
code integer да Код
comment string да Комментарий

PromoStampPromotionTriggerInsertDto

Поле Тип Обяз. Описание
type PromotionTriggerType Тип
name string да Наименование
dateStart date да Дата начала
dateStop date Дата окончания
isActive boolean да Активен
textTemplate string да Шаблон сообщения; подстановки {promo_stamp_name}, {event_kind}, {stamp_progress}
promoStampFilterEnabled boolean Включён фильтр по акциям «Штампики»; по умолчанию false
promoStampIds массив integer Список идентификаторов акций «Штампики»

PromoStampPromotionTriggerResponseDto

Поле Тип Обяз. Описание
type PromotionTriggerType Тип
name string да Наименование
dateStart date да Дата начала
dateStop date Дата окончания
isActive boolean да Активен
id integer да Идентификатор
isSys boolean да Системный триггер
indefinitely boolean Бессрочно (без срока действия)
textTemplate string да Шаблон сообщения; подстановки {promo_stamp_name}, {event_kind}, {stamp_progress}
promoStampFilterEnabled boolean Включён фильтр по акциям «Штампики»; по умолчанию false
promoStampIds массив integer Список идентификаторов акций «Штампики»

PromoStampPromotionTriggerUpdateDto

Поле Тип Обяз. Описание
type PromotionTriggerType Тип
name string да Наименование
dateStart date да Дата начала
dateStop date Дата окончания
isActive boolean да Активен
id integer да Идентификатор
textTemplate string да Шаблон сообщения; подстановки {promo_stamp_name}, {event_kind}, {stamp_progress}
promoStampFilterEnabled boolean Включён фильтр по акциям «Штампики»; по умолчанию false
promoStampIds массив integer Список идентификаторов акций «Штампики»

PromotionTriggerType

Перечисление (integer). Значения: 1, 2, 3, 4.
1 — обновление баланса Wallet-карты, 2 — вознаграждение по реферальной программе, 3 — оповещение о регистрации по реферальной ссылке, 4 — транзакция в акции «Штампики»

PromotionType

Перечисление (integer). Значения: 1, 2, 3, 4, 5.

PurchasesSegmentDto

Поле Тип Обяз. Описание
name string да Наименование
type integer Тип
parameters PurchasesSegmentParametersDto да Параметры (JSON)

PurchasesSegmentParametersDto

Поле Тип Обяз. Описание
accountGroupIds массив integer Список идентификаторов групп счетов
allPurchaseDates boolean Любая дата покупки
purchaseDateMode integer Режим отбора по дате покупки
purchaseDateValue date Значение для отбора по дате покупки
purchaseDateFrom date Дата покупки с
purchaseDateTo date Дата покупки по
purchaseDaysCount integer Покупки за последние N дней
restaurantIds массив integer Список идентификаторов ресторанов
dishNames массив string да Наименования блюд
minPortionsEnabled boolean Учитывать минимальное количество порций; по умолчанию false
minPortions number Минимальное количество порций

PurchasesSegmentParametersResponseDto

Поле Тип Обяз. Описание
accountGroupIds массив integer Список идентификаторов групп счетов
allPurchaseDates boolean Любая дата покупки
purchaseDateMode integer Режим отбора по дате покупки
purchaseDateValue date Значение для отбора по дате покупки
purchaseDateFrom date Дата покупки с
purchaseDateTo date Дата покупки по
purchaseDaysCount integer Покупки за последние N дней
restaurantIds массив integer Список идентификаторов ресторанов
dishNames массив string да Наименования блюд
minPortionsEnabled boolean Учитывать минимальное количество порций; по умолчанию false
minPortions number Минимальное количество порций
allAccountGroups boolean Все группы счетов (без фильтра по группам)
allRestaurants boolean Все рестораны (без фильтра по ресторанам)

PurchasesSegmentResponseDto

Поле Тип Обяз. Описание
name string да Наименование
type integer Тип
parameters PurchasesSegmentParametersResponseDto да Параметры (JSON)
id integer да Идентификатор
lastUpdate datetime Дата последнего пересчёта состава
system boolean да Системный элемент
relatedPromotions массив SegmentRelatedPromotionDto Акции, связанные с объектом

PurchasesSegmentResponseWithAccountsListDto

Поле Тип Обяз. Описание
name string да Наименование
type integer Тип
parameters PurchasesSegmentParametersResponseDto да Параметры (JSON)
id integer да Идентификатор
lastUpdate datetime Дата последнего пересчёта состава
system boolean да Системный элемент
relatedPromotions массив SegmentRelatedPromotionDto Акции, связанные с объектом
accounts массив BaseSegmentResponseAccountListItemDto да Список счетов

PurchasesSegmentUpdateDto

Поле Тип Обяз. Описание
name string да Наименование
type integer Тип
parameters PurchasesSegmentParametersDto да Параметры (JSON)
id integer да Идентификатор

ReferralProgramRegistrationNotificationPromotionTriggerInsertDto

Поле Тип Обяз. Описание
type PromotionTriggerType Тип
name string да Наименование
dateStart date да Дата начала
dateStop date Дата окончания
isActive boolean да Активен

ReferralProgramRegistrationNotificationPromotionTriggerResponseDto

Поле Тип Обяз. Описание
type PromotionTriggerType Тип
name string да Наименование
dateStart date да Дата начала
dateStop date Дата окончания
isActive boolean да Активен
id integer да Идентификатор
isSys boolean да Системный триггер
indefinitely boolean Бессрочно (без срока действия)

ReferralProgramRegistrationNotificationPromotionTriggerUpdateDto

Поле Тип Обяз. Описание
type PromotionTriggerType Тип
name string да Наименование
dateStart date да Дата начала
dateStop date Дата окончания
isActive boolean да Активен
id integer да Идентификатор

ReferralProgramRewardPromotionTriggerInsertDto

Поле Тип Обяз. Описание
type PromotionTriggerType Тип
name string да Наименование
dateStart date да Дата начала
dateStop date Дата окончания
isActive boolean да Активен

ReferralProgramRewardPromotionTriggerResponseDto

Поле Тип Обяз. Описание
type PromotionTriggerType Тип
name string да Наименование
dateStart date да Дата начала
dateStop date Дата окончания
isActive boolean да Активен
id integer да Идентификатор
isSys boolean да Системный триггер
indefinitely boolean Бессрочно (без срока действия)

ReferralProgramRewardPromotionTriggerUpdateDto

Поле Тип Обяз. Описание
type PromotionTriggerType Тип
name string да Наименование
dateStart date да Дата начала
dateStop date Дата окончания
isActive boolean да Активен
id integer да Идентификатор

ResetBonusesPromotionActionItemDto

Поле Тип Обяз. Описание
id integer Идентификатор
delayMinutes integer Сдвиг запуска относительно начала акции, минут; мин. 0; макс. 720; по умолчанию 0
type integer Тип
parameters null Параметры (JSON)

ResetBonusesPromotionActionItemResponseDto

Поле Тип Обяз. Описание
id integer Идентификатор
delayMinutes integer Сдвиг запуска относительно начала акции, минут; мин. 0; макс. 720; по умолчанию 0
type integer Тип
parameters null Параметры (JSON)

RestaurantListItemDto

Поле Тип Обяз. Описание
name string(100) да Наименование
code string да код ресторана 9 цифр
isDeleted boolean Признак удаления; по умолчанию false
id integer да Идентификатор ресторана
licSlot integer

SegmentPromotionActuationType

Перечисление (integer). Значения: 1, 2, 3.

SegmentRelatedPromotionDto

Поле Тип Обяз. Описание
id integer да Идентификатор
name string да Наименование

SexAgeAccountGroupSegmentDto

Поле Тип Обяз. Описание
name string да Наименование
type integer Тип
parameters SexAgeAccountGroupSegmentParametersDto да Параметры (JSON)

SexAgeAccountGroupSegmentParametersDto

Поле Тип Обяз. Описание
accountGroupIds массив integer Список идентификаторов групп счетов
sex integer Пол
fromAge integer Возраст от
toAge integer Возраст до

SexAgeAccountGroupSegmentParametersResponseDto

Поле Тип Обяз. Описание
accountGroupIds массив integer Список идентификаторов групп счетов
sex integer Пол
fromAge integer Возраст от
toAge integer Возраст до
allAges boolean Все возрасты
allAccountGroups boolean Все группы счетов (без фильтра по группам)
allSexes boolean Любой пол

SexAgeAccountGroupSegmentResponseDto

Поле Тип Обяз. Описание
name string да Наименование
type integer Тип
parameters SexAgeAccountGroupSegmentParametersResponseDto да Параметры (JSON)
id integer да Идентификатор
lastUpdate datetime Дата последнего пересчёта состава
system boolean да Системный элемент
relatedPromotions массив SegmentRelatedPromotionDto Акции, связанные с объектом

SexAgeAccountGroupSegmentResponseWithAccountsListDto

Поле Тип Обяз. Описание
name string да Наименование
type integer Тип
parameters SexAgeAccountGroupSegmentParametersResponseDto да Параметры (JSON)
id integer да Идентификатор
lastUpdate datetime Дата последнего пересчёта состава
system boolean да Системный элемент
relatedPromotions массив SegmentRelatedPromotionDto Акции, связанные с объектом
accounts массив BaseSegmentResponseAccountListItemDto да Список счетов

SexAgeAccountGroupSegmentUpdateDto

Поле Тип Обяз. Описание
name string да Наименование
type integer Тип
parameters SexAgeAccountGroupSegmentParametersDto да Параметры (JSON)
id integer да Идентификатор

TopGuestsSegmentDto

Поле Тип Обяз. Описание
name string да Наименование
type integer Тип
parameters TopGuestsSegmentParametersDto да Параметры (JSON)

TopGuestsSegmentParametersDto

Поле Тип Обяз. Описание
accountGroupIds массив integer Список идентификаторов групп счетов
daysFrom integer да
nParam integer да
selectionType integer да Тип отбора

TopGuestsSegmentParametersResponseDto

Поле Тип Обяз. Описание
accountGroupIds массив integer Список идентификаторов групп счетов
daysFrom integer да
nParam integer да
selectionType integer да Тип отбора
allAccountGroups boolean Все группы счетов (без фильтра по группам)

TopGuestsSegmentResponseDto

Поле Тип Обяз. Описание
name string да Наименование
type integer Тип
parameters TopGuestsSegmentParametersResponseDto да Параметры (JSON)
id integer да Идентификатор
lastUpdate datetime Дата последнего пересчёта состава
system boolean да Системный элемент
relatedPromotions массив SegmentRelatedPromotionDto Акции, связанные с объектом

TopGuestsSegmentResponseWithAccountsListDto

Поле Тип Обяз. Описание
name string да Наименование
type integer Тип
parameters TopGuestsSegmentParametersResponseDto да Параметры (JSON)
id integer да Идентификатор
lastUpdate datetime Дата последнего пересчёта состава
system boolean да Системный элемент
relatedPromotions массив SegmentRelatedPromotionDto Акции, связанные с объектом
accounts массив BaseSegmentResponseAccountListItemDto да Список счетов

TopGuestsSegmentUpdateDto

Поле Тип Обяз. Описание
name string да Наименование
type integer Тип
parameters TopGuestsSegmentParametersDto да Параметры (JSON)
id integer да Идентификатор

WalletUpdatePromotionTriggerInsertDto

Поле Тип Обяз. Описание
type PromotionTriggerType Тип
name string да Наименование
dateStart date да Дата начала
dateStop date Дата окончания
isActive boolean да Активен

WalletUpdatePromotionTriggerResponseDto

Поле Тип Обяз. Описание
type PromotionTriggerType Тип
name string да Наименование
dateStart date да Дата начала
dateStop date Дата окончания
isActive boolean да Активен
id integer да Идентификатор
isSys boolean да Системный триггер
indefinitely boolean Бессрочно (без срока действия)

WalletUpdatePromotionTriggerUpdateDto

Поле Тип Обяз. Описание
type PromotionTriggerType Тип
name string да Наименование
dateStart date да Дата начала
dateStop date Дата окончания
isActive boolean да Активен
id integer да Идентификатор