Skip to main content
Sitecore Documentation
  • Learn
  • Downloads
  • Changelog
  • Roadmap
PersonalizeCloud Portal
Sitecore Personalize developer documentation
  • Developing with Sitecore Personalize
        • 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. Sitecore Personalize developer documentation
  2. Stream API

ADD event

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

In case of cart abandonment, ADD events contribute to the calculation of abandoned revenue. When multiple ADD events in the same session use the same product.item_id, Sitecore Personalize treats later ADD events as an update to that line. The latest quantity and price values are used to calculate the line total. The sum of all line totals at session close equals the session's abandoned revenue.

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

AttributeTypeDescriptionExample
channelstring (uppercase)The touchpoint where the user interacts with your brand.
  • "MOBILE_APP"
  • "MOBILE_WEB"
  • "WEB"
typestring (uppercase)The type of the event that takes place when the user interacts with your brand."ADD"
languagestring (uppercase ISO 639-1)The language the user is using your app in.
  • "DE"
  • "EN"
  • "FR"
currencystring (uppercase ISO 4217)The alphabetic currency code of the currency the user is using in your app.
  • "EUR"
  • "GBP"
  • "USD"
pagestringThe name of the webpage where the interaction with your brand takes place.

This is a custom value of your choice.
  • "home"
  • "contact-us.html"
posstringThe name of the point of sale where the interaction with your brand takes place.
  • "myretailsite/ireland"
  • "spinair.com/france"
browser_idstringThe browser ID."a38b230c-11eb-4cf9-8d5d-274e9f344925​"
productobjectThe product entity data."mys3cr3tstr1ingforauth1!x"

The product object:

AttributeTypeDescriptionExampleRequired/optional
typestring (uppercase)The type of product added to cart."BET"Required
item_idstringThe item ID of the product added to cart. Used in Extract, Transform, Load (ETL) data integration to create the order."EXACT_90"Required
namestring (title case recommended)The name of the product added to the cart."Exact score after 90 minutes"Required
orderedAtstring (ISO 8601)The date and time the product was ordered."2026-08-23T16:17
.000Z"
Required
quantitynumberThe number of unit added. Total price of the product is calculated by unit price multiplied by quantity.1Required
pricenumber (currency)The unit price of the product. Total price of the product is calculated by unit price multiplied by quantity.100.00Required
productIdstringThe product ID of the product added. Used in analytics for reporting."CORRECT_SCORE"Required
currencystring (uppercase ISO 4217)The currency of the product added to the cart."EUR"Required
originalPricenumber (currency)The unit price of the order item before conversion to the organization's currency.100.00Optional
originalCurrencyCodestring (uppercase ISO 4217)The original currency code for the order item."EUR"Optional
referenceIdstringAn ID generated by your organization to reference the order item."BET_001-1"Required

Example 44. ADD event object

{
   "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": "2026-08-23T16:`17:16`.000Z",
      "quantity": 1,
      "price": 100.00,
      "productId": "CORRECT_SCORE",
      "currency": "EUR",
      "originalPrice": 100.00,
      "originalCurrencyCode": "EUR",
      "referenceId": "BET_001-1"
   }
}
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