Импортировать промокоды
Описание
Импортировать промокоды в программу лояльности.
URL-адрес
Метод: POST
https://example.com/api/v1.1/promocodes/import
Параметры запроса
Параметр | Тип | Пример | Обязательный | Описание |
---|---|---|---|---|
token | string | "abcdefghijklmnqrstuvwxyz" | Да | API токен |
format | int | "json" | Нет | Формат возвращаемых данных (по умолчанию – "json") |
codes | JSON array | ["CODE-1", "CODE-2"] | Да | Список промокодов |
loyalty_id | int | 1 | Да | Идентификатор программы лояльности |
Пример запроса
- JSON
- XML
{
"codes": [
"CODE-1",
"CODE-2"
],
"loyalty_id": 6,
"token": "abcdefghijklmnqrstuvwxyz"
}
<xml>
<token>abcdefghijklmnqrstuvwxyz</token>
<codes>CODE-1</codes>
<codes>CODE-2</codes>
<loyalty_id>6</loyalty_id>
</xml>
Пример ответа
- JSON
- XML
{
"data": [
{
"code": "CODE-1",
"error": 0,
"error_text": ""
},
{
"code": "CODE-2",
"error": 0,
"error_text": ""
}
],
"discarded_by_limit": 0,
"duplicated": 0,
"error": 0,
"error_text": "Successful operation",
"inserted": 2
}
<xml>
<data>
<code>CODE-1</code>
<error>0</error>
<error_text/>
</data>
<data>
<code>CODE-2</code>
<error>0</error>
<error_text/>
</data>
<discarded_by_limit>0</discarded_by_limit>
<duplicated>0</duplicated>
<error>0</error>
<error_text>Successful operation</error_text>
<inserted>2</inserted>
</xml>
Возвращаемые параметры
Параметр | Тип | Описание |
---|---|---|
error | int | Код ошибки |
error_text | string | Текст ошибки |
code | string | Промокод |
discarded_by_limit | int | Превышение лимита программы |
duplicated | int | Дублирующиеся промокоды |
inserted | int | Промокодов импортировано |