ProBonus API: Акции и сегменты [База знаний ГК Карбис]

Эта страница только для чтения. Вы можете посмотреть её исходный текст, но не можете его изменить. Сообщите администратору, если считаете, что это неправильно.
====== ProBonus API: Акции и сегменты ======

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

Общие правила (адрес, авторизация, форматы, коды ошибок) — на странице [[external:pro_bonus:10_probonus_api:20_reference|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|Чтение сегментной акции по id]] |
| ''POST'' | ''/api/v1/promotions/insert'' | [[#добавление_сегментной_акции|Добавление сегментной акции]] |
| ''GET'' | ''/api/v1/promotions/list'' | [[#список_сегментных_акций|Список сегментных акций]] |
| ''POST'' | ''/api/v1/promotions/update'' | [[#изменение_сегментной_акции|Изменение сегментной акции]] |
| ''POST'' | ''/api/v0/promotions/activate'' | [[#активация_действия_акции_v0_устаревший|Активация действия акции (v0, устаревший)]] |
| ''POST'' | ''/api/v0/promotions/deactivate'' | [[#деактивация_действия_акции_v0_устаревший|Деактивация действия акции (v0, устаревший)]] |
| ''POST'' | ''/api/v0/promotions/delete'' | [[#удаление_действия_акции_v0_устаревший|Удаление действия акции (v0, устаревший)]] |
| ''GET'' | ''/api/v0/promotions/get'' | [[#чтение_действия_акции_по_id_v0_устаревший|Чтение действия акции по id (v0, устаревший)]] |
| ''POST'' | ''/api/v0/promotions/insert'' | [[#добавление_действия_акции_v0_устаревший|Добавление действия акции (v0, устаревший)]] |
| ''GET'' | ''/api/v0/promotions/list'' | [[#список_действий_акций_v0_устаревший|Список действий акций (v0, устаревший)]] |
| ''POST'' | ''/api/v0/promotions/update'' | [[#изменение_действия_акции_v0_устаревший|Изменение действия акции (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|Чтение триггерной акции по 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|Удаление элемента справочника "Штамипики (N+1)" по указанному id]] |
| ''GET'' | ''/api/v0/promo_stamps/get'' | [[#чтение_элемента_справочника_штамипики_n_1_по_указанному_id|Чтение элемента справочника "Штамипики (N+1)" по указанному id]] |
| ''POST'' | ''/api/v0/promo_stamps/insert'' | [[#добавление_элемента_справочника_штамипики_n_1|Добавление элемента справочника "Штамипики (N+1)"]] |
| ''GET'' | ''/api/v0/promo_stamps/list'' | [[#чтение_списка_элементов_справочника_штамипики_n_1|Чтение списка элементов справочника "Штамипики (N+1)"]] |
| ''POST'' | ''/api/v0/promo_stamps/update'' | [[#обновление_элемента_справочника_штамипики_n_1_по_указанному_id|Обновление элемента справочника "Штамипики (N+1)" по указанному id]] |
| ''POST'' | ''/api/v0/promocodes/activate'' | [[#активация_промокода_по_указанному_id|Активация промокода по указанному id]] |
| ''POST'' | ''/api/v0/promocodes/activate_code'' | [[#активация_промокода_по_коду_активации|Активация промокода по коду активации]] |
| ''POST'' | ''/api/v0/promocodes/deactivate'' | [[#деактивация_промокода_по_указанному_id|Деактивация промокода по указанному id]] |
| ''POST'' | ''/api/v0/promocodes/delete'' | [[#удаление_элемента_справочника_промокоды_по_указанному_id|Удаление элемента справочника "Промокоды" по указанному id]] |
| ''GET'' | ''/api/v0/promocodes/get'' | [[#чтение_элемента_справочника_промокоды_по_указанному_id|Чтение элемента справочника "Промокоды" по указанному id]] |
| ''POST'' | ''/api/v0/promocodes/insert'' | [[#добавление_элемента_справочника_промокоды|Добавление элемента справочника "Промокоды"]] |
| ''GET'' | ''/api/v0/promocodes/list'' | [[#чтение_списка_элементов_справочника_промокоды|Чтение списка элементов справочника "Промокоды"]] |
| ''GET'' | ''/api/v0/promocodes/promocodes_available'' | [[#получение_списка_доступных_промокодов_для_счета|Получение списка доступных промокодов для счета]] |
| ''POST'' | ''/api/v0/promocodes/update'' | [[#обновление_элемента_справочника_промокоды_по_указанному_id|Обновление элемента справочника "Промокоды" по указанному id]] |
| ''POST'' | ''/api/v0/segments/delete'' | [[#удаление_сегмента|Удаление сегмента]] |
| ''GET'' | ''/api/v0/segments/for_copy'' | [[#получение_сегмента_для_копирования|Получение сегмента для копирования]] |
| ''GET'' | ''/api/v0/segments/get'' | [[#чтение_сегмента_по_id|Чтение сегмента по 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|DiscountTemporaryPromotionActionItemResponseDto]] или [[#addbonusespromotionactionitemresponsedto|AddBonusesPromotionActionItemResponseDto]] или [[#mailingpromotionactionitemresponsedto|MailingPromotionActionItemResponseDto]] или [[#addcoupondishpromotionactionitemresponsedto|AddCouponDishPromotionActionItemResponseDto]] или [[#resetbonusespromotionactionitemresponsedto|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|SegmentPromotionActuationType]] | да | Тип применения (единожды / раз в N дней / в N-й день месяца) |
| ''actuationPeriodicity'' | integer |  | Периодичность, дней; больше 0 |
| ''actuationMonthDate'' | integer |  | День месяца срабатывания; мин. 1; макс. 31 |
| ''actuationTime'' | time | да | Время срабатывания |
| ''segmentId'' | integer | да | Сегмент гостей |
| ''isActive'' | boolean | да | Акция активна |
| ''actions'' | массив [[#discounttemporarypromotionactionitemresponsedto|DiscountTemporaryPromotionActionItemResponseDto]] или [[#addbonusespromotionactionitemresponsedto|AddBonusesPromotionActionItemResponseDto]] или [[#mailingpromotionactionitemresponsedto|MailingPromotionActionItemResponseDto]] или [[#addcoupondishpromotionactionitemresponsedto|AddCouponDishPromotionActionItemResponseDto]] или [[#resetbonusespromotionactionitemresponsedto|ResetBonusesPromotionActionItemResponseDto]] | да | Действия акции |
| ''lastActuation'' | datetime |  | Дата и время последнего срабатывания |
| ''nextActuation'' | datetime |  | Следующее срабатывание |
| ''lastActuationSpentTime'' | number |  | Длительность последнего срабатывания |
| ''indefinitely'' | boolean |  | Бессрочно (без срока действия) |
| ''segment'' | [[#basesegmentwithiddto|BaseSegmentWithIdDto]] |  | Сегмент |

==== Чтение сегментной акции по id ====
**''GET /api/v1/promotions/get''**\\
Авторизация: требуется

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

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

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

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

==== Добавление сегментной акции ====
**''POST /api/v1/promotions/insert''**\\
Авторизация: требуется

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

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

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

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

==== Список сегментных акций ====
**''GET /api/v1/promotions/list''**\\
Авторизация: требуется

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

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

==== Изменение сегментной акции ====
**''POST /api/v1/promotions/update''**\\
Авторизация: требуется

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

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

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

^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''id'' | integer | да | Идентификатор акции |
| ''name'' | string | да | Наименование |
| ''dateStart'' | date | да | Дата начала |
| ''dateStop'' | date |  | Дата окончания |
| ''actuationType'' | [[#segmentpromotionactuationtype|SegmentPromotionActuationType]] | да | Тип применения (единожды / раз в N дней / в N-й день месяца) |
| ''actuationPeriodicity'' | integer |  | Периодичность, дней; больше 0 |
| ''actuationMonthDate'' | integer |  | День месяца срабатывания; мин. 1; макс. 31 |
| ''actuationTime'' | time | да | Время срабатывания |
| ''segmentId'' | integer | да | Сегмент гостей |
| ''isActive'' | boolean | да | Акция активна |
| ''actions'' | массив [[#discounttemporarypromotionactionitemresponsedto|DiscountTemporaryPromotionActionItemResponseDto]] или [[#addbonusespromotionactionitemresponsedto|AddBonusesPromotionActionItemResponseDto]] или [[#mailingpromotionactionitemresponsedto|MailingPromotionActionItemResponseDto]] или [[#addcoupondishpromotionactionitemresponsedto|AddCouponDishPromotionActionItemResponseDto]] или [[#resetbonusespromotionactionitemresponsedto|ResetBonusesPromotionActionItemResponseDto]] | да | Действия акции |
| ''lastActuation'' | datetime |  | Дата и время последнего срабатывания |
| ''nextActuation'' | datetime |  | Следующее срабатывание |
| ''lastActuationSpentTime'' | number |  | Длительность последнего срабатывания |
| ''indefinitely'' | boolean |  | Бессрочно (без срока действия) |
| ''segment'' | [[#basesegmentwithiddto|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|WalletUpdatePromotionTriggerResponseDto]] или [[#referralprogramrewardpromotiontriggerresponsedto|ReferralProgramRewardPromotionTriggerResponseDto]] или [[#referralprogramregistrationnotificationpromotiontriggerresponsedto|ReferralProgramRegistrationNotificationPromotionTriggerResponseDto]] или [[#promostamppromotiontriggerresponsedto|PromoStampPromotionTriggerResponseDto]].

==== Добавление триггерной акции ====
**''POST /api/v0/promotions_trigger/insert''**\\
Авторизация: требуется

**Тело запроса** — [[#walletupdatepromotiontriggerinsertdto|WalletUpdatePromotionTriggerInsertDto]] или [[#referralprogramrewardpromotiontriggerinsertdto|ReferralProgramRewardPromotionTriggerInsertDto]] или [[#referralprogramregistrationnotificationpromotiontriggerinsertdto|ReferralProgramRegistrationNotificationPromotionTriggerInsertDto]] или [[#promostamppromotiontriggerinsertdto|PromoStampPromotionTriggerInsertDto]].

**Ответ 200** — [[#walletupdatepromotiontriggerresponsedto|WalletUpdatePromotionTriggerResponseDto]] или [[#referralprogramrewardpromotiontriggerresponsedto|ReferralProgramRewardPromotionTriggerResponseDto]] или [[#referralprogramregistrationnotificationpromotiontriggerresponsedto|ReferralProgramRegistrationNotificationPromotionTriggerResponseDto]] или [[#promostamppromotiontriggerresponsedto|PromoStampPromotionTriggerResponseDto]].

==== Список триггерных акций ====
**''GET /api/v0/promotions_trigger/list''**\\
Авторизация: требуется

**Ответ 200** — массив [[#walletupdatepromotiontriggerresponsedto|WalletUpdatePromotionTriggerResponseDto]] или [[#referralprogramrewardpromotiontriggerresponsedto|ReferralProgramRewardPromotionTriggerResponseDto]] или [[#referralprogramregistrationnotificationpromotiontriggerresponsedto|ReferralProgramRegistrationNotificationPromotionTriggerResponseDto]] или [[#promostamppromotiontriggerresponsedto|PromoStampPromotionTriggerResponseDto]].

==== Изменение триггерной акции ====
**''POST /api/v0/promotions_trigger/update''**\\
Авторизация: требуется

**Тело запроса** — [[#walletupdatepromotiontriggerupdatedto|WalletUpdatePromotionTriggerUpdateDto]] или [[#referralprogramrewardpromotiontriggerupdatedto|ReferralProgramRewardPromotionTriggerUpdateDto]] или [[#referralprogramregistrationnotificationpromotiontriggerupdatedto|ReferralProgramRegistrationNotificationPromotionTriggerUpdateDto]] или [[#promostamppromotiontriggerupdatedto|PromoStampPromotionTriggerUpdateDto]].

**Ответ 200** — [[#walletupdatepromotiontriggerresponsedto|WalletUpdatePromotionTriggerResponseDto]] или [[#referralprogramrewardpromotiontriggerresponsedto|ReferralProgramRewardPromotionTriggerResponseDto]] или [[#referralprogramregistrationnotificationpromotiontriggerresponsedto|ReferralProgramRegistrationNotificationPromotionTriggerResponseDto]] или [[#promostamppromotiontriggerresponsedto|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|PromoStampGiftDish]] |  | Подарочные блюда |
| ''discountCode'' | integer | да | Код скидки r_keeper для подарочного блюда (уникальная для каждой акции) |
| ''promoDishCount'' | integer | да | «Порций купить» — N, количество акционных блюд для получения подарка |
| ''giftDishCount'' | integer | да | «Подарочных порций» — количество подарков за цикл |
| ''hideProgressWithoutActivity'' | boolean |  | Не показывать прогресс гостям без покупок по акции; по умолчанию ''false'' |
| ''id'' | integer | да | Идентификатор акции |
| ''isDeleted'' | boolean | да | Признак удаления |
| ''accountGroups'' | массив [[#accountgrouplistitemdto|AccountGroupListItemDto]] | да | Группы счетов |
| ''restaurants'' | массив [[#restaurantlistitemdto|RestaurantListItemDto]] | да | Рестораны |

==== Добавление элемента справочника "Штамипики (N+1)" ====
**''POST /api/v0/promo_stamps/insert''**\\
Авторизация: требуется

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

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

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

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

==== Чтение списка элементов справочника "Штамипики (N+1)" ====
**''GET /api/v0/promo_stamps/list''**\\
Авторизация: требуется

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

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

==== Обновление элемента справочника "Штамипики (N+1)" по указанному id ====
**''POST /api/v0/promo_stamps/update''**\\
Авторизация: требуется

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

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

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

^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string(20) | да | Наименование (до 20 символов) |
| ''dateStart'' | date | да | Начало действия |
| ''dateStop'' | date |  | Окончание действия (''NULL'' — бессрочно) |
| ''promoDishCodes'' | массив integer |  | Коды акционных блюд |
| ''giftDishes'' | массив [[#promostampgiftdish|PromoStampGiftDish]] |  | Подарочные блюда |
| ''discountCode'' | integer | да | Код скидки r_keeper для подарочного блюда (уникальная для каждой акции) |
| ''promoDishCount'' | integer | да | «Порций купить» — N, количество акционных блюд для получения подарка |
| ''giftDishCount'' | integer | да | «Подарочных порций» — количество подарков за цикл |
| ''hideProgressWithoutActivity'' | boolean |  | Не показывать прогресс гостям без покупок по акции; по умолчанию ''false'' |
| ''id'' | integer | да | Идентификатор акции |
| ''isDeleted'' | boolean | да | Признак удаления |
| ''accountGroups'' | массив [[#accountgrouplistitemdto|AccountGroupListItemDto]] | да | Группы счетов |
| ''restaurants'' | массив [[#restaurantlistitemdto|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|PromotionType]] | да | Тип |
| ''name'' | string | да | Наименование |
| ''dateStart'' | date | да | Дата начала |
| ''dateStop'' | date |  | Дата окончания |
| ''parameters'' | [[#addcoupondishpromotionparametersresponsedto|AddCouponDishPromotionParametersResponseDto]] или [[#addbonusespromotionparametersresponsedto|AddBonusesPromotionParametersResponseDto]] или [[#discounttemporarypromotionparametersresponsedto|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|DiscountTemporaryPromocodeDto]] или [[#addbonusespromocodedto|AddBonusesPromocodeDto]] или [[#addcoupondishpromocodedto|AddCouponDishPromocodeDto]].

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

^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''type'' | [[#promotiontype|PromotionType]] | да | Тип |
| ''name'' | string | да | Наименование |
| ''dateStart'' | date | да | Дата начала |
| ''dateStop'' | date |  | Дата окончания |
| ''parameters'' | [[#addcoupondishpromotionparametersresponsedto|AddCouponDishPromotionParametersResponseDto]] или [[#addbonusespromotionparametersresponsedto|AddBonusesPromotionParametersResponseDto]] или [[#discounttemporarypromotionparametersresponsedto|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|PromotionType]] | да | Тип |
| ''name'' | string | да | Наименование |
| ''dateStart'' | date | да | Дата начала |
| ''dateStop'' | date |  | Дата окончания |
| ''parameters'' | [[#addcoupondishpromotionparametersresponsedto|AddCouponDishPromotionParametersResponseDto]] или [[#addbonusespromotionparametersresponsedto|AddBonusesPromotionParametersResponseDto]] или [[#discounttemporarypromotionparametersresponsedto|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|DiscountTemporaryPromocodeUpdateDto]] или [[#addbonusespromocodeupdatedto|AddBonusesPromocodeUpdateDto]] или [[#addcoupondishpromocodeupdatedto|AddCouponDishPromocodeUpdateDto]].

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

^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''type'' | [[#promotiontype|PromotionType]] | да | Тип |
| ''name'' | string | да | Наименование |
| ''dateStart'' | date | да | Дата начала |
| ''dateStop'' | date |  | Дата окончания |
| ''parameters'' | [[#addcoupondishpromotionparametersresponsedto|AddCouponDishPromotionParametersResponseDto]] или [[#addbonusespromotionparametersresponsedto|AddBonusesPromotionParametersResponseDto]] или [[#discounttemporarypromotionparametersresponsedto|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|IdleAccountsSegmentResponseDto]] или [[#topguestssegmentresponsedto|TopGuestsSegmentResponseDto]] или [[#bonusburnsegmentresponsedto|BonusBurnSegmentResponseDto]] или [[#birthdaysegmentresponsedto|BirthdaySegmentResponseDto]] или [[#sexageaccountgroupsegmentresponsedto|SexAgeAccountGroupSegmentResponseDto]] или [[#allguestssegmentresponsedto|AllGuestsSegmentResponseDto]] или [[#bonusesleftsegmentresponsedto|BonusesLeftSegmentResponseDto]] или [[#manualbylistsegmentresponsedto|ManualByListSegmentResponseDto]] или [[#manualbyselectedaccountssegmentresponsedto|ManualBySelectedAccountsSegmentResponseDto]] или [[#compositesegmentresponsedto|CompositeSegmentResponseDto]] или [[#purchasessegmentresponsedto|PurchasesSegmentResponseDto]].

==== Чтение сегмента по id ====
**''GET /api/v0/segments/get''**\\
Авторизация: требуется

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

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

**Ответ 200** — [[#idleaccountssegmentresponsedto|IdleAccountsSegmentResponseDto]] или [[#topguestssegmentresponsedto|TopGuestsSegmentResponseDto]] или [[#bonusburnsegmentresponsedto|BonusBurnSegmentResponseDto]] или [[#birthdaysegmentresponsedto|BirthdaySegmentResponseDto]] или [[#sexageaccountgroupsegmentresponsedto|SexAgeAccountGroupSegmentResponseDto]] или [[#allguestssegmentresponsedto|AllGuestsSegmentResponseDto]] или [[#bonusesleftsegmentresponsedto|BonusesLeftSegmentResponseDto]] или [[#manualbylistsegmentresponsedto|ManualByListSegmentResponseDto]] или [[#manualbyselectedaccountssegmentresponsedto|ManualBySelectedAccountsSegmentResponseDto]] или [[#compositesegmentresponsedto|CompositeSegmentResponseDto]] или [[#purchasessegmentresponsedto|PurchasesSegmentResponseDto]].

==== Чтение сегмента вместе со списком счетов ====
**''GET /api/v0/segments/get_with_accounts_list''**\\
Авторизация: требуется

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

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

**Ответ 200** — [[#idleaccountssegmentresponsewithaccountslistdto|IdleAccountsSegmentResponseWithAccountsListDto]] или [[#bonusburnsegmentresponsewithaccountslistdto|BonusBurnSegmentResponseWithAccountsListDto]] или [[#birthdaysegmentresponsewithaccountslistdto|BirthdaySegmentResponseWithAccountsListDto]] или [[#sexageaccountgroupsegmentresponsewithaccountslistdto|SexAgeAccountGroupSegmentResponseWithAccountsListDto]] или [[#allguestssegmentresponsewithaccountslistdto|AllGuestsSegmentResponseWithAccountsListDto]] или [[#topguestssegmentresponsewithaccountslistdto|TopGuestsSegmentResponseWithAccountsListDto]] или [[#bonusesleftsegmentresponsewithaccountslistdto|BonusesLeftSegmentResponseWithAccountsListDto]] или [[#manualbylistsegmentresponsewithaccountslistdto|ManualByListSegmentResponseWithAccountsListDto]] или [[#manualbyselectedaccountssegmentresponsewithaccountslistdto|ManualBySelectedAccountsSegmentResponseWithAccountsListDto]] или [[#compositesegmentresponsewithaccountslistdto|CompositeSegmentResponseWithAccountsListDto]] или [[#purchasessegmentresponsewithaccountslistdto|PurchasesSegmentResponseWithAccountsListDto]].

==== Добавление сегмента ====
**''POST /api/v0/segments/insert''**\\
Авторизация: требуется

**Тело запроса** — [[#idleaccountssegmentdto|IdleAccountsSegmentDto]] или [[#topguestssegmentdto|TopGuestsSegmentDto]] или [[#bonusburnsegmentdto|BonusBurnSegmentDto]] или [[#birthdaysegmentdto|BirthdaySegmentDto]] или [[#sexageaccountgroupsegmentdto|SexAgeAccountGroupSegmentDto]] или [[#bonusesleftsegmentdto|BonusesLeftSegmentDto]] или [[#manualbylistsegmentdto|ManualByListSegmentDto]] или [[#manualbyselectedaccountssegmentdto|ManualBySelectedAccountsSegmentDto]] или [[#compositesegmentdto|CompositeSegmentDto]] или [[#purchasessegmentdto|PurchasesSegmentDto]].

**Ответ 200** — [[#idleaccountssegmentresponsedto|IdleAccountsSegmentResponseDto]] или [[#topguestssegmentresponsedto|TopGuestsSegmentResponseDto]] или [[#bonusburnsegmentresponsedto|BonusBurnSegmentResponseDto]] или [[#birthdaysegmentresponsedto|BirthdaySegmentResponseDto]] или [[#sexageaccountgroupsegmentresponsedto|SexAgeAccountGroupSegmentResponseDto]] или [[#allguestssegmentresponsedto|AllGuestsSegmentResponseDto]] или [[#bonusesleftsegmentresponsedto|BonusesLeftSegmentResponseDto]] или [[#manualbylistsegmentresponsedto|ManualByListSegmentResponseDto]] или [[#manualbyselectedaccountssegmentresponsedto|ManualBySelectedAccountsSegmentResponseDto]] или [[#compositesegmentresponsedto|CompositeSegmentResponseDto]] или [[#purchasessegmentresponsedto|PurchasesSegmentResponseDto]].

==== Список сегментов ====
**''GET /api/v0/segments/list''**\\
Авторизация: требуется

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

^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string | да | Наименование |
| ''type'' | integer | да | Тип |
| ''parameters'' | object или object |  | Параметры (JSON) |
| ''id'' | integer | да | Идентификатор |
| ''lastUpdate'' | datetime |  | Дата последнего пересчёта состава |
| ''system'' | boolean | да | Системный элемент |
| ''relatedPromotions'' | массив [[#segmentrelatedpromotiondto|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|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|IdleAccountsSegmentResponseDto]] или [[#topguestssegmentresponsedto|TopGuestsSegmentResponseDto]] или [[#bonusburnsegmentresponsedto|BonusBurnSegmentResponseDto]] или [[#birthdaysegmentresponsedto|BirthdaySegmentResponseDto]] или [[#sexageaccountgroupsegmentresponsedto|SexAgeAccountGroupSegmentResponseDto]] или [[#allguestssegmentresponsedto|AllGuestsSegmentResponseDto]] или [[#bonusesleftsegmentresponsedto|BonusesLeftSegmentResponseDto]] или [[#manualbylistsegmentresponsedto|ManualByListSegmentResponseDto]] или [[#manualbyselectedaccountssegmentresponsedto|ManualBySelectedAccountsSegmentResponseDto]] или [[#compositesegmentresponsedto|CompositeSegmentResponseDto]] или [[#purchasessegmentresponsedto|PurchasesSegmentResponseDto]].

==== Изменение сегмента ====
**''POST /api/v0/segments/update''**\\
Авторизация: требуется

**Тело запроса** — [[#idleaccountssegmentupdatedto|IdleAccountsSegmentUpdateDto]] или [[#topguestssegmentupdatedto|TopGuestsSegmentUpdateDto]] или [[#bonusburnsegmentupdatedto|BonusBurnSegmentUpdateDto]] или [[#birthdaysegmentupdatedto|BirthdaySegmentUpdateDto]] или [[#sexageaccountgroupsegmentupdatedto|SexAgeAccountGroupSegmentUpdateDto]] или [[#bonusesleftsegmentupdatedto|BonusesLeftSegmentUpdateDto]] или [[#compositesegmentupdatedto|CompositeSegmentUpdateDto]] или [[#purchasessegmentupdatedto|PurchasesSegmentUpdateDto]].

**Ответ 200** — [[#idleaccountssegmentresponsedto|IdleAccountsSegmentResponseDto]] или [[#topguestssegmentresponsedto|TopGuestsSegmentResponseDto]] или [[#bonusburnsegmentresponsedto|BonusBurnSegmentResponseDto]] или [[#birthdaysegmentresponsedto|BirthdaySegmentResponseDto]] или [[#sexageaccountgroupsegmentresponsedto|SexAgeAccountGroupSegmentResponseDto]] или [[#allguestssegmentresponsedto|AllGuestsSegmentResponseDto]] или [[#bonusesleftsegmentresponsedto|BonusesLeftSegmentResponseDto]] или [[#manualbylistsegmentresponsedto|ManualByListSegmentResponseDto]] или [[#manualbyselectedaccountssegmentresponsedto|ManualBySelectedAccountsSegmentResponseDto]] или [[#compositesegmentresponsedto|CompositeSegmentResponseDto]] или [[#purchasessegmentresponsedto|PurchasesSegmentResponseDto]].

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

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

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

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

==== AddBonusesPromocodeUpdateDto ====
^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''type'' | integer |  | Тип |
| ''name'' | string | да | Наименование |
| ''dateStart'' | date | да | Дата начала |
| ''dateStop'' | date |  | Дата окончания |
| ''parameters'' | [[#addbonusespromotionparametersdto|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|AddBonusesPromotionParametersDto]] | да | Параметры (JSON) |

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

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

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

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

==== AddCouponDishPromocodeUpdateDto ====
^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''type'' | integer |  | Тип |
| ''name'' | string | да | Наименование |
| ''dateStart'' | date | да | Дата начала |
| ''dateStop'' | date |  | Дата окончания |
| ''parameters'' | [[#addcoupondishpromotionparametersdto|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|AddCouponDishPromotionParametersDto]] | да | Параметры (JSON) |

==== AddCouponDishPromotionActionItemResponseDto ====
^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''id'' | integer |  | Идентификатор |
| ''delayMinutes'' | integer |  | Сдвиг запуска относительно начала акции, минут; мин. 0; макс. 720; по умолчанию ''0'' |
| ''type'' | integer |  | Тип |
| ''parameters'' | [[#addcoupondishpromotionparametersresponsedto|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|SegmentRelatedPromotionDto]] |  | Акции, связанные с объектом |

==== AllGuestsSegmentResponseWithAccountsListDto ====
^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string | да | Наименование |
| ''type'' | integer |  | Тип |
| ''parameters'' | object или object |  | Параметры (JSON) |
| ''id'' | integer | да | Идентификатор |
| ''lastUpdate'' | datetime |  | Дата последнего пересчёта состава |
| ''system'' | boolean | да | Системный элемент |
| ''relatedPromotions'' | массив [[#segmentrelatedpromotiondto|SegmentRelatedPromotionDto]] |  | Акции, связанные с объектом |
| ''accounts'' | массив [[#basesegmentresponseaccountlistitemdto|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|BirthdaySegmentParametersDto]] | да | Параметры (JSON) |

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

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

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

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

==== BirthdaySegmentUpdateDto ====
^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string | да | Наименование |
| ''type'' | integer |  | Тип |
| ''parameters'' | [[#birthdaysegmentparametersdto|BirthdaySegmentParametersDto]] | да | Параметры (JSON) |
| ''id'' | integer | да | Идентификатор |

==== BonusBurnSegmentDto ====
^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string | да | Наименование |
| ''type'' | integer |  | Тип |
| ''parameters'' | [[#bonusburnsegmentparametersdto|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|BonusBurnSegmentParametersResponseDto]] | да | Параметры (JSON) |
| ''id'' | integer | да | Идентификатор |
| ''lastUpdate'' | datetime |  | Дата последнего пересчёта состава |
| ''system'' | boolean | да | Системный элемент |
| ''relatedPromotions'' | массив [[#segmentrelatedpromotiondto|SegmentRelatedPromotionDto]] |  | Акции, связанные с объектом |

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

==== BonusBurnSegmentUpdateDto ====
^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string | да | Наименование |
| ''type'' | integer |  | Тип |
| ''parameters'' | [[#bonusburnsegmentparametersdto|BonusBurnSegmentParametersDto]] | да | Параметры (JSON) |
| ''id'' | integer | да | Идентификатор |

==== BonusesLeftSegmentDto ====
^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string | да | Наименование |
| ''type'' | integer |  | Тип |
| ''parameters'' | [[#bonusesleftsegmentparametersdto|BonusesLeftSegmentParametersDto]] | да | Параметры (JSON) |

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

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

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

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

==== BonusesLeftSegmentUpdateDto ====
^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string | да | Наименование |
| ''type'' | integer |  | Тип |
| ''parameters'' | [[#bonusesleftsegmentparametersdto|BonusesLeftSegmentParametersDto]] | да | Параметры (JSON) |
| ''id'' | integer | да | Идентификатор |

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

==== CompositeSegmentDto ====
^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string | да | Наименование |
| ''type'' | integer |  | Тип |
| ''parameters'' | [[#compositesegmentparametersdto|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|CompositeSegmentParametersResponseDto]] | да | Параметры (JSON) |
| ''id'' | integer | да | Идентификатор |
| ''lastUpdate'' | datetime |  | Дата последнего пересчёта состава |
| ''system'' | boolean | да | Системный элемент |
| ''relatedPromotions'' | массив [[#segmentrelatedpromotiondto|SegmentRelatedPromotionDto]] |  | Акции, связанные с объектом |

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

==== CompositeSegmentUpdateDto ====
^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string | да | Наименование |
| ''type'' | integer |  | Тип |
| ''parameters'' | [[#compositesegmentparametersdto|CompositeSegmentParametersDto]] | да | Параметры (JSON) |
| ''id'' | integer | да | Идентификатор |

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

==== DiscountTemporaryPromocodeUpdateDto ====
^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''type'' | integer |  | Тип |
| ''name'' | string | да | Наименование |
| ''dateStart'' | date | да | Дата начала |
| ''dateStop'' | date |  | Дата окончания |
| ''parameters'' | [[#discounttemporarypromotionparametersdto|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|DiscountTemporaryPromotionParametersDto]] | да | Параметры (JSON) |

==== DiscountTemporaryPromotionActionItemResponseDto ====
^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''id'' | integer |  | Идентификатор |
| ''delayMinutes'' | integer |  | Сдвиг запуска относительно начала акции, минут; мин. 0; макс. 720; по умолчанию ''0'' |
| ''type'' | integer |  | Тип |
| ''parameters'' | [[#discounttemporarypromotionparametersresponsedto|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|IdleAccountsSegmentParametersDto]] | да | Параметры (JSON) |

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

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

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

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

==== IdleAccountsSegmentUpdateDto ====
^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string | да | Наименование |
| ''type'' | integer |  | Тип |
| ''parameters'' | [[#idleaccountssegmentparametersdto|IdleAccountsSegmentParametersDto]] | да | Параметры (JSON) |
| ''id'' | integer | да | Идентификатор |

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

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

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

==== MailingPromotionParametersDto ====
^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''textTemplate'' | string |  | Шаблон сообщения; подстановки ''{promo_stamp_name}'', ''{event_kind}'', ''{stamp_progress}'' |
| ''channels'' | массив [[#mailingchanneltype|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|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|ManualByListSegmentParametersDto]] | да | Параметры (JSON) |

==== ManualByListSegmentParametersDto ====
^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''accountGroupIds'' | массив integer |  | Список идентификаторов групп счетов |
| ''searchField'' | [[#manualbylistsegmentsearchfield|ManualByListSegmentSearchField]] | да | Поле для поиска |
| ''searchItems'' | массив string | да | Строки для поиска |
| ''exactMatch'' | boolean | да | Точное совпадение |

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

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

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

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

==== ManualBySelectedAccountsSegmentDto ====
^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string | да | Наименование |
| ''type'' | integer |  | Тип |
| ''parameters'' | [[#manualbyselectedaccountssegmentparametersdto|ManualBySelectedAccountsSegmentParametersDto]] | да | Параметры (JSON) |

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

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

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

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

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

==== PromoStampPromotionTriggerInsertDto ====
^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''type'' | [[#promotiontriggertype|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|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|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|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|PurchasesSegmentParametersResponseDto]] | да | Параметры (JSON) |
| ''id'' | integer | да | Идентификатор |
| ''lastUpdate'' | datetime |  | Дата последнего пересчёта состава |
| ''system'' | boolean | да | Системный элемент |
| ''relatedPromotions'' | массив [[#segmentrelatedpromotiondto|SegmentRelatedPromotionDto]] |  | Акции, связанные с объектом |

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

==== PurchasesSegmentUpdateDto ====
^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string | да | Наименование |
| ''type'' | integer |  | Тип |
| ''parameters'' | [[#purchasessegmentparametersdto|PurchasesSegmentParametersDto]] | да | Параметры (JSON) |
| ''id'' | integer | да | Идентификатор |

==== ReferralProgramRegistrationNotificationPromotionTriggerInsertDto ====
^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''type'' | [[#promotiontriggertype|PromotionTriggerType]] |  | Тип |
| ''name'' | string | да | Наименование |
| ''dateStart'' | date | да | Дата начала |
| ''dateStop'' | date |  | Дата окончания |
| ''isActive'' | boolean | да | Активен |

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

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

==== ReferralProgramRewardPromotionTriggerInsertDto ====
^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''type'' | [[#promotiontriggertype|PromotionTriggerType]] |  | Тип |
| ''name'' | string | да | Наименование |
| ''dateStart'' | date | да | Дата начала |
| ''dateStop'' | date |  | Дата окончания |
| ''isActive'' | boolean | да | Активен |

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

==== ReferralProgramRewardPromotionTriggerUpdateDto ====
^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''type'' | [[#promotiontriggertype|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|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|SexAgeAccountGroupSegmentParametersResponseDto]] | да | Параметры (JSON) |
| ''id'' | integer | да | Идентификатор |
| ''lastUpdate'' | datetime |  | Дата последнего пересчёта состава |
| ''system'' | boolean | да | Системный элемент |
| ''relatedPromotions'' | массив [[#segmentrelatedpromotiondto|SegmentRelatedPromotionDto]] |  | Акции, связанные с объектом |

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

==== SexAgeAccountGroupSegmentUpdateDto ====
^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string | да | Наименование |
| ''type'' | integer |  | Тип |
| ''parameters'' | [[#sexageaccountgroupsegmentparametersdto|SexAgeAccountGroupSegmentParametersDto]] | да | Параметры (JSON) |
| ''id'' | integer | да | Идентификатор |

==== TopGuestsSegmentDto ====
^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string | да | Наименование |
| ''type'' | integer |  | Тип |
| ''parameters'' | [[#topguestssegmentparametersdto|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|TopGuestsSegmentParametersResponseDto]] | да | Параметры (JSON) |
| ''id'' | integer | да | Идентификатор |
| ''lastUpdate'' | datetime |  | Дата последнего пересчёта состава |
| ''system'' | boolean | да | Системный элемент |
| ''relatedPromotions'' | массив [[#segmentrelatedpromotiondto|SegmentRelatedPromotionDto]] |  | Акции, связанные с объектом |

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

==== TopGuestsSegmentUpdateDto ====
^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''name'' | string | да | Наименование |
| ''type'' | integer |  | Тип |
| ''parameters'' | [[#topguestssegmentparametersdto|TopGuestsSegmentParametersDto]] | да | Параметры (JSON) |
| ''id'' | integer | да | Идентификатор |

==== WalletUpdatePromotionTriggerInsertDto ====
^ Поле ^ Тип ^ Обяз. ^ Описание ^
| ''type'' | [[#promotiontriggertype|PromotionTriggerType]] |  | Тип |
| ''name'' | string | да | Наименование |
| ''dateStart'' | date | да | Дата начала |
| ''dateStop'' | date |  | Дата окончания |
| ''isActive'' | boolean | да | Активен |

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

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