К содержимому
Интеграции

Промокоды

Обновлено

Просмотр

Для просмотра нужно право «Промокоды» из группы «Чтение». Инструмент devapi_get_promocodes возвращает список с признаком active. Параметр active_only=true оставляет только записи с этим признаком.

Создание

Для создания нужно право «Создать промокод» из группы «Промокоды». Инструмент devapi_create_promocode передаёт данные в кабинет разработчика.

Параметр Что делает Значения / по умолчанию
account_id Выбирает аккаунт Необязателен при единственном аккаунте
code Задаёт код Обязательная строка длиной до 10 символов
percent Задаёт скидку Обязательное целое число от 1 до 100
products Выбирает продукты Обязательный непустой массив slug из devapi_get_products
type Определяет повторное использование multi — многоразовый, по умолчанию; single — одноразовый
start_date Дата начала действия YYYY-MM-DD; необязательна
end_date Дата окончания действия YYYY-MM-DD; необязательна
description Комментарий к коду в кабинете Необязательная строка
confirm Подтверждает изменение кабинета Для выполнения передать true

Код без продуктов плагин не принимает. Уникальность проверяет кабинет: если код занят, ответ содержит ошибку кабинета. Плагин не реализует редактирование существующего кода отдельным инструментом.

Создание выполняется в кабинете, без промежуточного черновика плагина. Период действия задаётся переданными датами и обрабатывается кабинетом.

Подготовь многоразовый промокод HELP10 со скидкой 10%.
Продукт выбери по slug из devapi_get_products.
Сначала покажи выбранный аккаунт и все параметры.
Создание выполни после моего подтверждения с confirm=true.

Удаление

Нужно право «Удалить промокод». У devapi_delete_promocode параметры account_id, обязательная непустая строка code и confirm=true. Успешный ответ содержит deleted: true и удалённый код.

Удали промокод HELP10 в выбранном аккаунте разработчика.
Подтверждаю удаление; передай confirm=true.

Без confirm=true создание и удаление возвращают confirm_required. Плагин проверяет переданный параметр; порядок обсуждения и получения согласия пользователя зависит от поведения агента.