Skip to main content

Interface: ProductMetadata

Core information about a product.

This interface provides the essential metadata that identifies and describes a product in the configurator. It includes information about the product's identity, classification, visual assets, and descriptive content.

Properties​

brand?​

optional brand: string

Brand name for the product.

Identifies the brand under which the product is marketed.

code​

code: string

Unique product code/identifier.

This code uniquely identifies the product and is often used in order processing and inventory management.

description​

description: Nullable<string>

Detailed description of the product.

Provides an in-depth description of the product's features, benefits, and use cases.

designer​

designer: string

Name of the product designer.

Identifies the person or entity responsible for designing the product.

manufacturer​

manufacturer: string

Name of the product manufacturer.

Identifies the company or entity that produces the product.

mode​

mode: MetadataMode

The configurator mode for this product.

Determines whether this is a standard variant product, a modular product, or a component.

mouseoverImage?​

optional mouseoverImage: ProductThumb

Thumbnail image shown on mouse hover.

This alternative thumbnail is displayed when users hover over the product in listings and selection interfaces.

name​

name: string

Display name of the product.

The human-readable name shown to users in the interface.

standardImage?​

optional standardImage: ProductThumb

Default thumbnail image for the product.

This defines the main visual representation of the product in listings and selection interfaces.

status​

status: Status

Current status of the product.

Indicates whether the product is active, inactive, or in another state.

type​

type: MetadataType

The type of product metadata.

Indicates whether this is a 2D, 3D, or other type of product.

variantType?​

optional variantType: VariantType

The specific variant type for variant mode products.

For products in VARIANT mode, specifies whether this is a standard or hybrid variant product.