Передавання замовлень за допомогою ресурсу Create event

Для передачі даних про замовлення в системі eSputnik використовується ресурс Add orders, що має низку обмежень:

• фіксовану кількість полів, регламентованих специфікацією,
• неможливість додавати власні поля,
• вміст замовлень не можна використовувати для створення сегментів.

Ці обмеження відсутні у способі керування замовленнями за допомогою методу Create events на основі подій. Цей метод можна використовувати замість Add orders або на додаток до нього.

Використання Create events для передачі замовлень

Використовуючи метод Create events для передачі подій, ви можете:

• Передавати більше даних, ніж у методі Add orders, використовуючи додаткові поля.
• Підключати сегментацію за подіями та їх параметрами. Наприклад, відсортувати клієнтів, які купували певний товар упродовж тижня. Докладніше про такі можливості читайте у статті Як використовувати сегментацію за подіями.
• Розширювати/отримувати RFM-сегментацію на замовлення без додаткового підключення Add orders.

Надіслати замовлення Create events можна лише для контакту, що вже є у вашій базі. Якщо потрібно передати замовлення для нового контакту, спочатку імпортуйте цей контакт до системи за допомогою одного з ресурсів:

• Add/update contacts,
• Add orders.

Щоб надіслати замовлення, потрібно вказати тип події. Виберіть тип із таблиці нижче в залежності від статусу замовлення.

orderCreated

Для створення замовлення необхідно вказати назву параметрів саме ту, яку зазначено в документації, і заповнити обов'язкові параметри. Якщо пропустити будь-який з обов'язкових параметрів, подія проігнорується і замовлення не буде створено. Обов'язкові параметри мають спеціальну позначку "required":

Приклад:

{
	"eventTypeKey": "orderCreated",
	"keyValue": "380501234567",
	"params": [{
		"name": "phone",
		"value": "380501234567"
	}, {
		"name": "externalOrderId",
		"value": "12345679"
	}, {
		"name": "externalCustomerId",
		"value": "AV13760"
	}, {
		"name": "totalCost",
		"value": "258.0"
	}, {
		"name": "status",
		"value": "INITIALIZED"
	}, {
		"name": "date",
		"value": "2020-05-14T10:11:00"
	}, {
		"name": "currency",
		"value": "UAH"
	}, {
		"name": "items",
		"value": "[{\"externalItemId\":\"200600\",\"name\":\"Super Device\",\"category\":\"devices\",\"quantity\":1,\"cost\":990,\"url\":\"http:\/\/example.com\/item\/200600\",\"imageUrl\":\"http:\/\/example.com\/item\/200600\/image.png\",\"description\":\"High quality\"}]"
	}]
}

Зверніть увагу
items використовуються лише для передачі масиву товарів в розділ замовлень та його не можна використовувати для показу в листах. Для передачі інформації про товари в листи, необхідно використовувати products, як в прикладі нижче

{
    "eventTypeKey": "orderCreated",
    "keyValue": "380501234567",
    "params": [{
        "name": "phone",
        "value": "380501234567"
    }, {
        "name": "externalOrderId",
        "value": "12345679"
    }, {
        "name": "externalCustomerId",
        "value": "AV13760"
    }, {
        "name": "totalCost",
        "value": "258.0"
    }, {
        "name": "status",
        "value": "INITIALIZED"
    }, {
        "name": "date",
        "value": "2020-05-14T10:11:00"
	}, {
		"name": "currency",
		"value": "UAH"
    }, {
        "name": "items",
        "value": "[{\"externalItemId\":\"200600\",\"name\":\"Super Device\",\"category\":\"devices\",\"quantity\":1,\"cost\":990,\"url\":\"http:\/\/example.com\/item\/200600\",\"imageUrl\":\"http:\/\/example.com\/item\/200600\/image.png\",\"description\":\"High quality\"}]"
    },
     {
        "name": "products",
        "value": "{\"array\":[{\"externalItemId\":\"200600\",\"name\":\"Super Device\",\"category\":\"devices\",\"quantity\":1,\"cost\":990,\"url\":\"http:\/\/example.com\/item\/200600\",\"imageUrl\":\"http:\/\/example.com\/item\/200600\/image.png\",\"description\":\"High quality\"}]}"
    }]
}

orderUpdated

• Оновлює замовлення зі вказаним значенням externalOrderId.
• Якщо переданого замовлення немає в системі, воно все одно створюється.
• Параметри повинні мати назву, яка вказана в документації. Якщо замовлення потрібно створити, то застосовуються вимоги до orderCreated.

orderDelivered

• Змінює статус замовлення externalOrderId на значення DELIVERED.
• Якщо замовлення не існує, воно ігнорується.

orderCancelled

• Змінює статус замовлення externalOrderId на значення CANCELLED.
• Якщо замовлення не існує, воно ігнорується.

Використання Create events для передачі даних у рекомендаційну систему

Якщо у вас налаштована як передача подій з програми або сайту в eSputnik, так і інтеграція з рекомендаційними системами (кинуті кошики, перегляди тощо), то використовуючи метод Create events можна без додаткових налаштувань передавати інформацію одразу в обидва сервіси.

Таким чином маємо:

• настроєну сегментацію подій,
• відсутність потреби передавати дані окремо до різних сервісів.

Нижче наведено типи подій для передачі певної інформації.

Приклад події для передачі інформації у вигляді посилання про відвідувану користувачем сторінку може бути вказаний (deeplinks & Universal links) при використанні мобільного додатку:

{
  "eventTypeKey": "pageViewed",
  "keyValue": "example@email.com",
  "params": [
    {
      "name": "phone",
      "value": "380501234567"
    },
    {
      "name": "email",
      "value": "example@email.com"
    },
    {
      "name": "page",
      "value": "{\"location\":\"https://example.com\"}"
    }
  ]
}

де:

Для якісного ранжування товарів/категорій або для відправлення тригерів за покинутими переглядами необхідно надіслати запит, в якому буде зазначено, яку картку товару наразі переглядає користувач, а також ціну та наявність цього товару. Для цього потрібно надіслати подію productViewed:

{
  "eventTypeKey": "productViewed",
  "keyValue": "example@email.com",
  "params": [
    {
      "name": "phone",
      "value": "380501234567"
    },
    {
      "name": "email",
      "value": "example@email.com"
    },
    {
      "name": "product",
      "value": "{\"productId\":\"WS01-L-Green\",\"price\":45.5,\"isInStock\":1,\"someProductProperty\":[\"зеленый\"]}]}"
    }
  ]
}

де:

Для тригерів:

• "Перегляд сайту з відвідуванням категорії, без відвідування картки товарів."
• “Перегляд сайту без відвідування категорії/товару.”

Для цього потрібно надіслати подію productCategoryViewed, в якій буде вказано в якій категорії знаходиться користувач:

{
  "eventTypeKey": "productCategoryViewed",
  "keyValue": "example@email.com",
  "params": [
    {
      "name": "phone",
      "value": "380501234567"
    },
    {
      "name": "email",
      "value": "example@email.com"
    },
    {
      "name": "category",
      "value": "{\"productCategoryId\":\"Термосы\"}"
    }
  ]
}

де:

Подія відправляється в момент зміни вмісту кошика (з новим recycleStateId), наприклад, на картці товару або на сторінці категорій у разі натискання на кнопку "Купити". Якщо кошик порожній, необхідно передати порожній масив products:"[]".

Приклад запиту для події cartUpdated:

{
  "eventTypeKey": "cartUpdated",
  "keyValue": "example@email.com",
  "params": [
    {
      "name": "phone",
      "value": "380501234567"
    },
    {
      "name": "email",
      "value": "example@email.com"
    },
    {
      "name": "products",
      "value": "[{\"productId\":\"WS01-L-Green\",\"quantity\":1,\"price\":45.5}]"
    },
    {
      "name": "recycleStateId",
      "value": "d59c6e6d-4123-4b0e-8c32-15f0656a8c60"
    }
  ]
}

де: