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

Описание

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

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	Да	Идентификатор программы лояльности

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

JSON

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

XML

<xml>
    <token>abcdefghijklmnqrstuvwxyz</token>
    <code>CODE-1</code>
    <loyalty_id>5</loyalty_id>
</xml>

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

JSON

{
    "data": {
        "created": "2024-04-01T12:39:34Z",
        "is_attached": false,
        "is_activated": false,
        "is_expired": false,
        "attached": "",
        "activated": "",
        "expired": "",
        "expire_date": "",
        "loyalty_id": 5,
        "code": "CODE-1"
    },
    "error": 0,
    "error_text": "Successful operation"
}

XML

<xml>
    <data>
        <activated/>
        <attached/>
        <code>CODE-1</code>
        <created>2024-04-01T12:39:34Z</created>
        <expire_date/>
        <expired/>
        <is_activated>false</is_activated>
        <is_attached>false</is_attached>
        <is_expired>false</is_expired>
        <loyalty_id>5</loyalty_id>
    </data>
    <error>0</error>
    <error_text>Successful operation</error_text>
</xml>

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

Параметр	Тип	Описание
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	Идентификатор профиля, если промокод привязан