Экспорт транзакций баллов

Описание

Создание задачи на формирование отчёта по транзакциям выбранных баллов за период. В ответе возвращается идентификатор задачи для отслеживания статуса.

URL-адрес

Метод: POST

https://example.com/api/v1.1/loyalty/transactions_export

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

Параметр	Тип	Пример	Обязательный	Описание
token	string	"abc123def456"	Да	API-токен
loyalty_program_id	int	123	Да	Идентификатор программы лояльности
points_currency_eid	string	"bonus_points"	Да, если не передан points_currency_iid	Внешний идентификатор валюты баллов
points_currency_iid	int	1	Да, если не передан points_currency_eid	Внутренний идентификатор валюты баллов
from_id	string	"a1b2c3d4-e5f6-7890-g1h2-i3j4k5l6m7n8"	Нет	Идентификатор транзакции (UUID) для пагинации; если не указан, экспорт с начала периода
date_from	string (RFC3339)	"2023-09-01T00:00:00Z"	Да	Начало периода (включительно)
date_to	string (RFC3339)	"2023-09-30T23:59:59Z"	Да	Окончание периода (включительно)

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

JSON

{
  "token": "abc123def456",
  "loyalty_program_id": 123,
  "points_currency_eid": "bonus_points",
  "date_from": "2023-09-01T00:00:00Z",
  "date_to": "2023-09-30T23:59:59Z",
  "from_id": "a1b2c3d4-e5f6-7890-g1h2-i3j4k5l6m7n8"
}

XML

<xml>
  <token>abc123def456</token>
  <loyalty_program_id>123</loyalty_program_id>
  <points_currency_eid>bonus_points</points_currency_eid>
  <date_from>2023-09-01T00:00:00Z</date_from>
  <date_to>2023-09-30T23:59:59Z</date_to>
  <from_id>a1b2c3d4-e5f6-7890-g1h2-i3j4k5l6m7n8</from_id>
</xml>

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

JSON

{
  "data": {
    "task_id": "task_b2f9fd6a-2499-4a63-b592-f15d4e3b69c5"
  },
  "error": 0,
  "error_text": "Successful operation"
}

XML

<xml>
  <data>
    <task_id>task_b2f9fd6a-2499-4a63-b592-f15d4e3b69c5</task_id>
  </data>
  <error>0</error>
  <error_text>Successful operation</error_text>
</xml>

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

Параметр	Тип	Описание
error	int	Код ошибки
error_text	string	Текст ошибки
task_id	string (UUID)	Идентификатор задачи на экспорт