Подарки

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

В качестве подарка может выступать товар из вашего справочника, промокод или другой любой другой объект.

Создание и редактирование подарка

Создание подарка осуществляется запросом к методу /api/v2/gifts/manage/create/. При обращении вместе с авторизационными данными запросе обязательно должны быть переданы следующие поля:

• name - название подарка
• description - текстовое описание подарка
• points - стоимость подарка в бонусных баллах
• pic - изображение подарка (файл, переданный в теле запроса)

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

• sku - товарный идентификатор подарка
• enabled - статус подарка (1 - доступен для выдачи; 0 - нет)

🚧

Важно!

При отправке запроса на создание и редактирование подарка необходимо использовать метод POST

Редактирование подарка выполняется методом /api/v2/gifts/manage/edit/.
По структуре запроса / ответа и передаваемых параметров он аналогичен предыдущему, но со следующими отличиями:

• при редактировании подарка обязательно необходимо передать параметр gift_id - ID подарка
• передавать необходимо только те параметры, которые вы изменяете (либо все, тогда обновлены будут все)
• нельзя сменить тип подарка (с некупонов на купон)
• если у подарка тип купон, в случае если передаются параметры coupons - все новые неповторяющиеся будут добавлены к списку предыдущих купонов

Для получения списка всех созданных подарков нужно использовать метод /api/v2/gifts/list/.

Выдача подарка

Выдача подарка клиенту осуществляется методом /api/v2/gifts/purchases/new/. В запросе должен быть передан идентификатор клиента и подарка. В качестве идентификатора подарка используется его sku, если был указан при создании, или gift_id - идентификатор в Sailplay, который был возвращен при создании подарка в поле id.

Если того требует желаемая бизнес-логика при выдаче подарка можно передать номер заказа отдельным параметром order_num (поле не обязательно).

Для отмены выдачи подарков нужно отправить аналогичный запрос к методу /api/v2/gifts/purchases/delete/

Метод /gifts/purchases/edit используется для редактирования выданного подарка с целью его передачи другому клиенту. Помимо авторизационных данных в запросе требуется передать идентификатор транзакции выдачи подарка purchase_gift_id и идентификатор клиента, к которому будет привязана транзакция.