Использование переменных из заказа в сценарии

Рассмотрим, как использовать переменные из события заказа в транзакционном сценарии, например, “Заказ доставлен”. Корректное написание переменных необходимо, чтобы сценарий работал без ошибок, и все нужные параметры подставлялись в контент сообщения.

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

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

• передача данных о заказе по 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 рекомендует вручную прописывать переменные в сценарии.