SetLoyalty ◾️ API

Полная документация API Set Loyalty доступна по ссылке на GitHub.

Раздел	Доступные операции		Описание
CDP:Покупатели API для управления покупателями и картами Set Loyalty из внешних систем. Документация API Set Loyalty CDP:Customers	Операции со покупателями
		POST /api/external/v1/clients	Зарегистрировать нового покупателя
		GET /api/external/v1/clients	Поиск покупателя по данным профиля
		GET /api/external/v1/clients/{clientId}	Найти покупателя по идентификатору
		PUT /api/external/v1/clients/{clientId}	Обновление персональных данных покупателя
		PATCH /api/external/v1/clients/{clientId}	Частичное обновление персональных данных покупателя
		DELETE /api/external/v1/clients/{clientId}	Удаление покупателя
		PUT /api/external/v1/clients/{clientId}/verifications/channels	Верифицировать каналы коммуникации
		GET /api/external/v1/clients/cards/{cardNumber}	Найти покупателя по номеру карты
		POST /api/external/v1/clients/{clientId}/unions	Объединить профили покупателей
	Операции с картами
		POST /api/external/v1/clients/{clientId}/cards	Создать карту с привязкой к клиенту
		POST /api/external/v1/cards	Создать карту с привязкой к анонимному клиенту
		DELETE /api/external/v1/cards/{cardNumber}	Удалить карту по номеру
		PUT /api/external/v1/cards/{cardNumber}/status	Изменить статус карты
		POST /api/external/v1/cards/{cardNumber}/transfers	Передать карту существующему клиенту
	Получение данных по покупкам
		GET /api/external/v1/clients/{clientId}/purchases	Получить информацию о покупках клиента
		GET /api/external/v1/clients/purchases/detailed	Получить подробную информацию по чеку
	Получение данных по бонусам
		GET /api/external/v1/clients/{clientId}/bonuses	Получить информацию по бонусным транзакциям

Бонусный процессинг API для управления бонусами Set Loyalty из внешних систем. Документация API Set Loyalty Bonuses	Операции со счетами
		GET /api/bonuses/v1/categories	Найти все категории счетов по фильтру с пагинацией
		GET /api/bonuses/v1/categories/{categoryId}/owners/{ownerId}/balances/active	Получить баланс доступный для списания для указанной категории счета и владельца
		GET /api/bonuses/v1/categories/{categoryId}/owners/{ownerId}/balances	Получить все (доступные и не доступные для списания) балансы для указанной категории счета и владельца
	Операции с бонусами
		POST /api/bonuses/v1/categories/{categoryId}/owners/{ownerId}/balance/accrue	Начисление на баланс
		POST /api/bonuses/v1/categories/{categoryId}/owners/{ownerId}/balance/writeoff	Списание с баланса
		POST /api/bonuses/v1/categories/{categoryId}/owners/{ownerId}/balance/reserve	Резервирование бонусов
	Операции с транзакциями
		POST /api/bonuses/v1/transactions/{id}/undo	Отмена транзакции
		POST /api/bonuses/v1/transactions/{id}/prolong	Продление транзакции начисления

Купоны API процессинга купонов Set Loyalty предназначен для управления категориями и жизненным циклом купонов. Документация API Set Loyalty Coupons	Операции с категориями
		POST /v1/category/create	Создать категорию
		POST /v1/category/update	Обновить категорию
		POST /v1/category/{categoryId}/ranges	Добавить диапазон
		POST /v1/category/{categoryId}/promo/codes	Добавить промокод
		DELETE /v1/category/ranges/{id}	Удалить диапазон категории купонов
		DELETE /v1/category/promo/codes/{id}	Удалить промокод
	Операции с купонами
		POST /coupon/v1/coupon/batch/issue	Выдать "пачку" купонов
		POST /coupon/v1/coupon/batch/use	Гашение купонов
		POST /coupon/v1/coupon/check	Получить купон по номеру
		POST /coupon/v1/coupon/count	Посчитать кол-во купонов
		POST /coupon/v1/coupon/issue	Выдать купон
		POST /coupon/v1/coupon/imported/issue	Выдать купон из загруженной серии
		POST /coupon/v1/coupon/imported/batch/issue	Выдать пачку купонов из загруженной серии
		POST /coupon/v1/coupon/list	Получить пачку купонов
		POST /coupon/v1/coupon/search	Найти купоны
		POST /coupon/v1/coupon/use	Использование купона
	Экспорт
		GET /export/v1/export/load/batches	Получить пачку купонов
	Импорт
		POST /v1/import/categories	Импортировать категории
		POST /v1/import/batch/status	Получить статус задачи
		POST /v1/import/coupons	Импорт купонов из файла
		POST /v1/import/error	Получить файл с ошибками импорта
		POST /v1/import/generate_coupons	Сгенерировать купоны для клиента
		POST /v1/import/generate_series	Генерация серии купонов
	Другие операции
		GET /api/digital/v1/coupons	Поиск купонов
		PUT /api/digital/v1/coupons/{number}	Изменение статуса купона

Импорт онлайн-покупок API для импорта покупок в Set Loyalty из внешних систем. Документация API Set Loyalty Purchase Import		POST /api/external/v1/dwh/import/purchase	Импорт чека

Set Omni. Расчет корзин для онлайн-каналов API для расчета корзин онлайн-каналов продаж. Документация Set Loyalty. Omni. Сервис процессинга скидок	Расчет скидок
		POST /api/v1/discounts/transactions	Расчет скидок на товары
	Управление транзакциями лояльности
		DELETE /api/v1/discounts/transactions/{id}	Отмена транзакции
		POST /api/v1/discounts/transactions/{id}/commit	Подтверждение транзакции
		POST /api/v1/discounts/transactions/{id}/returns	Возврат по транзакции

Сегменты API для создания, изменения и импорта сегментов из внешних систем. Документация API Set Loyalty Segments	Работа с покупателями
		GET /api/v2/clients/{clientId}/segments	Получить сегменты покупателя
		PUT /api/v2/clients/{clientId}/segments/{segmentId}	Добавить покупателя в сегмент
		DELETE /api/v2/clients/{clientId}/segments/{segmentId}	Удалить покупателя из сегмента
	Работа с сегментами
		GET /api/v2/segments	Поиск сегментов
		PUT /api/v2/segments	Создать или обновить сегмент
		GET /api/v2/segments/{segmentId}	Получить сегмент
		POST /api/v2/segments/external/ids	Получить следующий, незанятый ИД с проверкой имени на уникальность
		GET /api/v2/segments/{segmentId}/clients	Получить покупателей сегмента
		DELETE /api/v2/segments/{segmentId}/clients	Удалить всех покупателей из сегмента
		POST /api/v2/segments/archives	Архивировать сегмент
	Импорт сегментов (асинхронные операции)
		POST /api/v2/import/segments	Импорт сегментов
		POST /api/v2/import/segments/remove/clients	Удалить покупателей из сегментов
		POST /api/v2/import/segments/{segmentId}/add/clients	Добавить покупателей в сегмент
		POST /api/v2/import/segments/{segmentId}/remove/clients	Удалить покупателей из сегмента
	Экспорт сегментов (выгрузка данных)
		GET /api/v2/export/segments/{segmentId}/clients	Выгрузить покупателей сегмента
	Получение статуса асинхронных задач
		GET /api/v2/tasks/{taskId}	Получить статус задачи
		GET /api/v2/tasks	Получить список задач

Лимиты API для управления лимитами покупателей Set Loyalty Документация API Set Loyalty Limits		POST /api/limits/v1/apply	Уменьшение лимитов при успешной продаже
		POST /api/limits/v1/unapply	Отмена уменьшения лимитов при неуспешной продаже
		POST /api/limits/v1/check	Предоставить информацию об ограничениях

CDP:Покупатели

Бонусный процессинг

Купоны

Импорт онлайн-покупок

Set Omni. Расчет корзин для онлайн-каналов

Сегменты

Лимиты