Skip to main content

Cluster Config

Cluster configs are used as rules on how to organize and group your products into clusters within your e-commerce platform. There can be normal clusters for example where there is no need to define attribute, but there can be linear or complex clusters, where you need to define one or two attributes that will be used to group the products.

Cluster Config Lookup keys

KeyTypeDescription
idintegerPropeller cluster config id, auto-generated
namestringCluster config name

What are lookup keys?

Fields

NameDescriptionType
nameCluster config namestring (only alphanumeric characters combined with underscore)
settingsCluster config settingsarray

Settings

NameDescriptionType
attributeNameSetting attribute namestring
displayTypeSetting display typeenum
- dropdown
- radio
- image
- color
prioritySetting priorityinteger

Cluster Config Errors

This section describes error codes specific for the ClusterConfig resource.

CodeError TypeStatus CodeMessageReason
21004ClusterConfigExists400Cluster Config already existsCluster config with such name already exists
21005ClusterConfigNotFound404Cluster Config does not existCluster config with such lookup key not found
21006ClusterConfigSettingExists400Cluster Config Setting already existsCluster config setting with such attribute name already exists
21007ClusterConfigSettingNotFound404Cluster Config Setting does not existCluster config setting with such lookup key not found