Перейти к основному содержимому

Подарки

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

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

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

Создание подарка​

Создание подарка выполняется запросом к методу:

  • /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/

Редактирование выдачи подарка​

Метод редактирования выдачи подарка:

  • /api/v2/gifts/purchases/edit/

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

Помимо авторизационных данных в запросе требуется передать:

  • purchase_gift_id — идентификатор транзакции выдачи подарка
  • идентификатор клиента, к которому будет привязана транзакция