Skip to main content

Interface: FavouriteCollection

Represents a collection that can contain favorite items.

Favorite collections provide an organizational structure for saved product configurations and modular scenes. Users can create multiple collections to categorize their favorites based on projects, themes, or any other criteria that helps them manage their saved designs.

Collections can be either private (visible only to the creator) or public (visible to all users), allowing for both personal organization and team collaboration.

Properties​

collectionType?​

optional collectionType: "private" | "public"

The visibility type of the collection.

This determines who can see and access the items in this collection:

  • 'private': Only visible to the user who created it
  • 'public': Visible to all users in the organization

Public collections are useful for sharing standard configurations, while private collections help users organize their personal work.

favouriteCollectionId​

favouriteCollectionId: string

Unique identifier for the collection.

This ID is used in all operations that target this specific collection, such as saving items to it, managing its contents, or selecting it in the user interface.

favouriteCollectionName​

favouriteCollectionName: string

Display name of the collection.

This is the human-readable name shown in the user interface for this collection. Collection names should be descriptive to help users quickly identify the purpose or theme of the saved items within.