Products — Emoji State Update

The LiSA Player supports messages for updating a product's emoji state, allowing merchants to reflect actions such as adding products to a customer's wishlist.

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

Properties

Along with all standard Message properties, an Emoji State Update message includes the following additional properties:

Name	Type	Description
messageType	Literal Required.	lsc:product:emoji-state-update
productReferences	Array<String> Required.	The productReferences property represents an array of external or merchant-specific identifiers for the products or product variants that emoji states should be active. These IDs are provided by the merchant or host system and may differ from the LiSA internal productId. It is used to reference the products in external systems, such as e-commerce platforms or inventory databases.

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.	like.grant or like.revoke ⚠️ Please use messageType instead.
item	Item Required.	The item property specifies the product item whose emoji state needs to be updated. Please refer to Item for detail information. For Player V1, please note that product emoji updates must be sent individually for each product.
target	Literal Required.	carousel.item ⚠️ Please use messageType instead.

---

Type Definition

interface ProductEmojiStateUpdateMessage extends Omit<
  Message,
  'messageType' | 'recipient'
> {
  messageType: 'lsc:product:emoji-state-update';
  productReferences: string[];
  recipient: 'LiSA';
}

Item

The Item specifies the product item whose emoji state needs to be updated.

Name	Type	Description
id	String Optional.	The id property represents the unique identifier of the product or product variant as specified in the merchant's e-commerce system.

interface ProductEmojiStateUpdateItem {
  id: string;
}

---

Examples

{
  "messageType": "lsc:product:emoji-state-update",
  "productReferences": ["f20312c0-40a2-4b20-986c-5b81ceca6eae"],
  "recipient": "LiSA",
  "sender": "Sender",

  "action": "like.grant",
  "item": {
    "id": "f20312c0-40a2-4b20-986c-5b81ceca6eae"
  },
  "target": "carousel.item"
}