Настройки программы лояльности

Описание настроек

У каждого магазина имеются следующие базовые настройки программы лояльности:

cashback_rate

Эта настройка отвечает за процент вознаграждения (кэшбэка), который будет получать каждый покупатель после успешного выполнения заказа.

payment_rate

Эта настройка отвечает за процент суммы заказа, который может быть оплачен ранее накопленными бонусами.

cashier_reward_rate

Эта настройка отвечает за процент вознаграждения (кэшбэка), который будет получать каждый продавец после успешного выполнения заказа.

allow_cashback_with_payments

Эта настройка позволяет включить или отключить начисление кэшбэка за заказы, которые были оплачены бонусами. При отключенной настройке покупатель сможет либо оплатить заказ бонусами, либо получить кэшбэк. При активной настройке покупатель сможет и выполнить оплату бонусами, и получить кэшбэк.

base_cashback_amount_type

Эта настройка определяет тип суммы, с которой будет расчитываться кэшбэк. Если выбрано значение unpaid, то будет использоваться сумма заказа за исключением суммы, оплаченной бонусами. Если выбрано значение total, то будет использоваться вся сумма заказа.

Эта настройка не имеет силы, если значение настройки allow_cashback_with_payments установлено в false. В этом случае кэшбэк будет расчитываться со всей суммы заказа.

welcome_bonuses_source

Первый заказ покупателя, совершённый из указанного канала продаж, будет вознаграждён дополнительными приветственными бонусами. Если значением этой настройки является null, это означает, что приветственные бонусы отключены.

Канал продаж определяется по заголовку X-Zenky-Client.

welcome_bonuses_type

Приветственные бонусы могут быть начислены двумя способами:

  1. Покупатель вознаграждается фиксированной суммой бонусов, это значение одинаково для всех покупателей;
  2. Покупатель вознаграждается процентом от суммы заказа.

welcome_bonuses_amount

Если значением настройки welcome_bonuses_type является amount, в этом поле будет указана сумма фиксированных бонусов. Иначе значением настройки будет null.

welcome_bonuses_percentage

Если значением настройки welcome_bonuses_type является percentage, в этом поле будет указана процент суммы заказа. Иначе значением настройки будет null.

referral_program

Реферральная программа или программа "Пригласи друга" позволяет связывать покупателей друг с другом и начислять им бонусы в зависимости от настроек.

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

Настройки реферральной программы имеют следующую структуру:

Описания реферральной программы

Поле referral_program.offers может содержать два объекта с подробным описанием программы лояльности:

  1. join — это описание нужно показывать новым покупателям, которые ещё не имеют аккаунта в магазине. В нём содержится информация о подарках за регистрацию и список требуемых действий;
  2. invite — это описание нужно показывать существующим покупателям. В нём содержится информация о подарках за приглашение друзей и список требуемых действий.

И referral_program.offers.join, и referral_program.offers.join имеют одинаковую структуру:

Получение настроек

Для получения настроек программы лояльности необходимо отравить GET-запрос на https://api.zenky.io/v2/loyalty/settings.

Изменение настроек

Для изменения настроек программы лояльности необходимо отравить PUT-запрос на https://api.zenky.io/v2/loyalty/settings.