Skip to main content
Users
CloudPortalLogin
  • Powered byPowered by
Developing with Sitecore CDP
Data privacy
Before you start sending data
Integrating with Sitecore CDP
Stream API
Batch API
REST APIs
Data lake export service
  • Sitecore CDP for developers
  • Stream API
  • Direct HTTP requests reference
  • Sending events
  • ADD event

ADD event

The ADD event captures the product details when a user adds the product(s) to their online cart.

To send an ADD 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.

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

"BET"

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.

"EXACT_90"

Required

name

string (title case recommended)

The name of the product added to the cart.

"Exact score after 90 minutes"

Required

orderedAt

string (ISO 8601)

The date and time the product was ordered.

"2025-08-23T16:17:16.000Z"

Required

quantity

number

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

1

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

productId

string

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

"CORRECT_SCORE"

Required

currency

string (uppercase ISO 4217)

The currency of the product added to the cart.

"EUR"

Required

originalPrice

number (currency)

The unit price of the order item before conversion to the organization's currency.

100.00

Optional

originalCurrencyCode

string (uppercase ISO 4217)

The original currency code for the order item.

"EUR"

Optional

referenceId

string

An ID generated by your organization to reference the order item.

"BET_001-1"

Required

Example 41. ADD event object
RequestResponse
{
   "channel": "MOBILE_APP",
   "type": "ADD",
   "language": "EN",
   "currency": "EUR",
   "page": "races",
   "pos": "myretailsite/ireland",
   "browser_id": "a38b230c-11eb-4cf9-8d5d-274e9f344925​",
   "product": {
      "type": "BET",
      "item_id": "EXACT_90",
      "name": "Exact score after 90 minutes",
      "orderedAt": "2025-08-23T16:17:16.000Z",
      "quantity": 1,
      "price": 100.00,
      "productId": "CORRECT_SCORE",
      "currency": "EUR",
      "originalPrice": 100.00,
      "originalCurrencyCode": "EUR",
      "referenceId": "BET_001-1"
   }
}


Do you have some feedback for us?

If you have suggestions for improving this article,

Privacy policySitecore Trust CenterCopyright © 1999-2025 Sitecore