Mindbox
Промокоды и промоакции

Установка персональных предложений

Набор шагов

ШагОписание
Клиент - Авторизованный / Неавторизованный - Получить существующего, ищем по...Предназначен для поиска клиента в Mindbox. Поиск происходит по одному или нескольким параметрам, которые выбираются из выпадающего списка: id в Mindbox, email, мобильный телефон, дисконтная карта и др.
Продукт - Установить персональные предложенияПредназначен для установки персональных предложений клиенту в выбранный список. В зависимости от настроек списка определяется набор полей для передачи

Прежде чем начать

1. Создайте список для хранения персональных предложений,в Настройках - Лояльность - Персональные предложения (Как настроить персональные предложения). 2. Убедитесь, что настройки “Хранить размер бенефита в списке” и "Тип персонального предложения" соответствуют требованиям реализуемой механики.

Описание метода

Операция добавляет в список с персональными предложениями:

  • продукты,
  • группы продуктов,
  • категории продуктов,
  • сегмент продуктов.

Персональное предложение с установкой через API

Размер персонального предложения можно установить в промоакциях или сохранить в списке с персональными предложениями.


Для хранения размера бенефита в списке с персональными предложениями создайте список с параметром “Хранить размер бенефита в списке”.

Описание запроса

Массив personalOffers передаёт информацию о продуктах или категориях продуктов, которые будут добавлены в список с персональными предложениями.

Один элемент в массиве - одно предложение на продукт/категорию, включает:

  • Тип предложения:
    • узел product - идентификатор продукта во внешней системе
    • узел productGroup - идентификатор группы продуктов во внешней системе
    • узел productCategory - идентификатор категории продуктов во внешней системе
    • узел productSegment - идентификатор сегмента в Mindbox
  • поле startDateTimeUtc - дата начала действия предложения, должна быть позже текущей даты-времени. (Формат: yyyy-MM-dd HH:mm)
  • поле endDateTimeUtc - дата окончания действия предложения, должна быть позже текущей даты-времени. (Формат: yyyy-MM-dd HH:mm)

Если размер персонального предложения хранится в списке:

  • узел benefit определяет условия персонального предложения:
  • узел amount устанавливает скидку на продукт в персональном предложении, cодержит:
    • поле value - Размер скидки.

    • поле type - Тип скидки.

      Значения для скидочных промоакций: Price - цена продукта, Percent - скидка в процентах от цены, Absolute - абсолютное значение скидки.

      Значения для бальных промоакций: Percent - количество баллов в процентах от цены, Absolute - абсолютное значение баллов.

В узле customer передайте одно или несколько значений, с помощью которых система будет искать клиента. Какую информацию нужно передать, зависит от настроек сделанных в операции для шага "Получить существующего".

Для продукта

POST https://api.mindbox.ru/v3/operations/{синхронная/асинхронная операция}?endpointId={Идентификатор точки интеграции}&operation={Название операции} Content-Type: application/json; charset=utf-8 Accept: application/json Authorization: SecretKey {Секретный ключ} { "personalOffers": [ { "product": { "ids": { "website": "<Id Product во внешней системе>" } }, "startDateTimeUtc": "<Дата начала действия предложения>", "endDateTimeUtc": "<Дата окончания действия предложения>", "benefit": { "amount": { "value": "<Размер бенефита предложения>", "type": "<Тип: Price / Percent / Absolute)>" } } }, { "product": { "ids": { "website": "<Id Product во внешней системе>" } }, "startDateTimeUtc": "<Дата начала действия предложения>", "endDateTimeUtc": "<Дата окончания действия предложения>", "benefit": { "amount": { "value": "<Размер бенефита предложения>", "type": "<Тип: Price / Percent / Absolute)>" } } } ], "customer": { "ids": { "mindboxId": "<Id клиента в Mindbox>" } } }

Для группы продуктов

POST https://api.mindbox.ru/v3/operations/{синхронная/асинхронная операция}?endpointId={Идентификатор точки интеграции}&operation={Название операции} Content-Type: application/json; charset=utf-8 Accept: application/json Authorization: SecretKey {Секретный ключ} { "personalOffers": [ { "productGroup": { "ids": { "website": "<Id Product во внешней системе>" } }, "startDateTimeUtc": "<Дата начала действия предложения>", "endDateTimeUtc": "<Дата окончания действия предложения>", "benefit": { "amount": { "value": "<Размер персонального предложения>", "type": "<Тип: Price / Percent / Absolute)>" } } }, { "productGroup": { "ids": { "website": "<Id Product во внешней системе>" } }, "startDateTimeUtc": "<Дата начала действия предложения>", "endDateTimeUtc": "<Дата окончания действия предложения>", "benefit": { "amount": { "value": "<Размер персонального предложения>", "type": "<Тип: Price / Percent / Absolute)>" } } } ], "customer": { "ids": { "mindboxId": "<Id клиента в Mindbox>" } } }

Для категории

POST https://api.mindbox.ru/v3/operations/{синхронная/асинхронная операция}?endpointId={Идентификатор точки интеграции}&operation={Название операции} Content-Type: application/json; charset=utf-8 Accept: application/json Authorization: SecretKey {Секретный ключ} { "personalOffers": [ { "productCategory": { "ids": { "website": "<Id Product во внешней системе>" } }, "startDateTimeUtc": "<Дата начала действия предложения>", "endDateTimeUtc": "<Дата окончания действия предложения>", "benefit": { "amount": { "value": "<Размер бенефита предложения>", "type": "<Тип: Price / Percent / Absolute>" } } }, { "productCategory": { "ids": { "website": "<Id Product во внешней системе>" } }, "startDateTimeUtc": "<Дата начала действия предложения>", "endDateTimeUtc": "<Дата окончания действия предложения>", "benefit": { "amount": { "value": "<Размер бенефита предложения>", "type": "<Тип: Price / Percent / Absolute>" } } } ], "customer": { "ids": { "mindboxId": "<Id клиента в Mindbox>" } } }

Для сегментации продуктов

POST https://api.mindbox.ru/v3/operations/{синхронная/асинхронная операция}?endpointId={Идентификатор точки интеграции}&operation={Название операции} Content-Type: application/json; charset=utf-8 Accept: application/json Authorization: SecretKey {Секретный ключ} { "personalOffers": [ { "startDateTimeUtc": "<Дата начала действия предложения>", "endDateTimeUtc": "<Дата окончания действия предложения>", "productSegment": { "externalId": "<Внешний идентификатор сегмента>" }, "benefit": { "amount": { "value": "<Размер бенефита предложения>", "type": "<Тип: Price / Percent / Absolute>" } } }, { "startDateTimeUtc": "<Дата начала действия предложения>", "endDateTimeUtc": "<Дата окончания действия предложения>", "productSegment": { "externalId": "<Внешний идентификатор сегмента>" }, "benefit": { "amount": { "value": "<Размер бенефита предложения>", "type": "<Тип: Price / Percent / Absolute>" } } } ] }

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


JSONCode
// Метод добавляет продукт с Id 3384 в список Любимый продукт, для клиента с Id 317. // Дополнительно устанавливаются даты начала и окончания действия предложения POST https://api.mindbox.ru/v3/operations/{синхронная/асинхронная операция}?endpointId={Идентификатор точки интеграции}&operation={Название операции} Content-Type: application/json; charset=utf-8 Accept: application/json Authorization: SecretKey {Секретный ключ} { "personalOffers": [ { "product": { "ids": { "website": "3384" } }, "startDateTimeUtc": "17.06.2024 12:30", "endDateTimeUtc": "24.06.2024 12:30" } ], "customer": { "ids": { "mindboxId": "317" } } }

Описание ответа

JSONJSON
{ "status": "Статус операции" }

Результат выполнения в переменной status:

  • Success в случае успеха,
  • ValidationError в случае ошибки пользователя,
  • ProtocolError в случае ошибки интеграции,
  • InternalServerError в случае недоступности сервера.
Last modified on