ADD event for flights
The ADD event sends product data to a large number of data points for both decisioning and for populating content into the abandoned cart email message.
When sending multiple ADD events, you must send them in the correct order. For example, for a DUB to LHR return flight, first send the ADD event for DUB-LHR, then in the callback send the ADD event for LHR-DUB.
|
Attribute |
Description |
Type |
Example(s) |
Required/optional |
|---|---|---|---|---|
|
|
The channel captured on each page the guest visited. |
string |
|
Required |
|
|
The type of event. |
string (uppercase) |
|
Required |
|
|
The language captured on each page the guest visited. |
string (2 letter ISO 639 language code) |
|
Required |
|
|
The type of currency. |
string (3 letter ISO 4217) |
|
Required |
|
|
The name of the webpage the guest visited. |
string |
|
Required |
|
|
The point of sale (storefront) captured on each page the guest visited. |
string (predefined by client) |
|
Required |
|
|
The ID of a browser generated by Sitecore Personalize. |
string (UUID) |
|
Required |
|
|
The JSON object that contains the product entity data. |
JSON object |
N/A |
Required |
|
|
The type of product added to cart. |
string (uppercase) |
|
Required |
|
|
The item ID of the product added to the cart. Used in ETL to create the order. |
string |
|
Required |
|
|
The name of the product added to the cart. |
string (suggest title case) |
|
Required |
|
|
The currency of the product added to the cart. |
string (3 letter ISO 4217) |
|
Required |
|
|
The unit price of the product. Total price of the product is calculated by unit price multiplied by quantity. |
number |
|
Required |
|
|
The number of unit added. Total price of the product is calculated by unit price multiplied by quantity. |
integer |
|
Required |
|
|
The product ID of the product added. Used in Analytics for reporting. |
string (suggest title case) |
|
Required |
|
|
The IATA code (airport only) of the flight origin. |
string (IATA airport code) |
|
Required |
|
|
The IATA code (airport only) of the flight destination. |
string (IATA airport code) |
|
Required |
|
|
The type of flight. |
string (uppercase) |
|
Required |
|
|
The passenger type of flight ticket. |
string (uppercase) |
|
Required |
|
|
The JSON object that contains the flight segment entity data. |
JSON object |
N/A |
Required |
|
|
The IATA code (airport only) of the flight segment origin. |
string (IATA airport code) |
|
Required |
|
|
The IATA code (airport only) of the flight segment destination. |
string (IATA airport code) |
|
Required |
|
|
The local departure date and time of the flight segment. |
string "YYYY-MM-DD’T’hh:mm" ISO 8601 Date/Time local time without timezone |
|
Required |
|
|
The local arrival date and time of the flight segment. |
string "YYYY-MM-DD’T’hh:mm" ISO 8601 Date/Time local time without timezone |
|
Required |
|
|
The number of the carrier. |
string |
|
Required |
|
|
The marketing carrier code of the flight segment. |
2 character IATA carrier code (uppercase) |
|
Required |
|
|
The fare class of the flight segment. |
string (title case) |
|
Required |
|
|
The equipment type relevant to the flight segment. |
string |
|
Optional |
|
|
The fare family of the flight segment. |
string (suggest title case) |
|
Optional |
{
"channel": "WEB",
"type": "ADD",
"language": "EN",
"currency": "EUR",
"page": "itinerary page",
"pos": "spinair.com",
"browser_id": "a38b230c-11eb-4cf9-8d5d-274e9f344925",
"product": {
"type": "FLIGHT",
"item_id": "FLIGHT_1",
"name": "DUB-LHR Economy Flight",
"currency": "EUR",
"price": 200,
"product_id": "DUB-LHR|Economy|EconomyPlus",
"origin": "DUB",
"destination": "LHR",
"flight_type": "OW",
"pax_type": "ADT",
"quantity": 1,
"flight_segment": [{
"origin": "DUB",
"destination": "LHR",
"departure_date_time": "2015-01-14T06:30",
"arrival_date_time": "2015-01-14T07:50",
"flight_number": "1000",
"carrier": "SA",
"fare_class": "Economy",
"fare_family": "Economy Plus"
}]
}
}