Products — Open Product List

The LiSA Player dispatches a message when a user opens the product list.

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

Properties

Along with all standard Message properties, a Open Product List message includes the following additional properties:

Name	Type	Description
auxiliaryData	AuxiliaryData Required.	The auxiliaryData property is an object that holds additional metadata related to the open product list event. Please refer to AuxiliaryData for detailed information.
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:products:open

---

Type Definition

interface ProductListOpenMessage extends Omit<
  Message,
  'messageType' | 'sender'
> {
  auxiliaryData: ProductListAuxiliaryData;
  mediaItemId: string;
  mediaItemType: MediaItemType;
  messageType: 'lsc:products:open';
  sender: 'LiSA';
}

ProductListAuxiliaryData

Name	Type	Description
products	Object Required.	The products field specifies a map of product identifiers, where each key represents the external or merchant-specific identifier for the product and its corresponding value represents the LiSA internal product identifier.

interface ProductListAuxiliaryData {
  products: Record<string, string>;
}

---

Examples

{
  "auxiliaryData": {
    "products": {
      "9caf4704-ec2f-438b-8b18-128a9ba22fda": "6052b475-b887-4d84-8f83-7797c7790dbd"
    }   
  },
  "clockDriftInMs": 0,
  "mediaItemId": "9f333331-45cb-4289-8bcd-9023c1871111",
  "mediaItemType": "live",
  "messageType": "lsc:product:open",
  "progress": {
    "bufferedTimeInMs": 648036,
    "currentTimeInMs": 628008,
    "durationInMs": 4616000,
    "elapsedTimeInMs": 28784,
    "skipTimeInMs": 600000,
    "isLive": true,
    "visitorDwellTimeInMs": 29135,
    "isPlaying": true
  },
  "sender": "LiSA"
}