Передача замовлень API-ресурсом Generate event

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

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

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

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

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

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

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

• Add/update a contact,
• Add orders.

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

orderCreated

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

• ${eventKey} — ключ унікальності замовлення. Передається в поле externalOrderId. Використовується як ідентифікатор замовлення;
• ${orderId} — ID замовлення в системі; параметр потрібний для роботи сценарію.

Як ідентифікатор контакту повинен використовуватися один із таких параметрів:

• ${externalCustomerId} — зовнішній ID контакту;
• ${email} — email-адреса контакту;
• ${phone} — номер телефону контакту.

Щоб замінити значення параметрів повідомлення, передавайте поля з параметрами події у вигляді масиву.

• Обов'язкові поля у масиві ordes: externalOrderId, totalCost, status, date, externalCustomerId / email / phone.
• Обов'язкові поля у масиві items: externalItemId, name, quantity, cost, url, imageUrl.

Приклад:

{
	"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"
		}]
	}]
}

orderUpdated

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

orderDelivered

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

orderCancelled

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