Alokai

CCPConfigurationOverview

Representation of a product configuration overview, a condensed read-only view of a product configuration. Contains only the selected values. CCPConfigurationOverview

interface CCPConfigurationOverview {
	'appliedCsticFilter'?: Array<CCPFilterData>;
	'groupFilterList'?: Array<CCPFilterData>;
	'groups'?: Array<CCPGroupOverview>;
	'id'?: string;
	'messages'?: Array<CCPMessage>;
	'numberOfConflicts'?: number;
	'numberOfIncompleteCharacteristics'?: number;
	'pricing'?: CCPConfigurationOverallPricing;
	'pricingEnabled'?: boolean;
	'productCode'?: string;
	'sourceDocumentId'?: string;
	'totalNumberOfIssues'?: number;
}

Properties

NameRequiredTypeDescription
appliedCsticFilterOptionalArray<CCPFilterData>For filtering the configuration overview according to attribute facets such as price relevance or attribute author. {Array<CCPFilterData>} CCPConfigurationOverview
groupFilterListOptionalArray<CCPFilterData>For filtering the configuration overview according to the UI groups. {Array<CCPFilterData>} CCPConfigurationOverview
groupsOptionalArray<CCPGroupOverview>Configuration overview groups. {Array<CCPGroupOverview>} CCPConfigurationOverview
idOptionalstringConfiguration Identifier. A randomly generated UUID owned by the product configurator. {string} CCPConfigurationOverview
messagesOptionalArray<CCPMessage>Message list. {Array<CCPMessage>} CCPConfigurationOverview
numberOfConflictsOptionalnumberTotal number of conflicts. {number} CCPConfigurationOverview
numberOfIncompleteCharacteristicsOptionalnumberTotal number of incomplete attributes. {number} CCPConfigurationOverview
pricingOptionalCCPConfigurationOverallPricing{CCPConfigurationOverallPricing} CCPConfigurationOverview
pricingEnabledOptionalbooleanPricing is enabled, meaning that pricing related APIs are called and prices are shown during configuration. {boolean} CCPConfigurationOverview
productCodeOptionalstringProduct code of configuration's root product. {string} CCPConfigurationOverview
sourceDocumentIdOptionalstringIdentifier of document that owns this configuration. Can be the identifier of a saved cart, a quote, or an order. {string} CCPConfigurationOverview
totalNumberOfIssuesOptionalnumberTotal number of issues: sum of number of conflicts and number of incomplete mandatory fields. {number} CCPConfigurationOverview

Referenced Types

On this page