Sending events

ADD_CONSUMERS event

Use the ADD_CONSUMERS event to capture the guest's action of adding consumers to the product.

Sitecore Personalize does not run identity on consumers. If the consumer is also the contact on the order and passes your organization's identity rules, the consumer will have a customer guest_type. In all other scenarios, Sitecore Personalize will create a traveller guest_type for the consumer.

To send an ADD_CONSUMERS event, use the following required attributes:

Attribute	Type	Description	Example
`channel`	string (uppercase)	The touchpoint where the user interacts with your brand.	`"MOBILE_APP"` `"MOBILE_WEB"` `"WEB"`
`type`	string (uppercase)	The type of the event that takes place when the user interacts with your brand.	`"CHECKOUT"`
`language`	string (uppercase ISO 639-1)	The language the user is using your app in.	`"DE"` `"EN"` `"FR"`
`currency`	string (uppercase ISO 4217)	The alphabetic currency code of the currency the user is using in your app.	`"EUR"` `"GBP"` `"USD"`
`page`	string	The name of the webpage where the interaction with your brand takes place. This is a custom value of your choice.	`"home"` `"contact-us.html"`
`pos`	string	The name of the point of sale where the interaction with your brand takes place.	`"myretailsite/ireland"` `"spinair.com/france"`
`browser_id`	string	The browser ID.	`"a38b230c-11eb-4cf9-8d5d-274e9f344925"`
`consumer`	array of objects	The consumer data.	N/A

The consumer array of objects:

Attribute	Type	Description	Example	Required/optional
`title`	string (title case)	The title of the consumer.	`"Br", "Brigadier", "Capt", "Colonel", "Dame", "Dr", "Elder", "Fr", "General", "Hon", "Judge", "Lord", "Master", "Miss", "Mr", "Mrs", "Ms", "Mstr", "Prof", "Rabbi", "Rev", "Shaikha", "Sheikh", "Sir", "Sister", "Sr"`	Required
`firstname`	string (title case recommended)	The first name of the consumer.	`"Jane"`	Required
`lastname`	string (title case recommended)	The last name of the consumer.	`"Doe"`	Required
`gender`	string	The gender of the consumer.	`"female"`	Optional
`dob`	string (ISO 8601)	The date of birth of the consumer.	`"1983-04-15T00:00"`	Optional
`mobile`	string	The mobile number of the consumer.	`"+3531234567"`	Optional
`nationality`	string (title case)	The nationality of the consumer.	`"Irish"` `"Spanish"` `"Chinese"`	Optional
`reference_id`	string	The reference ID of the consumer.	`"1"` `"2"`	Optional
`item_id`	array of strings	A list of item IDs of core and dependent products that belong to the consumer.	`["FLIGHT_1", "FLIGHT_2", "BAG_1", "SEAT_1" "HOTEL_1"]`	Optional

Example 47. ADD_CONSUMERS event object

{
    "channel": "MOBILE_APP",
    "type": "ADD_CONSUMERS",
    "language": "EN",
    "currency": "EUR",
    "page": "payment page",
    "pos": "spinair.com/france",
    "browser_id": "a38b230c-11eb-4cf9-8d5d-274e9f344925",
    "consumer": [{
        "title": "Mr",
        "firstname": "Jack",
        "lastname": "Smith",
        "dob": "1975-04-23T00:00",
        "gender": "male",
        "mobile": "+353123456",
        "nationality": "Irish",
        "reference_id": "1",
        "item_id": [
            "FLIGHT_1",
            "FLIGHT_2",
            "BAG_1",
            "SEAT_1"
        ]
    }, {
        "title": "Ms",
        "firstname": "Lily",
        "lastname": "Smith",
        "dob": "1980-01-15T00:00",
        "gender": "female",
        "mobile": "+353123458",
        "nationality": "Irish",
        "reference_id": "2",
        "item_id": [
            "FLIGHT_1",
            "FLIGHT_2",
            "BAG_2",
            "SEAT_2"
        ]
    }]
}

If you have suggestions for improving this article, let us know!