Промо-акции (promotion)

promotion

Результат: список элементов

Промо-акции

Уровень доступа: admin

Параметр	Значение
id	Id
name	Наименование
fromdate	Дата начала
todate	Дата окончания
status	Состояние
project_name	Провайдер

Архив промо-акций

Функция: promotion.archived

Результат: список элементов

Уровень доступа: admin

Параметр	Значение
id	Id
name	Наименование
fromdate	Дата начала
todate	Дата окончания
status	Состояние
project_name	Провайдер

Скидки

Функция: promotion.discount

Результат: список элементов

Уровень доступа: admin

Параметр	Значение
id	Id
name	Наименование
actiontype	Действует на

Удалить

Функция: promotion.discount.delete

Уровень доступа: admin

Параметры:

elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции promotion.discount.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование скидки

Функция: promotion.discount.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

Параметры:
- plid — уникальный идентификатор родительского списка (элемент id из функции promotion.archived).
- elid — уникальный идентификатор (элемент id из функции promotion.discount)
Результат: список параметров объекта

Создание объекта:

Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- plid — уникальный идентификатор родительского списка (элемент id из функции promotion.archived).
- дополнительные параметры запроса ...
Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- plid — уникальный идентификатор родительского списка (элемент id из функции promotion.archived).
- elid — уникальный идентификатор (элемент id из функции promotion.discount)
- дополнительные параметры запроса ...
Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см. выше):

Параметр	Значение
type	Тип скидки. Способ предоставления скидки
percentage	Скидка в % на стоимость услуги/товара
actiontype	Действует. Выберите на что действует скидка. Обратите внимание, что скидка на продление не будет действовать на тарифы с ежедневным списанием
period	Период заказа, на который распространяется скидка
validity	Срок действия. Выберите, как будет действовать скидка: без ограничений на весь период заказа или только на часть.
validitylength	Срок действия, месяцев. Укажите на сколько месяцев будет действовать скидка

Условия

Функция: promotion.condition

Результат: список элементов

Уровень доступа: admin

Параметр	Значение
id	Id
condition	Условие
cgroup	Группа условий

Удалить

Функция: promotion.condition.delete

Уровень доступа: admin

Параметры:

elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции promotion.condition.

Результат: успешное выполнение операции или сообщение об ошибке

Условие участия в промо-акции

Функция: promotion.condition.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

Параметры:
- plid — уникальный идентификатор родительского списка (элемент id из функции promotion.archived).
- elid — уникальный идентификатор (элемент id из функции promotion.condition)
Результат: список параметров объекта

Создание объекта:

Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- plid — уникальный идентификатор родительского списка (элемент id из функции promotion.archived).
- дополнительные параметры запроса ...
Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- plid — уникальный идентификатор родительского списка (элемент id из функции promotion.archived).
- elid — уникальный идентификатор (элемент id из функции promotion.condition)
- дополнительные параметры запроса ...
Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см. выше):

Параметр	Значение
ctype	Условие, по которому будет проверяться применимость акции для клиента
comparison	Условие сравнения значения
period	Период заказа
periodtype	Тип указываемого периода
periodlength	Длина указываемого периода
amount	Количество услуг выбранного типа или тарифного плана
currency	Валюта расчетов
summa	Сумма в выбранной валюте
affiliate	Реферальная программа. Клиенты, пришедшие по выбранной реферальной программе, будут участвовать в промо-акции
account_group	Группа клиентов. Для возможности воспользоваться промо акцией клиент должен состоять в выбранной группе
group	Группа условий. Вы можете группировать условия. Условия в группе будут объединены оператором ИЛИ. Группы между собой связаны по оператору И. Пример: есть условия A, B и С объединенные в одну группу и есть условия D и E объединенные в другую группу. Итоговое выражение тогда будет — (A ИЛИ B ИЛИ С) И (D ИЛИ E)
groupname	Имя группы условий

Наименование

Функция: promotion.promocode

Результат: список элементов

Уровень доступа: admin

Параметр	Значение
id	Id
code	Промокод
uselimit	Лимит использования
use_count	Использован, Раз

Удалить

Функция: promotion.promocode.delete

Уровень доступа: admin

Параметры:

elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции promotion.promocode.

Результат: успешное выполнение операции или сообщение об ошибке

Список активаций промокодов

Функция: promocode.usage

Результат: список элементов

Уровень доступа: admin

Параметр	Значение
id	Код услуги
account	Клиент
status	Состояние
expense	Расходы

Редактирование промокода

Функция: promotion.promocode.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

Параметры:
- plid — уникальный идентификатор родительского списка (элемент id из функции promotion.archived).
- elid — уникальный идентификатор (элемент id из функции promotion.promocode)
Результат: список параметров объекта

Создание объекта:

Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- plid — уникальный идентификатор родительского списка (элемент id из функции promotion.archived).
- дополнительные параметры запроса ...
Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- plid — уникальный идентификатор родительского списка (элемент id из функции promotion.archived).
- elid — уникальный идентификатор (элемент id из функции promotion.promocode)
- дополнительные параметры запроса ...
Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см. выше):

Параметр	Значение
code	Шаблон промокода. При генерации значении символы "?" (знак вопроса) будут заменены случайными значениями.
count	Количество кодов. При генерации нескольких промокодов укажите необходимое количество
uselimit	Лимит использования. Укажите, сколько раз можно использовать одинаковый промокод
account_uselimit	Лимит использования на клиента. Укажите, сколько раз клиент может использовать одинаковый промокод
onlydigit	(Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) При генерации случайных значений будут использоваться только цифры
active_time_type	Период, в который промокод может быть активирован
fromdate	С даты. Дата, с которой начинается период действие промокода
todate	По дату. Дата, по которую действует промокод
expiretype	Срок действия скидки по промокоду. Скидка по промокоду будет действовать в течение указанного периода
periodtype	Тип указываемого периода
periodlength	Длина указываемого периода

Список активаций промокодов

Функция: promotion.promocode.usage

Результат: список элементов

Уровень доступа: admin

Параметр	Значение
promocode	Промокод
id	Код услуги
account	Клиент
status	Состояние
expense	Расходы

История изменений промо-акции

Функция: promotion.history

Результат: список элементов

Наименование изменено с "_old_value " на " new_value_"

Уровень доступа: admin

Параметр	Значение
changedate	Дата изменения
desc	Описание
user	Пользователь
ip	IP-адрес
action	Функция

Удалить

Функция: promotion.delete

Уровень доступа: admin

Параметры:

elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции promotion.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование промо-акции

Функция: promotion.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Параметры:
- elid — уникальный идентификатор (элемент id из функции promotion)
Результат: список параметров объекта

Создание объекта:

Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- дополнительные параметры запроса ...
Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- elid — уникальный идентификатор (элемент id из функции promotion)
- дополнительные параметры запроса ...
Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см. выше):

Параметр	Значение
name	Наименование
project	Провайдер промо-акции
fromdate	Срок действия с даты. Начало периода действия промо-акции
todate	по дату. Окончание периода действия промо-акции (включительно указанную дату)

Переместить выбранные промо-акции в архив

Функция: promotion.archive

Уровень доступа: admin

Параметры:

elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции promotion.

Результат: успешное выполнение операции или сообщение об ошибке

Установка фильтра

Функции: promotion.filter