Настройки

Раздел содержит описание всех настроек промоакций.


Содержание


Бонусная система

Модели настроек бонусной системы

Общие настройки

Ключ (системное название) настройки: general_settings

Название Тип данных Описание
discount Decimal Скидка (%)
payment_type Int64 ID формы оплаты
Настройки разовых зачислений

Ключ (системное название) настройки: one_time_enrollment

Название Тип данных Описание
expiry_date_period_value Int16 Значение окончания срока действия
expiry_date_period_type Int8 Единица измерения срока окончания действия: 1 - День, 2 - Неделя, 3 - Месяц, 4 - Год
expiry_date_period_type_enum Enum Единица измерения срока окончания действия: <Day | 1> - День, <Week | 2> - Неделя, <Month | 3> - Месяц, <Year | 4> - Год
percent Decimal Процент (%)
coef Decimal Коэффициент
type Int16 Тип зачисления: 1 - От суммы сос скидкой, 2 - От суммы без скидки
type_enum Enum Тип зачисления: <WithDiscount | 1> - От суммы сос скидкой, <WithOutDiscount | 2> - От суммы без скидки
max_value Decimal Максимальное количество бонусов к зачислению
include_bonus Boolean Начислять ли бонусы с формы оплаты "Бонусы": true - Начислять, false - Не начислять
Настройки разовых списаний

Ключ (системное название) настройки: one_time_withdrawal

Название Тип данных Описание
max_value Decimal Максимальное количество бонусов к списанию
Настройки зачислений в день рождения покупателя

Ключ (системное название) настройки: birthday_enrollment

Название Тип данных Описание
active Boolean Активна ли настройка: true - Активна, false - Не активна
value Decimal Количество бонусов
expiry_date_period_value Int16 Значение окончания срока действия
expiry_date_period_type Int8 Единица измерения срока окончания действия: 1 - День, 2 - Неделя, 3 - Месяц, 4 - Год
preliminary_day Int16 Предварительное зачисление (дни)
extra_discount Decimal Дополнительная скидка (%)
Настройки зачислений в зависимости от суммы покупок за период

Ключ (системное название) настройки: periodically_enrollment

Название Тип данных Описание
start_date String Дата начала в формате "ГГГГ-ММ-ДД"
period_value Int16 Значение периодичности
period_type Int8 Тип периодичности: 1 - День, 2 - Неделя, 3 - Месяц, 4 - Год
expiry_date_period_value Int16 Значение окончания срока действия
expiry_date_period_type Int8 Единица измерения срока окончания действия: 1 - День, 2 - Неделя, 3 - Месяц, 4 - Год
amount Decimal Количество бонусов к зачислению
percent Decimal Процент (%)
coef Decimal Коэффициент
Настройки зачислений в праздничные дни

Ключ (системное название) настройки: holiday_enrollment

Название Тип данных Описание
start_date String Дата начала в формате "ГГГГ-ММ-ДД"
start_date_obj String Дата начала в формате "ГГГГ-ММ-ДДТЧЧ:ММ:СС"
period_value Int16 Значение периодичности
period_type Int8 Тип периодичности: 1 - День, 2 - Неделя, 3 - Месяц, 4 - Год
expiry_date_period_type_enum Enum Единица измерения срока окончания действия: <Day | 1> - День, <Week | 2> - Неделя, <Month | 3> - Месяц, <Year | 4> - Год
expiry_date_period_value Int16 Значение окончания срока действия
expiry_date_period_type Int8 Единица измерения срока окончания действия: 1 - День, 2 - Неделя, 3 - Месяц, 4 - Год
value Decimal Количество бонусов к зачислению
extra_discount Decimal Дополнительная скидка (%)
Группа номенкратуры

Ключ (системное название) настройки: item_group

Название Тип данных Описание
group_id Int64 ID группы номенклатуры
include_children Boolean Включать ли подгруппы: true - Включать, false - Не включать
Исключать номенклатуру

Ключ (системное название) настройки: item

Название Тип данных Описание
item_id Int64 ID номенклатуры


Периодическая скидка

Общие настройки

Ключ (системное название) настройки: general_settings

Название Тип данных Описание
discount Decimal Скидка (%)
interaction_method Enum Действие, при наличии скидки у номенклатуры: <Summarize | 1> - Суммировать, <Replace | 2> - Заменить, <Skip | 3> - Пропускать/Игнорировать
Группа номенкратуры

Ключ (системное название) настройки: item_group

Название Тип данных Описание
group_id Int64 ID группы номенклатуры
include_children Boolean Включать ли подгруппы: true - Включать, false - Не включать
Номенклатура

Ключ (системное название) настройки: item

Название Тип данных Описание
item_id Int64 ID номенклатуры


Скидка (по условиям)

Общие настройки

Ключ (системное название) настройки: general_settings

Название Тип данных Описание
interaction_method Enum Действие, при наличии скидки у номенклатуры: <Summarize | 1> - Суммировать, <Replace | 2> - Заменить, <Skip | 3> - Пропускать/Игнорировать
operation_order Enum Порядок применения скидки: <OrderAsc | 1> - По порядку позиций в чеке, <OrderDesc | 2> - В обратном порядке по позициям в чеке, <OrderPrice2Asc | 3> - От дешёвого к дорогому, <OrderPrice2Desc | 4> - От дорого к дешёвому, <OrderQuantityAsc | 5> - От меньшего количества к большему, <OrderQuantityDesc | 6> - От большего количества к меньшему
Настройка

Ключ (системное название) настройки: setting

Название Тип данных Описание
data_type Enum Тип данных: <Item | 1> - Номенклатура, <ItemGroup | 2> - Группа номенклатуры, <Cheque | 3> - Чек
data_id Int64 ID объекта (data_type)
discount_percent Decimal % скидки
quantity Decimal Количество
priority Int32 Приоритет
Условия

Ключ (системное название) настройки: setting_case

Название Тип данных Описание
enum_case Enum Условие: <ItemExsistInCheque | 1> - Наличие в чеке, <ChequeAmount | 2> - Сумма чека со скидкой, <ChequeAmount2 | 3> - Сумма чека без скидки
data_type Enum Тип данных: <Item | 1> - Номенклатура, <ItemGroup | 2> - Группа номенклатуры, <Cheque | 3> - Чек
data_id Int64 ID объекта (data_type)
value Decimal Значение
setting_id Int64 ID связанной настройки


Внешняя бонусная система

Общие

Ключ (системное название) настройки: setting_case

Название Тип данных Описание
PI_COMPANY_ID String ID компании
PI_API_KEY String API key

Примечание: Только данная модель передаётся как объект values

"values": {
    "PI_COMPANY_ID": "", 
    "PI_API_KEY": ""
}