Interface: RelatedItemConfiguration
Represents a related product with additional dynamic data for display.
This interface extends RelatedItem with additional properties that are generated dynamically based on the current product's configuration. This includes actual image URLs (rather than just settings), and the specific configuration code that should be applied to match the current product's selected options.
These enhanced items have everything needed for immediate display in carousels or suggestion panels without requiring additional processing.
Extends
Properties
code
code:
string
Product code/prefix used in variant codes.
This code forms the prefix part of the complete variant code when combined with a configuration code. It identifies the base product in the system.
Inherited from
configurationCode?
optionalconfigurationCode:string
Configuration code that matches the current product's options.
This code represents the configuration of the related product that best corresponds to options selected in the current product, based on the defined mappings. This ensures visual consistency when navigating between related products.
defaultConfigurationCode?
optionaldefaultConfigurationCode:string
Default configuration code for this product.
When a related product is opened with no specific configuration, this default code is applied to show a recommended setup. This ensures related products always open with an appropriate initial configuration.
Inherited from
RelatedItem.defaultConfigurationCode
description
description:
string
Product description text.
A concise description of the related product that helps users understand its purpose and key features without needing to navigate to the full product page.
Inherited from
hoverImage?
optionalhoverImage:string
URL to the hover state image.
This is the actual image URL to display when users hover over the product thumbnail, providing an alternative view or highlighting key features.
hoverImageMeta?
optionalhoverImageMeta:ProductThumb
Thumbnail image settings for hover state.
These settings define an alternative image to show when users hover over the related product, typically showing a different angle or highlighting key features.
Inherited from
image?
optionalimage:string
URL to the product thumbnail image.
This is the actual image URL for displaying the product, either from a static source or dynamically generated based on the configuration that best matches the current product.
imageMeta?
optionalimageMeta:ProductThumb
Thumbnail image settings for the related product.
These settings define how the product thumbnail should be generated or sourced, including whether it's a static image or dynamically rendered based on configuration.
Inherited from
isActive
isActive:
boolean
Indicates whether this product is currently active.
When true, the product is available for configuration and purchase.
Inactive products may be shown in related listings but marked as
unavailable or coming soon.
Inherited from
isModular
isModular:
boolean
Indicates whether this is a modular product.
When true, this product supports complex scene composition
with multiple components rather than simple configuration.
This affects how the product is opened and rendered.
Inherited from
mappings?
optionalmappings:Record<string,RelatedMapping>
Configuration mappings between the current product and this related product.
These mappings define how options selected in the current product (like finishes or colors) should be translated to compatible options in the related product, ensuring visual consistency when navigating between them.
Inherited from
name
name:
string
Display name of the related product.
This is the human-readable name shown to users in related product listings, typically the marketing name that customers would recognize.
Inherited from
productId
productId:
string
Unique identifier for the related product.
This ID is used to fetch additional product details and to navigate to the product when selected.