Добавление в корзину

Нужно передавать это событие, когда клиент добавляет товар в корзину.

Важно

Если товар можно добавить в корзину из результатов поиска или из просмотра товаров в категории, это событие тоже нужно передавать. При этом, если клиент перешел на список товаров из поиска REES46, то нужно передать и атрибуцию параметрами recommended_by и recommended_code.

На данное событие завязаны следующие механики платформы:

Триггер "Брошенная корзина"
Триггер "Цена на товар в корзине снижена"
Отображение корзины в карточке клиента
Некоторые товарные метрики
Метрики инструментов, таких как "товарные рекомендации", "сторис", "слайдеры", рассылки и пр.

POST https://api.rees46.ru/push

Параметры

Параметр	Обязателен?	Описание
shop_id	Да	API-ключ
did*	Да	Идентификатор устройства
sid	Да	Идентификатор сессии . Обязателен при передаче `did`, желателен при других идентификаторах, если есть возможность
email*	Да	Email клиента
phone*	Да	Телефон клиента
external_id*	Да	Внешний идентификатор клиента
loyalty_id*	Да	Идентификатор внешней программы лояльности клиента
telegram_id*	Да	Telegram ID клиента
event	Да	Код события. В данном случае `cart`
segment	Нет	Идентификатор сегмента для встроенных A/B-тестов. Значения: `A` или `B` (латиница)
recommended_by	Нет	Признак атрибуцированного события – инструмент. Значения обычно берутся из ссылки на товар, возвращаемый нашим API
recommended_code	Нет	Признак атрибуцированного события – идентификатор. Значения обычно берутся из ссылки на товар, возвращаемый нашим API
stream	Нет	Стрим
referer	Нет	Страница сайта, на которой произошло событие
items	Да	Массив товаров для события. Может содержать как один товар, так и полное содержимое корзины. Массив не может быть пустым, если `full_cart` не `true` или отсутствует. При `full_cart`: true пустой массив `items` очищает корзину
items[]	Да	Объект товара
items[].id	Да	Идентификатор (артикул) товара, который указан в импорте товара. Пустой ID или ID длиннее 255 символов приведёт к тому, что товар не добавится в корзину без появления ошибки
items[].quantity	Да	Количество единиц этого товара в корзине клиента. По-умолчанию равно `1`. Отрицательные значения и `0` принудительно заменяются на `1`
items[].price	Нет	Цена товара (устарело)
items[].name	Нет	Название товара (устарело)
items[].brand	Нет	Бренд товара (устарело)
items[].stock	Нет	Флаг, что товар все еще в наличии (устарело)
full_cart	Нет	Булевый флаг. Если `true`, то корзина клиента полностью перезаписывается тем, что отправлено в запросе. Если `false` или отсутствует, то переданные в запросе товары добавляются к уже существующему содержимому корзины

Идентификаторы

Параметры, отмеченные [*] - обязателен хотя бы один из них. На стороне сайта или мобильных приложений SDK автоматически передает did.

Совет про full_cart

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

А когда клиент меняет содержимое корзины на ее странице, передавайте все ее содержимое и флаг full_cart=true, чтобы гарантированно синхронизировать корзину. Это важно, чтобы в триггере "Брошенная корзина" уходил актуальный список товаров.

Про атрибуцию

Если клиент добавляет товар в корзину из результатов поиска или из блока рекомендаций, не забудьте передавать параметры recommended_by и recommended_code.

Передача необязательных параметров

Если вы передаёте необязательный параметр, не передавайте его пустым.Это приведёт к ошибке 422

Запрос

TODO

Ревью мобильных SDK

Пример запроса:

shell

# Добавление товара в корзину
curl 'https://api.rees46.ru/push' \
    -X 'POST' \
    -H 'Content-Type: application/json' \
    --data-raw '{"event":"cart", "shop_id":"SHOP_ID", "did":"DEVICE_ID", "sid":"SEANCE_ID", "segment":"A", "items":[{"id":"PRODUCT_ID"}]}'

# Добавление с атрибуцией
curl 'https://api.rees46.ru/push' \
    -X 'POST' \
    -H 'Content-Type: application/json' \
    --data-raw '{"event":"cart", "shop_id":"SHOP_ID", "did":"DEVICE_ID", "sid":"SEANCE_ID", "segment":"A", "recommended_by":"dynamic", "recommended_code":"UNIQUE_RECOMMENDER_CODE", "items":[{"id":"PRODUCT_ID"}]}'

# Перезаписать корзину новым содержимым
curl 'https://api.rees46.ru/push' \
    -X 'POST' \
    -H 'Content-Type: application/json' \
    --data-raw '{"event":"cart", "shop_id":"SHOP_ID", "did":"DEVICE_ID", "sid":"SEANCE_ID", "segment":"A", "full_cart": true, "items":[{"id":"PRODUCT_ID_1"}, {"id":"PRODUCT_ID_2"}]}'

# Очистить корзину
curl 'https://api.rees46.ru/push' \
    -X 'POST' \
    -H 'Content-Type: application/json' \
    --data-raw '{"event":"cart", "shop_id":"SHOP_ID", "did":"DEVICE_ID", "sid":"SEANCE_ID", "segment":"A", "full_cart": true, "items":[]}'

javascript

// Добавление одного товара в корзину
r46('track', 'cart', 'id');

// Добавление с атрибуцией и количеством единиц товара
r46('track', 'cart', {
  id: "...",
  amount: 3,
  recommended_by: 'dynamic',
  recommended_code: 'UNIQUE_RECOMMENDER_CODE'
});

// Полностью перезаписать корзину
r46('track', 'cart', [
  {
    id: FIRST_PRODUCT_ID,
    amount: 3
  },
  {
    id: LAST_PRODUCT_ID,
    amount: 1
  }
]);

// TODO: добавление с размером одежды и другими служебными свойствами

// Очистить корзину
r46('track', 'cart', []);

swift

// Добавление товара в корзину
sdk.track(event: .productAddedToCart(id: "PRODUCT_ID", amount: 3)) { trackResponse in
    // ... обработка коллбэков показана в описании события "Просмотр товара"
}

// TODO: добавление с размером одежды и другими служебными свойствами

// Полностью синхронизировать корзину
sdk.track(event: .synchronizeCart(items: [CartItem(productId: "784"), CartItem(productId: "785", quantity: 3)]  )) { _ in
  print("Cart is synced callback")
}

kotlin

// Простое добавление товара в корзину
sdk.trackEventManager.track(Params.TrackEvent.CART, "37")

// Добавление с атрибуцией, количеством товара и служебными свойствами
val cart = Params().apply {
    put(
        Params.Item("37").apply {
            set(Params.Item.COLUMN.FASHION_SIZE, "M")
            set(Params.Item.COLUMN.AMOUNT, 2)
        }
    )
    put(Params.RecommendedBy(Params.RecommendedBy.TYPE.RECOMMENDATION, "e9ddb9cdc66285fac40c7a897760582a"))

}
sdk.trackEventManager.track(Params.TrackEvent.CART, cart)

// Полностью синхронизировать корзину
val fullCart = Params().apply {
    put(Params.Parameter.FULL_CART, true)
    put(
        Params.Item("37").apply {
            set(Params.Item.COLUMN.AMOUNT, 2)
            set(Params.Item.COLUMN.FASHION_SIZE, "M")
        }
    )
    put(
        Params.Item("40").apply {
            set(Params.Item.COLUMN.AMOUNT, 1)
            set(Params.Item.COLUMN.FASHION_SIZE, "M")
        }
    )
}
sdk.trackEventManager.track(Params.TrackEvent.CART, fullCart)

java

// Простое добавление товара в корзину
REES46.track(Params.TrackEvent.CART, "37");

// Добавление с атрибуцией, количеством товара и служебными свойствами
Params cart = new Params();
cart
    .put(new Params.Item("37")
        .set(Params.Item.COLUMN.FASHION_SIZE, "M")
        .set(Params.Item.COLUMN.AMOUNT, 2)
    )
    .put(new Params.RecommendedBy(Params.RecommendedBy.TYPE.RECOMMENDATION, "e9ddb9cdc66285fac40c7a897760582a"));
REES46.track(Params.TrackEvent.CART, cart);

// Полностью синхронизировать корзину
Params full_cart = new Params();
full_cart
    .put(Params.Parameter.FULL_CART, true)
    .put(new Params.Item("37")
        .set(Params.Item.COLUMN.AMOUNT, 2)
        .set(Params.Item.COLUMN.FASHION_SIZE, "M")
    )
    .put(new Params.Item("40")
        .set(Params.Item.COLUMN.AMOUNT, 1)
        .set(Params.Item.COLUMN.FASHION_SIZE, "M")
    );
REES46.track(Params.TrackEvent.CART, full_cart);

javascript

// Простое добавление товара в корзину
sdk.track("cart", "id");

// Добавление с атрибуцией и количеством товара
sdk.track("cart", {
  id: PRODUCT_ID,
  amount: PRODUCT_QUANTITY,
  recommended_by: 'dynamic',
  recommended_code: 'UNIQUE_RECOMMENDER_CODE'
});

// Полностью синхронизировать корзину
sdk.track("cart", [
  {
    id: FIRST_PRODUCT_ID,
    amount: FIRST_PRODUCT_QUANTITY
  },
  ...
  {
    id: LAST_PRODUCT_ID,
    amount: LAST_PRODUCT_QUANTITY
  }
]);

Ответ

Пример ответа сервера:

json

{
  "status": "success"
}

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

json

{
  "status": "success",
  "popup": {
    "id": 337,
    "channels": [],
    "position": "...",
    "delay": 0,
    "html": "...",
    "web_push_system": false,
    "popup_actions": { ... }
  }
}

В случае ошибки ответ будет в формате:

json

{
  "status": "error",
  "payload": {
    "message": "Device ID is not valid"
  }
}

Добавление в корзину ​

Параметры ​

Запрос ​

Ответ ​

Добавление в корзину

Параметры

Запрос

Ответ