Cart — View Cart

The LiSA Player generates a message whenever the Shopping Cart CTA is clicked.

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

Properties

Along with all standard Message properties, a View Cart message includes the following additional properties:

Name	Type	Description
cartUrl	String Optional.	The cartUrl property specifies the distinct URL of the Shopping Cart as configured in the Player Settings.
mediaItemId	string Required.	The mediaItemId property uniquely identifies the Media Item from which this message originates.
mediaItemType	MediaItemType Required.	The mediaItemType property specifies the type of Media Item from which this message originates. Refer to MediaItemType for detailed information.
messageType	Literal Required.	lsc:cart:view
progress	MediaProgress Required.	The progress property is an object that holds additional metadata related to the media playback progress of the current media item. Please refer to MediaProgress for detailed information.

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.	view ⚠️ Please use messageType instead.
target	Literal Required.	cart ⚠️ Please use messageType instead.
url	String Required.	The url property specifies the distinct URL of the Shopping Cart as configured in the Player Settings. ⚠️ Please use cartUrl instead.

---

Type Definition

interface ViewCartMessage extends Omit<
  Message,
  'messageType' | 'sender'
> {
  cartUrl: 'comment';
  mediaItemId: string;
  mediaItemType: MediaItemType;
  messageType: 'lsc:cart:view';
  progress: MediaProgress;
}

---

Examples

{
  "cartUrl": "https://my-domain.com/cart",
  "clockDriftInMs": 0,
  "mediaItemId": "9f333331-45cb-4289-8bcd-9023c1871111",
  "mediaItemType": "live",
  "messageType": "lsc:cart:view",
  "progress": {
    "bufferedTimeInMs": 636036,
    "currentTimeInMs": 619609,
    "durationInMs": 4616000,
    "elapsedTimeInMs": 22761,
    "isLive": true,
    "isPlaying": true,
    "skipTimeInMs": 600000,
    "visitorDwellTimeInMs": 23882
  },
  "sender": "LiSA",

  "action": "view",
  "additional":  {
    "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
  },
  "target": "cart",
  "url": "https://my-domain.com/cart"
}