Skip to content

Отчет по рефереру ​

Метод возвращает выручку и количество заказов, которые были совершены по реферальным кодам указанного реферера за выбранный период.

Учитываются заказы по всем реферальным программам реферера: в заказе сохраняется идентификатор реферера, а не конкретный код, поэтому в отчет попадают все коды партнера сразу.

GET https://api.rees46.ru/loyalty/referral/report/:identifier

Параметры ​

ПараметрОбязателен?Описание
identifierДаИдентификатор реферера, передается в пути запроса
shop_idДаAPI-ключ
shop_secretДаСекретный ключ API
date_fromДаПервый день периода в формате YYYY-MM-DD, включительно
date_toДаПоследний день периода в формате YYYY-MM-DD, включительно

Как считается отчет ​

В расчет попадают заказы, для которых одновременно выполняются условия:

  • к заказу применен любой из реферальных кодов реферера;
  • заказ находится в статусе «Исполнен»;
  • дата заказа входит в указанный период.

Период включает первый и последний день: при date_from=2026-03-02 и date_to=2026-03-10 учитываются заказы и за 2 марта, и за 10 марта.

Выручка по каждому заказу — это стоимость всех товаров после применения скидок и списания бонусов, но до оплаты сертификатом. В расчет входят все товары заказа, независимо от того, начислено ли за них вознаграждение реферала.

TIP

Если у реферера нет подходящих заказов, метод вернет успешный ответ с нулевыми значениями.

Запрос ​

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

shell
curl "https://api.rees46.ru/loyalty/referral/report/79000000000?shop_id=...&shop_secret=...&date_from=2026-03-02&date_to=2026-03-10"

Ответ ​

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

json
{
  "status": "success",
  "payload": {
    "identifier": "79000000000",
    "date_from": "2026-03-02",
    "date_to": "2026-03-10",
    "orders_count": 12,
    "revenue": 145300.5
  }
}

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

ПараметрОписание
statusЗапрос выполнен успешно или нет
payload.identifierИдентификатор реферера
payload.date_fromПервый день периода расчета
payload.date_toПоследний день периода расчета
payload.orders_countКоличество заказов реферера за период
payload.revenueСуммарная выручка по заказам реферера за период

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

json
{
  "status": "error",
  "message": "Parameters `date_from` and `date_to` are required"
}