Interface: CustomerConfigState
Customer-specific configuration settings and limits.
This interface provides comprehensive information about a customer's account, including access limits, visual theme, pricing settings, and localization options. It serves as the central repository for customer-specific settings that affect the appearance and behavior of the configurator.
Properties
basket?
optionalbasket:Nullable<CustomerBasket<string>>
Settings for the Mimeeq Basket functionality.
These settings control how the built-in shopping basket behaves for this customer.
CDNPath
CDNPath:
Nullable<string>
Base URL for customer assets in the CDN.
This path is used to construct URLs for customer-specific images, models, and other assets.
collectionId?
optionalcollectionId:string
ID of WIX collection to which products should be added.
Deprecated
This is a legacy setting for WIX integration.
customerCode
customerCode:
Nullable<string>
Unique code for the current customer.
This is an internal identifier used for accessing data from bucket.
customerId
customerId:
Nullable<string>
Unique identifier for the current customer.
This ID identifies the customer account that is currently active in the configurator.
customerName?
optionalcustomerName:Nullable<string>
Display name for the current customer.
This is the human-readable name of the customer organization.
dataCustomerId
dataCustomerId:
Nullable<string>
ID of the customer whose data is being used.
This may differ from customerId in cases where a customer is using shared or white-labeled data from another customer.
defaultLanguage?
optionaldefaultLanguage:string
Default language for the current customer.
This is the language that will be used if no specific language is requested.
defaultPaletteSettings
defaultPaletteSettings:
DefaultPalette
Default palette settings for this customer.
These settings provide the base colors and styles for the customer's theme.
defaultPriceSettings
defaultPriceSettings:
CustomerPriceSettings[]
Available price settings for internal users.
These define which price types are available for internal users to select from.
internalDefaultPriceType
internalDefaultPriceType:
Nullable<PriceTypeEnum>
Default price type to use for internal users.
This defines which price tier is shown by default to internal users.
isFullCustomer
isFullCustomer:
boolean
When true, the current user has administrator privileges for this customer. And this is tier1 customer.
Full customers have additional privileges and can access administrator functions within the configurator.
languages?
optionallanguages:string[]
List of languages supported by the current customer.
These are the language codes that can be used with this customer's content.
limits?
optionallimits:CustomerLimits
Feature and capability limits for this customer.
These settings define what features are available to this customer based on their subscription and configuration.
logoS3Path
logoS3Path:
Nullable<string>
URL to the customer's logo image.
This logo is displayed in generated documents.
modularQuickIcons?
optionalmodularQuickIcons:QuickIconsType[]
Global list of quick icons visible on modular mobile products.
These are specialized quick actions for modular products on mobile devices.
prefix
prefix:
Nullable<string>
Unique prefix for the current customer.
This prefix is used in various identifiers to namespace customer-specific resources and prevent collisions.
quickIcons?
optionalquickIcons:QuickIcons
Global list of quick icons visible on products.
These icons provide shortcuts to common actions across all products.
theme
theme:
Theme
Visual theme configuration for the customer.
This defines the colors, fonts, and other visual elements that create the customer's branded experience.
warning3dText?
optionalwarning3dText:Nullable<string>
Custom text for the 3D warning message.
This allows customers to provide their own warning message for 3D visualization.