Вход / Регистрация 0
Реферальная программа лояльности

sw24loyaltyprogram.achieve.add

Время чтения: ~2 мин.
Обновлено: 27.10.2022

Назначение метода

Метод sw24loyaltyprogram.achieve.add предназначен для добавления новой награды.

Параметры

Параметр Обязательный Описание
type Да

Тип награды. В зависимости от типа происходит начисление бонусов

Строка

settings Да

Поле обязательное к заполнение в зависимости от типа награды.

Массив

active

Задаёт активность начисления бонусов пользователю

Строка

name

Пользовательское название награды, которое будет отображаться пользователю

Строка

sort

Порядок сортировки

Целое число

image

Ид логотипа

Целое число

count_bonus

Количество бонусов, начисляемое пользователю за выполнения условия

Целое число

description

Подробное описание награды, условие получения.

Строка

1 - Типы наград:
  • Handheld - Назначается вручную
  • Registration - За регистрацию на сайте
  • Referral - За статус Рефералодатель
  • Ordering - За оформление заказа
  • TurnoverUser - За суммарный оборот
2 - Поле settings заполняется следующим образом:
  • Если тип награды Ordering
  • settings[require_count] - Указываем количество заказов
  • Если тип награды TurnoverUser
  • settings[require_turnover] - Оборот пользователя
  • settings[require_period] - Период учёта оборота

В случаях не описанных в данном параграфе, заполнение данного поля не имеет смысла.

3 - Период учёта награды:
  • month - Месяц
  • quarter - Квартал
  • halfyear - Полгода
  • year - Год
  • All - За всё время

Результат

После успешного выполнения возвращает массив со следующими ключами:

Ключ Значение
id

Идентификатор добавленной записи

Целое число

status

Статус завершения операции

значение "success"

В случае неудачи метод вернёт массив со следующими ключами:

Ключ Значение
status

Статус завершения операции

значение "error"

error_description

Описание возникшей ошибки

Пример вызова

https://{адрес_сайта}/rest/{id_пользователя}/{код_доступа}/sw24loyaltyprogram.achieve.add/?sort=22&active=1& name=Имя награды&image=26654&count_bonus=99&type=TurnoverUser& settings[require_turnover]=543&settings[require_period]=year