Send an ADD event for flight to Sitecore CDP

Abstract

Provides the required attributes and a JSON example of how to send an ADD event for flight to Sitecore CDP (2.1).

The ADD event captures the product details when a user adds the product(s) to their online cart. 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.

To send an ADD event for a FLIGHT product.type, use the following required attributes:

Attribute

Description

Type

Example(s)

Required/optional

channel

The channel captured on each page the guest visited.

string

WEB", "MOBILE_WEB", "MOBILE_APP"

Required

type

The type of event.

string (uppercase)

"ADD"

Required

language

The language captured on each page the guest visited.

string (2 letter ISO 639 language code)

"EN", "FR", "DE"

Required

currency

The type of currency.

string (3 letter ISO 4217)

"EUR", "USD", "GBP"

Required

page

The name of the webpage the guest visited.

string

"home page", "search page" "/home", "/confirm"

Required

pos

The point of sale (storefront) captured on each page the guest visited.

string (predefined by client)

"flightspin.com", "spinair.com"

Required

browser_id

The ID of a browser generated by Sitecore CDP.

string (UUID)

"56860bff-94ba-4d84-aa37-2b5a83d5411b"

Required

product

The JSON object that contains the product entity data.

JSON object

N/A

Required

product.type

The type of product added to cart.

string (uppercase)

"FLIGHT"

Required

product.item_id

The item ID of the product added to the cart. Used in ETL to create the order.

string

"FLIGHT_1"

Required

product.name

The name of the product added to the cart.

string (suggest title case)

"DUB-LHR Economy Flight"

Required

product.currency

The currency of the product added to the cart.

string (3 letter ISO 4217)

"EUR", "USD", "NZD"

Required

product.price

The unit price of the product. Total price of the product is calculated by unit price multiplied by quantity.

number

20, 1000.5

Required

product.quantity

The number of unit added. Total price of the product is calculated by unit price multiplied by quantity.

integer

2

Required

product.product_id

The product ID of the product added. Used in Analytics for reporting.

string (suggest title case)

"DUB-LHR|Economy|EconomyPlus"

Required

product.origin

The IATA code (airport only) of the flight origin.

string (IATA airport code)

"DUB", "LHR", "BCN"

Required

product.destination

The IATA code (airport only) of the flight destination.

string (IATA airport code)

"DUB", "LHR", "BCN"

Required

product.flight_type

The type of flight.

string (uppercase)

"OW" for One way, "RT" for Return

Required

product.pax_type

The passenger type of flight ticket.

string (uppercase)

"ADT" for adult, "CHD" for child, "INF" for infant

Required

product.flight_segment

The JSON object that contains the flight segment entity data.

JSON object

N/A

Required

product.flight_segment.origin

The IATA code (airport only) of the flight segment origin.

string (IATA airport code)

"DUB", "LHR", "BCN"

Required

product.flight_segment.destination

The IATA code (airport only) of the flight segment destination.

string (IATA airport code)

"DUB", "LHR", "BCN"

Required

product.flight_segment.departure_date_time

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

"2016-08-21T16:17"

Required

product.flight_segment.arrival_date_time

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

"2016-08-23T07:00"

Required

product.flight_segment.flight_number

The number of the carrier.

string

"1230"

Required

product.flight_segment.carrier

The marketing carrier code of the flight segment.

2 character IATA carrier code (uppercase)

"EI", "FR", "BA"

Required

product.flight_segment.fare_class

The fare class of the flight segment.

string (title case)

"Economy", "Premium Economy", "Business", "First Class"

Required

product.flight_segment.equipment_type

The equipment type relevant to the flight segment.

string

"A380", "B774", "A310"

Optional

product.flight_segment.fare_family

The fare family of the flight segment.

string (suggest title case)

"Economy Plus", "Flexi Economy"

Optional

The following JSON example demonstrates how to send an ADD event for a FLIGHT product.type:

{
    "channel": "WEB",
    "type": "ADD",
    "language": "EN",
    "currency": "EUR",
    "page": "itinerary page",
    "pos": "spinair.com",
    "browser_id": "56860bff-94ba-4d84-aa37-2b5a83d5411b",
    "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"
        }]
    }
}