Получить информацию о промокоде

Описание

Получить подробную информацию о промокоде.

URL-адрес

Метод: POST

https://example.com/api/v1.1/promocodes/get

Параметры запроса

Параметр	Тип	Пример	Обязательный	Описание
token	string	"abcdefghijklmnqrstuvwxyz"	Да	API токен
format	string	"json"	Нет	Формат возвращаемых данных (по умолчанию – "json")
code	string	"CODE-12345"	Да	Промокод
loyalty_id	int	1	Да	Идентификатор программы лояльности

Пример запроса

{
    "code": "CODE-12345",
    "loyalty_id": 1,
    "token": "abcdefghijklmnqrstuvwxyz"
}

Пример ответа

{
    "data": {
        "created": "2020-04-02T11:41:47Z",
        "is_attached": true,
        "is_activated": false,
        "is_expired": false,
        "attached": "2020-04-02T16:58:15Z",
        "activated": "",
        "expired": "",
        "expire_date": "",
        "loyalty_id": 1,
        "code": "CODE-12345",
        "database_id": 1,
        "profile_id": "5c94fbc103e42237764042f8"
    },
    "error": 0,
    "error_text": "Successful operation"
}

Возвращаемые параметры

Параметр	Тип	Описание
error	int	Код ошибки
error_text	string	Текст ошибки
data.activated	string	Дата и время активации
data.attached	string	Дата и время назначения
data.code	string	Промокод
data.created	string	Дата и время создания
data.expire_date	string	Дата и время, когда код истечёт
data.expired	string	Дата и время, когда код истёк
data.is_activated	bool	true если код активирован
data.is_attached	bool	true если код назначен
data.is_expired	bool	true если код истёк
data.loyalty_id	int	Идентификатор программы лояльности
data.database_id	int	Идентификатор базы данных, если промокод привязан к профилю
data.profile_id	string	Идентификатор профиля, если промокод привязан