Використання змінних із замовлення у сценарії

Розглянемо, як використовувати змінні з події замовлення у транзакційному сценарії, наприклад, “Замовлення доставлено”. Коректне написання змінних необхідне, щоб сценарій працював без помилок, і всі потрібні параметри вставлялися в контент повідомлення.

Основні етапи підготовки транзакційної розсилки

Підготовка будь-якого сценарію, який надсилає листи з інформацією про дані користувача, адресу доставки, номер замовлення тощо, включає наступні етапи:

• передача даних про замовлення через API (можуть використовуватися API-ресурси Add orders або Generate event);
• підготовка листа з динамічним контентом;
• налаштування сценарію для надсилання тригерного листа.

Ми розглянемо передачу замовлень API-ресурсом Add orders. Докладніше про його використання ви можете дізнатись у цій інструкції.

Передавання даних про замовлення

У запиті передається одне або кілька замовлень, кожен із яких містить обов'язкові та додаткові поля.

Обов'язкові поля для масиву orders:

• ExternalOrderId,
• ExternalCustomerId,
• TotalCost,
• Status,
• Date,
• Email або Phone

Обов'язкові поля для масиву items:

• ExternalItemId,
• Name,
• Quantity,
• Cost,
• Url,
• ImageUrl

Також для замовлень використовується кілька важливих статусів, які відображають воронку продажів:

• Тільки створене замовлення зазвичай має статус INITIALIZED.
• Замовлення, яке знаходиться в процесі доставки, відображається зі статусом IN_PROGRESS.
• Для оплаченого та доставленого використовується статус DELIVERED.
• Для скасованого – CANCELLED.

Такий розподіл потрібен насамперед для того, щоб точно розуміти, на якому етапі знаходиться покупець, і не надсилати повідомлення про доставлення тим, хто скасував замовлення або лише створив його.

Створення подій

Щоразу, коли ви передаєте дані про замовлення через API, у системі створюються відповідні події, які надалі можуть використовуватися як умова, що запускає тригерний сценарій.

Назви транзакційних подій складаються зі слова order і дописаного до нього статусу, наприклад, orderDELIVERED. Ви можете побачити їх у розділі "Тригери" → “Історія подій” у системі eSputnik.

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

Наприклад, події замовлень включають такі стандартні змінні:

• ${eventKey} – ключ унікальності замовлення, що містить значення поля externalOrderId.
• ${orderId} – ID замовлення у базі eSputnik. Параметр потрібний для роботи сценарію.
• ${contactId} – ID контакту в eSputnik.
• ${EmailAddress} – email-адреса покупця (якщо переданий у замовленні).
• ${SMS} – номер телефону покупця (якщо переданий у замовленні).

Правила використання параметрів подій у сценаріях

Параметри з подій необхідно прописувати у сценаріях точно у тому вигляді, в якому вони передаються у події. Це означає, що якщо у події про замовлення передається стандартний параметр EmailAddress, то змінна в полі для введення email у сценарії також має називатися EmailAddress. Інші варіанти написання типу email або EmaiL не працюватимуть у сценарії.

Для зручності користувачів системні події (згенеровані запитом subscribe або регулярним сценарієм) мають ряд стандартних параметрів, тому такі блоки сценаріїв зазвичай працюють за замовчуванням, навіть без прописаних вручну змінних. Однак якщо ви змінили подію для запуску сценарію на відмінну від стандартної, відпрацьовувати за замовчуванням сценарій не буде. Щоб уникнути помилок, команда eSputnik рекомендує вручну прописувати змінні в сценарії.