Получить уровень профиля в программе лояльности

Описание

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

URL-адрес

Метод: POST

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

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

Параметр	Тип	Пример	Обязательный	Описание
loyalty_program_id	int	123	Да	Идентификатор программы лояльности
tiers_group_id	int	10	Да	Идентификатор группы уровней (например, 10)
matching	string	"email"	Да	Способ поиска профиля. Возможные значения: "email", "phone", "profile_id", "custom"
field_name	string	"user_id"	Да, если matching = custom	Название пользовательского поля, используемого для поиска
field_value	string / int	123456	Да, если matching = custom	Значение пользовательского поля
email	string	"user@example.com"	Да, если matching = email	Email для поиска профиля
phone	string	"+1234567890"	Да, если matching = phone	Номер телефона в международном формате
profile_id	string	"profile123"	Да, если matching = profile_id	Идентификатор профиля
token	string	"abc123def456"	Да	API-токен для авторизации

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

JSON

{
  "loyalty_program_id": 123,
  "tiers_group_id": 10,
  "matching": "email",
  "field_name": "user_id",
  "field_value": 123456,
  "email": "user@example.com",
  "phone": "+1234567890",
  "profile_id": "profile123",
  "token": "abc123def456"
}

XML

<xml>
    <loyalty_program_id>123</loyalty_program_id>
    <tiers_group_id>10</tiers_group_id>
    <matching>email</matching>
    <field_name>user_id</field_name>
    <field_value>123456</field_value>
    <email>user@example.com</email>
    <phone>+1234567890</phone>
    <profile_id>profile123</profile_id>
    <token>abc123def456</token>
</xml>

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

JSON

{
  "error": 0,
  "error_text": "Successful operation",
  "data": [
    {
      "tiers_group_type": "cumulative",
      "tier_eid": "silver1-2",
      "tier_id": 13,
      "tier_order": 1,
      "reached_at": "2024-06-15T09:12:34Z"
    },
    {
      "tiers_group_type": "cumulative",
      "tier_eid": "gold1-3",
      "tier_id": 14,
      "tier_order": 2,
      "reached_at": "2024-09-01T12:34:56Z"
    }
  ]
}

XML

<xml>
    <data>
        <tiers_group_type>cumulative</tiers_group_type>
        <tier_eid>silver1-2</tier_eid>
        <tier_id>13</tier_id>
        <tier_order>1</tier_order>
        <reached_at>2024-06-15T09:12:34Z</reached_at>
    </data>
    <data>
        <tiers_group_type>cumulative</tiers_group_type>
        <tier_eid>gold1-3</tier_eid>
        <tier_id>14</tier_id>
        <tier_order>2</tier_order>
        <reached_at>2024-09-01T12:34:56Z</reached_at>
    </data>
    <error>0</error>
    <error_text>Successful operation</error_text>
</xml>

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

Параметр	Тип	Описание
error	int	Код ошибки
error_text	string	Текст ошибки
tiers_group_type	string	Тип группы уровней
tier_eid	string	Внешний идентификатор уровня
tier_id	int	Идентификатор уровня
tier_order	int	Порядковый номер уровня (от 0)
reached_at	string	Дата достижения уровня в формате RFC3339