Interface: Metadata
Core product metadata that defines its identity and presentation. Contains essential information about a product that determines how it's categorized, displayed, and managed in the system.
Properties
brand
brand:
string
Brand name for marketing and organization
code
code:
string
Unique product code/prefix used in variant codes
companyGroupIds?
optionalcompanyGroupIds:string[]
Company groups with access when visibility is restricted
componentCode?
optionalcomponentCode:string
Code for component-type products within hybrid modular systems
description
description:
Nullable<string|RawDraftContentState>
Product description as text or structured content
designer
designer:
string
Name of the product designer or creator
displayName
displayName:
string
Customer-facing product name shown in interfaces
manufacturer
manufacturer:
string
Name of the manufacturing company
mode
mode:
MetadataMode
Configuration approach (VARIANT, MODULAR, COMPONENT)
mouseover?
optionalmouseover:ProductThumb
Alternate thumbnail shown on hover
name
name:
string
Internal product name for administration
productCategoryIds
productCategoryIds:
string[]
Categories this product belongs to
productGroupIds
productGroupIds:
string[]
Product groups this product belongs to
showInProductMenu
showInProductMenu:
boolean
If true, product appears in main product listings
standard?
optionalstandard:ProductThumb
Configuration for default product thumbnail
status
status:
Status
Current activation status (ACTIVE, INACTIVE)
tags
tags:
string[]
List of tags for categorization and search
type
type:
MetadataType
Visualization approach (2D or 3D)
variantType?
optionalvariantType:VariantType
For products in variant mode, specifies if standard or hybrid
visibility
visibility:
Visibility
Access control level (PUBLIC, PRIVATE, RESTRICTED_TO)
zoomDisabled?
optionalzoomDisabled:boolean
If true, disables zoom effect in product listings