Получить все промокоды

Описание

Позволяет выгрузить все промокоды и их текущий статус одним списком данных.

URL-адрес

Метод: POST

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

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

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

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

JSON

{
  "loyalty_id": 6,
  "token": "abcdefghijklmnqrstuvwxyz"
}

XML

<xml>
    <loyalty_id>6</loyalty_id>
    <token>abcdefghijklmnqrstuvwxyz</token>
</xml>

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

JSON

{
  "data": [
    {
      "code": "Code-1"
    },
    {
      "code": "Code-2",
      "attached": "2024-04-01T14:02:05Z",
      "activated": "2024-04-01T14:04:12Z"
    },
    {
      "code": "Code-3"
    }
  ],
  "error": 0,
  "error_text": "Successful operation"
}

XML

<xml>
    <data>
        <code>Code-1</code>
    </data>
    <data>
        <activated>2024-04-01T14:04:12Z</activated>
        <attached>2024-04-01T14:02:05Z</attached>
        <code>Code-2</code>
    </data>
    <data>
        <code>Code-3</code>
    </data>
    <error>0</error>
    <error_text>Successful operation</error_text>
</xml>

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

Параметр	Тип	Описание
data	array	Список промокодов
data.code	string	Идентификатор промокода и сам промокод
data.attached	string	Дата присоединения к профилю, нет поля если не присоединялось
data.activated	string	Дата активации промокода, нет поля если активации не было
data.expire_date	string	Дата, когда промокод будет просрочен, может быть не установлено
data.expired	string	Дата, когда промокод был просрочен, нет поля если не просрочен
error	int	Код ошибки
error_text	string	Текст ошибки