Interface: CustomerMetadata
Comprehensive customer account configuration and preferences.
CustomerMetadata serves as the central repository for all customer-specific settings that affect the appearance, behavior, and functionality of the configurator. This interface combines identity, contact information, visual styling, pricing rules, and localization preferences into a unified configuration profile.
This comprehensive customer profile enables personalized, branded experiences while maintaining consistent business rules and operational parameters across all customer interactions.
Extends
Properties
accentColor
accentColor:
string
Primary highlight color for interactive elements.
This color is used for buttons, selected states, and other interactive elements that need to stand out from the background. It typically aligns with the customer's primary brand color for consistent identity.
Inherited from
activeUserDefaultTypes
activeUserDefaultTypes:
PriceTypeEnum[]
List of active price types for standard users.
These price types are available to regular users of the configurator and determine which pricing calculations they can access. The available price types might include options like RRP (Recommended Retail Price), COST, or SALE.
address?
optionaladdress:string
Street address for the customer organization.
This primary address information is used for official communications, invoicing, and legal documentation. It typically represents the headquarters or main business location.
Inherited from
allowInvites?
optionalallowInvites:boolean
Controls whether this customer can invite new users.
When true, administrators for this customer can send invitations to new users,
allowing them to expand their team. This capability can be restricted based on
licensing limits or administrative policies.
Inherited from
backgroundColor
backgroundColor:
string
Primary background color for the configurator interface.
This color serves as the base canvas for the configurator UI, setting the foundational tone for the interface. It should complement the customer's brand palette while ensuring good contrast for readability.
Inherited from
basket
basket:
CustomerBasket
Settings for the customer's shopping basket functionality.
These settings control how the Mimeeq Basket behaves for this customer, including email notification settings, display names, and navigation paths. It defines the end-to-end cart experience for configured products.
city?
optionalcity:string
City where the customer organization is located.
This city information completes the physical address and is used for regional targeting, shipping calculations, and business analytics.
Inherited from
country?
optionalcountry:string
Country where the customer organization is based.
This information is essential for international operations, taxation, compliance, and localization. It may affect available features, pricing, and currency settings.
Inherited from
customerCode?
optionalcustomerCode:string
Customer-specific code used for data storage organization.
This optional identifier helps organize customer data in storage systems and can be used to construct resource paths or partition data. It's particularly useful in multi-tenant systems for efficient data management.
customerId
customerId:
string
Unique identifier for this customer account.
This ID uniquely identifies the customer throughout the system and is used as the primary key for database operations and API calls. All customer data and configurations are associated with this identifier.
Inherited from
CustomerContactInfo.customerId
customerName?
optionalcustomerName:string
Official registered name of the customer organization.
This is the formal name of the customer entity as registered in business systems. It serves as the default display name when no display name is specified.
Inherited from
CustomerContactInfo.customerName
defaultLanguage
defaultLanguage:
string
Primary language code for this customer.
This defines the fallback language used when no specific language preference is provided. The default language is used for initial loading and as a backup when content is not available in a requested language.
displayName?
optionaldisplayName:string
Optional user-friendly display name for the customer.
When specified, this name is shown in user interfaces instead of the more technical customer name. It can include spaces, special characters, and be formatted for optimal readability.
Inherited from
CustomerContactInfo.displayName
embedLoginUrl?
optionalembedLoginUrl:string
URL for customer-specific embedding access.
When specified, this URL provides a custom authentication endpoint for secure embedded configurator access. This enables integration with the customer's own authentication systems.
Inherited from
group?
optionalgroup:Partial<PaletteGroup>
Styling settings for option groups in the configurator.
These settings control the appearance of option groups, including colors for active, hover, and highlight states. Well-styled groups improve navigation and selection clarity in the configuration process.
Inherited from
history
history:
History
Revision and audit history for this customer account.
Contains a record of changes made to the customer profile, including timestamps and user identifiers for creation and modification events. This audit trail supports compliance requirements and helps troubleshoot configuration changes.
Inherited from
hotSpots?
optionalhotSpots:CustomerHotSpots
Styling settings for hotspots on 3D models.
These settings control the appearance of interactive points on 3D models, including colors and borders. Distinctive hotspot styling helps users identify interactive elements within the visualization.
Inherited from
initLanguage?
optionalinitLanguage:string
Initial language to use for this customer's configurator instances.
This defines the language that will be used when first loading configurator interfaces, before any user language preferences are applied.
Inherited from
internalDefaultPriceType
internalDefaultPriceType:
PriceTypeEnum
Default price type for internal (admin) users.
This determines which pricing view is shown by default to administrative users. Internal users typically have access to more price types, including cost-based pricing that may not be visible to external users.
isWhiteButtonText?
optionalisWhiteButtonText:boolean
Determines if button text should be white regardless of background.
When true, text on buttons will always be white instead of dynamically adjusting based on background color. This override ensures consistent button appearance when the automatic contrast calculation might not align with brand guidelines.
Inherited from
CustomerTheme.isWhiteButtonText
languages
languages:
string[]
List of language codes supported by this customer.
These language codes (e.g., "en", "fr", "de") define which languages are available in the customer's configurator instances. Supporting multiple languages enables global reach while preserving a consistent user experience.
limits
limits:
CustomerLimits
Feature and capability limits for this customer account.
These settings define which features are available based on the customer's subscription tier and account configuration. Limits control access to advanced functionality like modular products, 2D/3D layers, and other premium features.
logoS3Path?
optionallogoS3Path:string
Relative path to the customer's logo image.
This image appears in the configurator interface, generated PDFs, and other branded touchpoints. A high-quality logo ensures consistent brand representation across all customer interactions.
Inherited from
CustomerContactInfo.logoS3Path
mesh?
optionalmesh:Partial<PaletteMesh>
Styling settings for 3D mesh highlighting.
These settings control how selected parts of 3D models are visually highlighted, including overlay colors and effects. Clear highlighting helps users understand which components they're interacting with.
Inherited from
modularQuickIcons?
optionalmodularQuickIcons:QuickIconsType[]
Quick action icons specific to modular products.
These define which quick actions are available when working with modular products. Appropriate quick actions streamline the modular configuration workflow for complex, multi-component products.
Inherited from
CustomerTheme.modularQuickIcons
partnerDefaultPriceType
partnerDefaultPriceType:
PriceTypeEnum
Default price type for partner users.
This determines which pricing view is shown by default to partner or dealer users. Partner pricing often represents a middle tier between internal cost visibility and external retail pricing.
partnerUserDefaultSettings
partnerUserDefaultSettings:
PartnerUserDefaultSettings[]
Detailed price type settings for partner users.
These settings define which specific price types are available to partner users and their default viewing preferences. This allows for fine-grained control over what pricing information different partners can access.
phone?
optionalphone:string
Primary contact phone number for the customer organization.
This number can be used for direct communication regarding account management, support issues, or business opportunities.
Inherited from
planType?
optionalplanType:string
Subscription tier or plan level for this customer.
Identifies which subscription level or service plan this customer has purchased, which may affect available features, limits, and support levels.
Inherited from
prefix
prefix:
string
Unique code prefix for this customer's resources.
This prefix is used in product codes, IDs, and other identifiers to ensure uniqueness across the system. It typically represents a short abbreviated form of the customer name or brand.
Inherited from
priceSettings
priceSettings:
CustomerPriceSettings[]
Available price type configurations for this customer.
These settings define the different pricing strategies available within the customer's configurator, such as retail pricing, wholesale pricing, or special discount structures. Each price setting includes display names and calculation rules.
quickIcons?
optionalquickIcons:QuickIcons
Configuration for quick action icons in different contexts.
These settings define which quick actions are available on desktop versus mobile interfaces. Context-appropriate quick actions improve usability across different device types and screen sizes.
Inherited from
status
status:
Status
Current activation status of the customer account.
Indicates whether the customer is currently active (operational) or inactive (suspended). Only active customers can access configurator services and appear in normal operational flows.
Inherited from
warning3dText?
optionalwarning3dText:string
Custom warning text for 3D visualizations.
This optional message is displayed to users before launching 3D product views, typically containing disclaimers about accuracy, performance requirements, or usage guidelines. Customizing this text allows for tailored messaging that aligns with the customer's brand voice and legal requirements.
website?
optionalwebsite:string
URL of the customer's website.
This provides a reference to the customer's online presence and can be used for verification, linking, or integration purposes.
Inherited from
zipcode?
optionalzipcode:string
Postal code for the customer's location.
This code is used for mail delivery and can also serve in geographical targeting for region-specific content or pricing.