Skip to main content

Interface: FavouriteItem

Represents a saved favorite item in the configurator.

A FavouriteItem captures the essential information about a saved product configuration or modular scene. It contains identifiers, metadata, and references to visual assets that allow the system to restore the exact state of a configuration when the user wants to revisit it.

Favorite items can represent either standard product configurations (with specific option selections) or modular scenes (with multiple components arranged in a layout).

Extended by​

Properties​

collectionType​

collectionType: "private" | "public"

Identifies the type of collection this item belongs to.

Typically indicates whether this is a public or private favorite, which affects its visibility to other users in the organization.

configurationCode?​

optional configurationCode: string

Configuration code for a standard product favorite.

For standard products, this code captures the selected options and configuration state. It will be undefined for modular scenes.

The configuration code allows the system to restore the exact set of option selections when the favorite is loaded.

favouriteCollectionId​

favouriteCollectionId: string

Unique identifier for this favorite.

This ID uniquely identifies the favorite item within the system and is used for operations like loading, updating, or deleting the favorite.

favouriteCollectionName​

favouriteCollectionName: string

Name of the collection this item belongs to.

This identifies the organizational group under which this favorite is saved, helping users locate and manage related favorites together.

history​

history: History

Information about creation and last modification.

Tracks when this favorite was created and last updated, along with user identification for these actions. This audit trail helps track the evolution of saved configurations.

metadata?​

optional metadata: Metadata

Metadata for regular product favorites.

For standard product configurations, this contains information about the product such as name, brand, description, and thumbnail settings. This will be undefined for modular scenes.

Metadata helps provide context about the product in favorites listings without having to load the full product data.

parentFavouriteCollectionId?​

optional parentFavouriteCollectionId: string

ID of the parent collection, if this belongs to a nested collection structure.

When collections support hierarchical organization, this property links to the parent collection, creating a folder-like structure for organizing favorites.

productId​

productId: string

ID of the product associated with this favorite.

For standard products, this identifies the base product that was configured. For modular products, this identifies the modular product container.

This ID is used to load the correct product when the favorite is selected, ensuring the saved configuration is applied to the right product.

s3Path​

s3Path: string

Relative path to the thumbnail image for this favorite.

This path points to a visual representation of the saved configuration that can be displayed in favorites lists and selection interfaces.

Thumbnails are crucial for helping users visually identify saved configurations in a potentially large list of favorites.

sceneName?​

optional sceneName: string

Name of the modular scene.

For modular product scenes, this is the user-defined name of the saved layout, helping users identify specific arrangements or designs. This will be undefined for standard product configurations.

Descriptive scene names help users quickly identify complex layouts in a list of saved favorites.

shortCode?​

optional shortCode: string

Short code representing the modular scene layout.

For modular scenes, this code encapsulates the complete scene configuration including all component positions and settings. It can be used to restore the exact scene state when loading a favorite.

The short code serves as a compact representation of potentially complex scene data, making it efficient to store and transfer.

type​

type: FavouriteType

The type of favorite entry.

Distinguishes between standard product configurations ('PRODUCT') and modular scenes ('MODULAR'). This determines how the favorite is processed when loaded and what interface elements are relevant.