Skip to main content
Sitecore Documentation
  • Learn
  • Downloads
  • Changelog
  • Roadmap
CDPCloud Portal
Sitecore CDP Developer Documentation
  • Developing with Sitecore CDP
        • Authentication
        • Base URL
        • Retrieve the browser ID
            • IDENTITY event
            • SEARCH event
            • ADD event
            • ADD event for flights
            • ADD event for ancillary product
            • ADD_CONSUMERS event
            • ADD_CONTACTS event
            • CONFIRM event
            • CONFIRM event for flights
            • CHECKOUT event
            • ORDER_CHECKOUT event
            • CLEAR_CART event
            • PAYMENT event
            • Custom event
        • Sending orders
        • Cart abandonment
        • Send additional event data
        • Troubleshooting
  1. Sending events
  1. Stream API
  3. Direct HTTP requests reference
  5. Sending events
  7. ADD event for ancillary product

ADD event for ancillary product

You can use the ADD event to capture ancillary products that the user adds to their cart, such as insurance. This event is optional, but employing it can positively affect the amount of available data. Using this event is the only way to capture ancillary products that the user adds to their cart. This event also helps ensure accuracy of the cart contents and order values when a user returns to their abandoned cart.

To send an ADD event for an ancillary product, 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.

"ADD"

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​"

product

object

The product entity data.

"mys3cr3tstr1ingforauth1!x"

The product object:

Attribute

Type

Description

Example

Required/optional

type

string (uppercase)

The type of product added to cart.

  • "HOTEL"

  • "CAR"

  • "BAG"

  • "INSURANCE"

  • "LOUNGE_ACCESS"

  • "HOTEL_WIFI"

  • "INFLIGHT_ENTERTAINMENT"

  • "CARBON_OFFSET"

  • "INFLIGHT_VOUCHER"

  • "CHARITY_DONATION"

  • "TRANSFER"

Deprecated:

  • "BAGGAGE"

  • "FEES"

  • "SEAT_UPGRADES"

  • "INFLIGHT_VOUCHERS"

Required

item_id

string

The item ID of the product added to cart. Used in Extract, Transform, Load (ETL) data integration to create the order.

"BAG_1"

Required

name

string (title case recommended)

The name of the product added to the cart.

"DUB-LHR Economy Flight"

"20kg Bag"

Required

currency

string (uppercase ISO 4217)

The currency of the product added to the cart.

"EUR"

Required

price

number (currency)

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

100.00

Required

product_id

string

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

"Bag20"

Required

quantity

number

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

1

Required

Example 42. ADD event object for ancillary product
{
    "channel": "MOBILE_APP",
    "type": "ADD",
    "language": "EN",
    "currency": "EUR",
    "page": "passengers page",
    "pos": "spinair.com/france",
    "browser_id": "a38b230c-11eb-4cf9-8d5d-274e9f344925​",
    "product": {
        "type": "BAG",
        "item_id": "BAG_1",
        "name": "20kg Bag",
        "currency": "EUR",
        "price": 10,
        "product_id": "Bag20",
        "quantity": 1
    }
}


To send an ADD event for an ancillary product, 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.

"ADD"

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​"

product

object

The product entity data.

"mys3cr3tstr1ingforauth1!x"

The product object:

Attribute

Type

Description

Example

Required/optional

type

string (uppercase)

The type of product added to cart.

  • "HOTEL"

  • "CAR"

  • "BAG"

  • "INSURANCE"

  • "LOUNGE_ACCESS"

  • "HOTEL_WIFI"

  • "INFLIGHT_ENTERTAINMENT"

  • "CARBON_OFFSET"

  • "INFLIGHT_VOUCHER"

  • "CHARITY_DONATION"

  • "TRANSFER"

Deprecated:

  • "BAGGAGE"

  • "FEES"

  • "SEAT_UPGRADES"

  • "INFLIGHT_VOUCHERS"

Required

item_id

string

The item ID of the product added to cart. Used in Extract, Transform, Load (ETL) data integration to create the order.

"BAG_1"

Required

name

string (title case recommended)

The name of the product added to the cart.

"DUB-LHR Economy Flight"

"20kg Bag"

Required

currency

string (uppercase ISO 4217)

The currency of the product added to the cart.

"EUR"

Required

price

number (currency)

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

100.00

Required

product_id

string

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

"Bag20"

Required

quantity

number

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

1

Required

linked_consumer_reference_ids

array of strings

A list of reference IDs to associate this product with the consumer(s).

["CONSUMER_1','CONSUMER_2"]

Optional

Example 43. ADD event object for ancillary product
{
    "channel": "MOBILE_APP",
    "type": "ADD",
    "language": "EN",
    "currency": "EUR",
    "page": "passengers page",
    "pos": "spinair.com/france",
    "browser_id": "a38b230c-11eb-4cf9-8d5d-274e9f344925​",
    "product": {
        "type": "BAG",
        "item_id": "BAG_1",
        "name": "20kg Bag",
        "currency": "EUR",
        "price": 10,
        "product_id": "Bag20",
        "quantity": 1,
        "linked_consumer_reference_ids": ["CONSUMER_1", "CONSUMER_2"]
    }
}


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

Documentation Assistant

This assistant uses AI to generate responses based on Sitecore documentation. While it has access to official sources, answers may be incomplete or inaccurate and should not be considered official advice or support.
Powered by
k
kapa.ai
Protected by reCAPTCHA

© Copyright 2026, Sitecore A/S or a Sitecore affiliated company.
All rights reserved.

Privacy policySitecore Trust CenterTerms of use