Статус клиента, бенефиты и остатки лимитов

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

GET https://api.rees46.ru/loyalty/subscriptions/members/status

Параметры

Параметр	Обязателен?	Описание
shop_id	Да	API-ключ
shop_secret	Да	Секретный ключ API
identifier	Да	Номер телефона клиента, идентификатор участника ПЛ
subscription	Да	Уникальный код подписки

Запрос

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

curl https://api.rees46.ru/loyalty/subscriptions/members/status?shop_id=...&shop_secret=...&identifier=...&subscription=...

Ответ

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

{
  "success": true,
  "payload": {
    "message": "Successful request",
    "member": {
      "identifier": "...",
      "subscription": "...",
      "plan": "...",
      "active": true,
      "paid_till": "...",
      "limits_reset_date": "..."
    },
    "benefits": [
      {
        "code": "...",
        "name": "...",
        "data_type": "boolean",
        "value": true
      },
      {
        "code": "...",
        "name": "...",
        "data_type": "integer",
        "value": 3
      },
      {
        "code": "...",
        "name": "...",
        "data_type": "promos",
        "value": {
          "promotions": [
            {
              "id": 117,
              "name": "...",
              "status": "active"
            },
            {
              "id": 13,
              "name": "...",
              "status": "inactive"
            }
          ],
          "savings_limit": 5000,
          "savings_used": 3700,
          "savings_left": 1300,
          "usage_limit": 5,
          "usage_used": 3,
          "usage_left": 2
        }
      }
    ]
  }
}

В случае ошибки ответ будет в формате:

{
  "success": false,
  "payload": {
    "message": "API secret is not correct"
  }
}

Расшифровка ответа:

Параметр	Описание
success	Запрос выполнен успешно или нет
payload.message	Сообщение с результатом обработки запроса
payload.member	Объект с информацией о клиенте
payload.member.identifier	Идентификатор участника программы лояльности в формате 7XXXXXXXXXX
payload.member.subscription	Уникальный код подписки
payload.member.plan	Уникальный код плана
payload.member.active	Флаг, что подписка все еще активна. Будет равен false, если paid_till в прошлом
payload.member.paid_till	Дата, до которой оплачена подписка
payload.member.limits_reset_date	Дата, когда будет выполнен следующий сброс лимитов
payload.benefits[]	Массив со списком бенефитов клиента
payload.benefits[].code	Уникальный код бенефита
payload.benefits[].name	Название бенефита
payload.benefits[].data_type	Тип бенефита: boolean для флагов, integer для числовых лимитов, promos для акций
payload.benefits[].value	Значение бенефита: для типа boolean допустимы true и false, для типа integer число от 0 до 1,000,000, для типа promos объект с детальной информацией об акциях и лимитах
payload.benefits[].value.promotions[]	Массив акций в бенефите
payload.benefits[].value.promotions[].id	Идентификатор акции
payload.benefits[].value.promotions[].name	Название акции
payload.benefits[].value.promotions[].status	Статус акции: draft, scheduled, inactive, active, archived
payload.benefits[].value.savings_limit	Лимит скидок по указанным акциям
payload.benefits[].value.savings_used	Сколько скидок уже получено по этим акциям в текущий расчетный период
payload.benefits[].value.savings_left	Сколько скидок еще можно получить до конца расчетного периода
payload.benefits[].value.usage_limit	Лимит по кол-ву применения указанных акций
payload.benefits[].value.usage_used	Сколько раз уже были применены акции в текущий расчетный период
payload.benefits[].value.usage_left	Сколько еще раз осталось применить акции до конца расчетного период