Alokai

CCPConfiguration

Representation of a product configuration. Contains the entities that describe a complex product: attributes of different types, groups of attributes, hierarchies of groups, statuses and messages. The attributes are typically connected through dependencies CCPConfiguration

export interface CCPConfiguration {
	'complete'?: boolean;
	'configId'?: string;
	'consistent'?: boolean;
	'groups'?: Array<CCPGroup>;
	'hideBasePriceAndSelectedOptions'?: boolean;
	'immediateConflictResolution'?: boolean;
	'kbKey'?: CCPKBData;
	'messages'?: Array<CCPMessage>;
	'newConfiguration'?: boolean;
	'pricingEnabled'?: boolean;
	'quantity'?: number;
	'rootProduct'?: string;
	'totalNumberOfIssues'?: number;
}

Properties

NameRequiredTypeDescription
completeOptionalbooleanConfiguration is complete, meaning each mandatory attribute has been specified {boolean} CCPConfiguration
configIdOptionalstringConfiguration Identifier. A randomly generated UUID owned by the product configurator {string} CCPConfiguration
consistentOptionalbooleanConfiguration is consistent, meaning it contains no conflicts {boolean} CCPConfiguration
groupsOptionalArray<CCPGroup>Attribute groups {Array<CCPGroup>} CCPConfiguration
hideBasePriceAndSelectedOptionsOptionalbooleanIf active, price components 'base price' and 'selected options' are not provided, only the total price of a configuration is provided {boolean} CCPConfiguration
immediateConflictResolutionOptionalbooleanIndicates that conflicts needs to be resolved immediately, before any other action is taken {boolean} CCPConfiguration
kbKeyOptionalCCPKBData{CCPKBData} CCPConfiguration
messagesOptionalArray<CCPMessage>Message list {Array<CCPMessage>} CCPConfiguration
newConfigurationOptionalbooleanIndicates whether the configuration is a new configuration {boolean} CCPConfiguration
pricingEnabledOptionalbooleanPricing is enabled, meaning that pricing related APIs are called and prices are shown during configuration {boolean} CCPConfiguration
quantityOptionalnumberConfiguration quantity {number} CCPConfiguration
rootProductOptionalstringCode of the configuration root product {string} CCPConfiguration
totalNumberOfIssuesOptionalnumberTotal number of issues: sum of number of conflicts and number of incomplete mandatory field {number} CCPConfiguration

Referenced Types

On this page