Products — Add to Cart

The LiSA Player dispatches a message when a user clicks the "Add to Cart"-CTA on a product card or sticker.

This message is sent by the LiSA Player to the host app / environment.

Properties

Along with all standard Product message properties, an Add to Cart message includes the following additional properties:

Name	Type	Description
intent	Literal Required.	The intent property specifies the action to be performed on the product. It can have one of the following values: add – Indicates that the product should be added to the cart. remove – Indicates that the product should be removed from the cart.
messageType	Literal Required.	lsc:product:add-to-cart

Legacy Properties

If your integration uses LiSA Player Version 1, none of the properties described above will be available.

For LiSA Player Version 2, legacy properties can be ignored.

Name	Type	Description
action	String Required.	cta ⚠️ Please use messageType instead.
target	Literal Required.	carousel.item ⚠️ Please use messageType instead.

---

Type Definition

interface ProductAddToCartMessage extends Omit<
  ProductMessage,
  'messageType'
> {
  intent: 'add' | 'remove';
  messageType: 'lsc:product:add-to-cart';
}

---

Examples

{
  "clockDriftInMs": 0,
  "intent": "add",
  "mediaItemId": "9f333331-45cb-4289-8bcd-9023c1871111",
  "mediaItemType": "live",
  "messageType": "lsc:product:add-to-cart",
  "product": {
    "hasStock": true,
    "reference": "f20312c0-40a2-4b20-986c-5b81ceca6eae",
    "storeOverrides": [],
    "mainImage": {
      "width": 1330,
      "sizeInBytes": 349018,
      "hash": "UMPGjZ%N?G?a?Gj?M|j]~ot6IVWCE5ai-oax",
      "url": "https://image.lisa-cdn.net/demo/product/ab016523/324c09bd-8206-46ae-8123-dade826bce81.jpg",
      "height": 1920
    },
    "price": {
      "currencyCode": "EUR",
      "currencySymbol": "€",
      "price": 89.95
    },
    "name": "RAVE UNISEX - Ski goggles - matt black/white",
    "id": "ab016523-250c-49a3-b2b4-86487d9df813",
    "variants": [],
    "title": {
      "*": "RAVE UNISEX - Ski goggles - matt black/white"
    },
    "url": "https://my-storefront.com/rave-unisex-ski-goggles-matt-black-white.html"
  },
  "productBrand": "BLIZ",
  "productCurrency": "EUR",
  "productId": "ab016523-250c-49a3-b2b4-86487d9df813",
  "productPrice": 89.95,
  "productReference": "f20312c0-40a2-4b20-986c-5b81ceca6eae",
  "productTitle": "RAVE UNISEX - Ski goggles - matt black/white",
  "progress": {
    "bufferedTimeInMs": 648036,
    "currentTimeInMs": 628008,
    "durationInMs": 4616000,
    "elapsedTimeInMs": 28784,
    "skipTimeInMs": 600000,
    "isLive": true,
    "visitorDwellTimeInMs": 29135,
    "isPlaying": true
  },
  "sender": "LiSA",

  "action": "cta",
  "additional": {,
    "action": "https://my-storefront.com/rave-unisex-ski-goggles-matt-black-white.html",
    "showDate": "2025-01-15T18:00:00.000Z",
    "showId": "9f333331-45cb-4289-8bcd-9023c1871111",
    "showName": "Shred the Slopes: The Ultimate Ski Gear Guide 🎿❄️",
    "showState": "live",
    "showTitle": "Shred the Slopes: The Ultimate Ski Gear Guide 🎿❄️",
    "playing": true,
    "time": 620,
    "id": "f20312c0-40a2-4b20-986c-5b81ceca6eae"
  },
  "first": true,
  "item": {
    "data": {
      "origin": {
        "id": "f20312c0-40a2-4b20-986c-5b81ceca6eae"
      }
    },
    "id": "ab016523-250c-49a3-b2b4-86487d9df813",
    "type": "product"
  },
  "target": "carousel.item"
}