Получить все промокоды
Описание
Позволяет выгрузить все промокоды и их текущий статус одним списком данных.
URL-адрес
Метод: POST
https://example.com/api/v1.1/promocodes/export_all
Параметры запроса
Параметр | Тип | Пример | Обязательный | Описание |
---|---|---|---|---|
token | string | "abcdefghijklmnqrstuvwxyz" | Да | API токен |
format | string | "json" | Нет | Формат возвращаемых данных (по умолчанию – "json") |
loyalty_id | int | 1 | Да | Идентификатор программы лояльности |
Пример запроса
{
"loyalty_id": 1,
"token": "abcdefghijklmnqrstuvwxyz"
}
Пример ответа
{
"data": [
{
"activated": "2018-08-10T08:00:00Z",
"attached": "2018-08-10T08:00:00Z",
"code": "CODE-12345"
}
],
"error": 0,
"error_text": "Successful operation"
}
Возвращаемые параметры
Параметр | Тип | Описание |
---|---|---|
data | array | Список промокодов |
data.code | string | Идентификатор промокода и сам промокод |
data.attached | string | Дата присоединения к профилю, нет поля если не присоединялось |
data.activated | string | Дата активации промокода, нет поля если активации не было |
data.expire_date | string | Дата, когда промокод будет просрочен, может быть не установлено |
data.expired | string | Дата, когда промокод был просрочен, нет поля если не просрочен |
error | int | Код ошибки |
error_text | string | Текст ошибки |