Публичное пространство
SetLoyalty ◾️ API
Полная документация API Set Loyalty доступна по ссылке на GitHub.
Раздел | Доступные операции | Описание |
|---|---|---|
CDP:ПокупателиAPI для управления покупателями и картами Set Loyalty из внешних систем. Документация API Set Loyalty CDP:Customers | Операции с покупателями | |
| Зарегистрировать нового покупателя | |
Поиск покупателя по данным профиля | ||
Поиск покупателя по номеру телефона | ||
Найти покупателя по идентификатору | ||
Обновление персональных данных покупателя | ||
Частичное обновление персональных данных покупателя | ||
Удаление покупателя | ||
Верифицировать каналы коммуникации | ||
Найти покупателя по номеру карты | ||
Объединить профили покупателей | ||
Сгенерировать динамический код | ||
Операции с картами | ||
| Создать карту с привязкой к клиенту | |
Создать карту с привязкой к анонимному клиенту | ||
Удалить карту по номеру | ||
Изменить статус карты | ||
Передать карту существующему клиенту | ||
Купоны и промокоды | ||
| Получить категории купонов | |
Топология магазинов | ||
| Получить топологию магазинов | |
Получить список брендов/организаций | ||
Получение данных по покупкам | ||
| Получить информацию о покупках клиента | |
Получить подробную информацию по чеку | ||
Получение данных по бонусам | ||
| Получить информацию по бонусным транзакциям | |
Пуш-сообщения | ||
| Добавить/обновить токен для push-сообщений | |
Удалить токен для push-сообщений | ||
Подтвердить получение push-сообщения | ||
Коммуникации с внешними системами | ||
| Получить историю коммуникаций по покупателю | |
Связать идентификатор покупателя, зарегистрированного в программе лояльности, с его внешним идентификатором в учетной записи во внешней системе, например, в Telegram-боте | ||
Отправить сообщение | ||
Отправить сообщение с проверочным кодом | ||
Сверить проверочный код | ||
Любимые товары | ||
| Получить список доступных для выбора товаров | |
Выбрать товар как "Любимый товар" | ||
Операции по реферальной программе | ||
| Получить реферальный код клиента и сопутствующую информацию | |
Получить информацию по реферальному коду | ||
Операции с внешними событиями | ||
| Запустить внешнее событие | |
Получить типы внешних событий | ||
Анкета | ||
| Получить поля анкеты клиента | |
| ||
Бонусный процессингAPI для управления бонусами Set Loyalty из внешних систем. | Операции со счетами | |
| Найти все категории счетов по фильтру с пагинацией | |
Получить баланс доступный для списания для указанной категории счета и владельца | ||
Получить все (доступные и не доступные для списания) балансы для указанной категории счета и владельца | ||
Операции с бонусами | ||
| Начисление на баланс | |
Списание с баланса | ||
Резервирование бонусов | ||
Операции с транзакциями | ||
| Отмена транзакции | |
Продление транзакции начисления | ||
Экспорт | ||
| Получить список бонусных транзакций | |
| ||
КупоныAPI процессинга купонов Set Loyalty предназначен для управления категориями и жизненным циклом купонов. | Операции с категориями | |
| Создать категорию | |
Обновить категорию | ||
Добавить диапазон | ||
Получить кол-во промокодов https://crystals.atlassian.net/browse/LENTAL-112 https://crystals.atlassian.net/browse/CR-11697 10.4.5.0 | ||
Получить промокоды https://crystals.atlassian.net/browse/LENTAL-112 https://crystals.atlassian.net/browse/CR-11697 10.4.5.0 | ||
Добавить промокод | ||
Удалить все промокоды https://crystals.atlassian.net/browse/LENTAL-112 https://crystals.atlassian.net/browse/CR-11697 10.4.5.0 | ||
Удалить диапазон категории купонов | ||
Удалить промокод | ||
Операции с купонами | ||
| Выдать "пачку" купонов | |
Гашение купонов | ||
Получить купон по номеру | ||
Посчитать кол-во купонов | ||
Выдать купон | ||
Выдать купон из загруженной серии | ||
Выдать пачку купонов из загруженной серии | ||
Получить пачку купонов | ||
Найти купоны | ||
Использование купона | ||
Экспорт | ||
| Получить пачку купонов | |
Импорт | ||
| Импортировать категории | |
Получить статус задачи | ||
Импорт купонов из файла | ||
Импорт промокодов из файла https://crystals.atlassian.net/browse/LENTAL-112 https://crystals.atlassian.net/browse/CR-11697 10.4.5.0 | ||
Получить файл с ошибками импорта | ||
Сгенерировать купоны для клиента | ||
Генерация серии купонов | ||
Другие операции | ||
| Поиск купонов | |
Изменение статуса купона | ||
| ||
Импорт онлайн-покупокAPI для импорта покупок в Set Loyalty из внешних систем. |
| Импорт чека |
| ||
Set Omni. Расчет корзин для онлайн-каналовAPI для расчета корзин онлайн-каналов продаж. | Расчет скидок | |
| Расчет скидок на товары | |
Расчет скидок на каждый товар в запросе по отдельности https://crystals.atlassian.net/browse/SLS-3638 https://crystals.atlassian.net/browse/CR-11447 10.4.5.0 | ||
Расчет скидок корзины с указанием массива магазинов в запросе https://crystals.atlassian.net/browse/SLS-3639 https://crystals.atlassian.net/browse/CR-11447 10.4.5.0 | ||
Управление транзакциями лояльности | ||
| Отмена транзакции | |
Подтверждение транзакции | ||
Возврат по транзакции | ||
| ||
СегментыAPI для создания, изменения и импорта сегментов из внешних систем. | Работа с покупателями | |
| Получить сегменты покупателя | |
Добавить покупателя в сегмент | ||
Удалить покупателя из сегмента | ||
Работа с сегментами | ||
| Поиск сегментов | |
Создать или обновить сегмент | ||
Получить сегмент | ||
Получить следующий, незанятый ИД с проверкой имени на уникальность | ||
Получить покупателей сегмента | ||
Удалить всех покупателей из сегмента | ||
Архивировать сегмент | ||
Импорт сегментов (асинхронные операции) | ||
| Импорт сегментов | |
Удалить покупателей из сегментов | ||
Добавить покупателей в сегмент | ||
Удалить покупателей из сегмента | ||
Экспорт сегментов (выгрузка данных) | ||
| Выгрузить покупателей сегмента | |
Получение статуса асинхронных задач | ||
| Получить статус задачи | |
Получить список задач | ||
| ||
ЛимитыAPI для управления лимитами покупателей Set Loyalty | Ручное управление акционными ограничениями | |
| Уменьшение лимитов при успешной продаже | |
Отмена уменьшения лимитов при неуспешной продаже | ||
Предоставить информацию об ограничениях | ||
Получение текущих лимитов покупателя | ||
| Предоставить информацию о глобальных ограничениях по покупателю https://crystals.atlassian.net/browse/SLS-3716 https://crystals.atlassian.net/browse/CR-12068 10.4.6.0 | |
| ||
Интеграция с кассовыми системамиAPI позволяет производить расчет скидок и сохранять чеки от внешних касс. Документация API Set Loyalty. Интеграция с кассовыми системами | Поиск и авторизация покупателей | |
| Поиск и авторизация покупателя | |
Отправить сообщение с кодом подтверждения | ||
Расчет скидок и преференций для покупки | ||
| Предварительный расчет | |
Получить результат предварительного расчета | ||
Отменить результат предварительного расчета | ||
Зафиксировать покупку | ||
Сохранение чека | ||
| Добавить чек без предварительного расчета | |