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

Набор шагов

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

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

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

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

Массив 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 передайте одно или несколько значений, с помощью которых система будет искать клиента. Какую информацию нужно передать, зависит от настроек сделанных в операции для шага "Получить существующего".

Для продукта

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

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

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

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

Code
// Метод добавляет продукт с 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"
        }
    }
}

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

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

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

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