Skip to content

История бонусных транзакций

Возвращает список бонусных транзакций на пополнение и списание за указанный период.

GET https://api.rees46.ru/loyalty/bonuses/history

Параметры

ПараметрОбязателен?Описание
shop_idДаAPI-ключ
shop_secretДаСекретный ключ API
identifierДаИдентификатор участника программы лояльности
limitНетКоличество транзакций в ответе. Не более 50
offsetНетСмещение от первой транзакции в ответе для постраничного вывода
statusНетСтатус транзакций: pending, confirmed, spent, cancelled, expired
activation_date_fromНетФильтрация по дате активации бонусов. Начало периода в формате YYYY-MM-DD
activation_date_toНетФильтрация по дате активации бонусов. Окончание периода в формате YYYY-MM-DD
expiration_date_fromНетФильтрация по дате сгорания бонусов. Начало периода в формате YYYY-MM-DD
expiration_date_toНетФильтрация по дате сгорания бонусов. Окончание периода в формате YYYY-MM-DD
created_date_fromНетФильтрация по дате создания бонусов. Начало периода в формате YYYY-MM-DD
created_date_toНетФильтрация по дате создания бонусов. Окончание периода в формате YYYY-MM-DD

Запрос

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

shell
curl https://api.rees46.ru/loyalty/bonuses/history?shop_id=...&shop_secret=...&identifier=...&offset=0&limit=50&status=active&...

Ответ

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

json
{
  "success": true,
  "payload": {
    "transactions": [
      {
        "date": "2025-01-01",
        "status": "confirmed",
        "event_source": "order",
        "event": null,
        "order_id": "pc19843",
        "amount": -300,
        "activation_date": "2025-01-14",
        "expiration_date": "2026-01-01"
      },
      {
        "date": "2025-01-01",
        "status": "confirmed",
        "event_source": "custom",
        "event": "registration",
        "order_id": null,
        "amount": 1000,
        "activation_date": "2025-01-14",
        "expiration_date": "2026-01-01"
      }
    ]
  }
}

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

ПараметрОписание
successЗапрос выполнен успешно или нет
payload.transactionsМассив транзакций
payload.transactions[]Объект транзакции
payload.transactions[].dateДата создания транзакции
payload.transactions[].statusСтатус
payload.transactions[].event_sourceИсточник транзакции. order - транзакция от заказа, все остальное - событийные бонусы
payload.transactions[].eventСобытие-источник транзакции для бонусов за действие
payload.transactions[].order_idИдентификатор заказа, если транзакция из заказа
payload.transactions[].amountСумма транзакции. Если меньше нуля, значит списание
payload.transactions[].activation_dateДата активации транзакции
payload.transactions[].expiration_dateДата сгорания транзакции

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

json
{
  "success": false,
  "payload": {
    "message": "Identifier is not valid"
  }
}