Сгораемые баллы за период

Описание

Возвращает количество баллов, подлежащих сгоранию за выбранный период по указанной валюте баллов.

URL-адрес

Метод: POST

https://example.com/api/v1.1/loyalty/account/expiring_points

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

Параметр	Тип	Пример	Обязательный	Описание
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	Внутренний идентификатор валюты баллов
date_from	string (RFC3339)	"2023-09-01T00:00:00Z"	Да	Начало периода (включительно)
date_to	string (RFC3339)	"2023-09-30T23:59:59Z"	Да	Окончание периода (включительно)
matching	string	"email"	Да	Способ поиска профиля. Возможные значения: "email", "phone", "profile_id", "custom"
field_name	string	"user_id"	Да, если matching = custom	Название пользовательского поля
field_value	string / int	"12345"	Да, если matching = custom	Значение пользовательского поля
email	string	"user@example.com"	Да, если matching = email	Email участника
phone	string	"+1234567890"	Да, если matching = phone	Телефон участника в международном формате
profile_id	string	"profile_123"	Да, если matching = profile_id	Идентификатор профиля

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

JSON

{
  "token": "abc123def456",
  "loyalty_program_id": 123,
  "points_currency_eid": "bonus_points",
  "matching": "email",
  "email": "user@example.com",
  "date_from": "2023-09-01T00:00:00Z",
  "date_to": "2023-09-30T23:59:59Z"
}

XML

<xml>
  <token>abc123def456</token>
  <loyalty_program_id>123</loyalty_program_id>
  <points_currency_eid>bonus_points</points_currency_eid>
  <matching>email</matching>
  <email>user@example.com</email>
  <date_from>2023-09-01T00:00:00Z</date_from>
  <date_to>2023-09-30T23:59:59Z</date_to>
</xml>

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

JSON

{
  "data": {
    "expiring_points": "150.24"
  },
  "error": 0,
  "error_text": "Successful operation"
}

XML

<xml>
  <data>
    <expiring_points>150.24</expiring_points>
  </data>
  <error>0</error>
  <error_text>Successful operation</error_text>
</xml>

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

Параметр	Тип	Описание
error	int	Код ошибки
error_text	string	Текст ошибки
expiring_points	string	Количество баллов, которые сгорят в указанный период