Атрибуты покупок и позиций

В некоторых случаях, в основном для аналитики, необходимо записывать для покупок дополнительную информацию. Например, такую, как:

менеджер(кассир), совершивший продажу;
рекламный источник(флаер, листовка);
тип магазина и прочее.

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

В рамках Sailplay основных применений два:

аналитика - в фильтрах платформы поддерживаются атрибуты как товаров, так и покупок
использование в акциях - в условии акций “совершить покупку” можно поставить флаг “указать характеристики” и выбрать атрибуты их значения, которые будут учитываться при проверке выполнения условия.

По такому же принципу в условиях и вознаграждениях, где фигурируют товары (например условие “купить товар” или вознаграждение “скидка на товар”) можно указать атрибуты товаров.

Для атрибутов покупок и позиций поддерживаются следующие типы данных:

string
boolean
decimal
text
date

Атрибуты покупок и их значения

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

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

Для получения списка всех созданных атрибутов покупок используется метод /purchases/purchase-attributes/list.

При создании, удалении или получении списка значений атрибутов в запросе необходимо указать идентификатор или наименование целевого атрибута.

Добавление / удаление атрибутов загруженных покупок

В Sailplay API предусмотрена возможность добавлять и удалять атрибуты и значения для покупок, загруженных в систему ранее. Это может быть полезно для более удобного использования инструментов аналитики, так как позволяет присвоить необходимые значения атрибутов для уже созданных покупок.

Для добавления атрибута и значения к покупке требуется отправить запрос к методу /purchases/attributes/add и передать в него идентификатор покупки purchase_id, а также идентификаторы атрибута и его значения. В ответе, в поле id будет содержаться идентификатор атрибута-значения для данной покупки.

Чтобы удалить атрибут покупки вместе со значением в запросе должен быть передан идентификатор атрибута-значения, полученный при присвоении данных характеристик.

Получить список атрибутов конкретной покупки можно запросом к методу /purchases/attributes/list

Атрибуты позиций

Атрибуты позиций передаются непосредственно в параметрах каждой позиций вместе с sku, ценой и количеством, входящих в массив cart:

cart={"1":{"sku":"0000","price":100,"quantity":1,"position_attribute":"value"}}