Skip to main content

Clusters

Clusters are groups of products and/or options in an e-commerce shop on the Propeller platform. The Cluster API can be used to consult, create, update or delete a Cluster, Cluster Option or Cluster Product.

Cluster Lookup keys

KeyTypeDescription
idintegerPropeller cluster id, auto-generated
sourceIdstringExternal system unique id. sourceId should be combined with source

What are lookup keys?

Fields

NameDescriptionType
clusterConfigIdCluster config idinteger
sourceIdExternal system unique idstring
sourceExternal systemstring
languageCluster default languagestring
ISO 639-1
codeCluster codestring
namesCluster namearray[LocalizedString]
descriptionsCluster descriptionarray[LocalizedString]
shortDescriptionsCluster short descriptionarray[LocalizedString]
parentParent categoryJSON object that identifies the parent. id or sourceId in combination with source

Cluster Errors

This section describes error codes specific for the Cluster resource.

CodeError TypeStatus CodeMessageReason
20004ClusterExists400Cluster already existsCluster with such lookup key already exists
20005ClusterMultipleFound400Multiple clusters found. Please provide additional filtersMultiple clusters with such lookup key exist
20006ClusterNotFound404Cluster does not existCluster with such lookup key not found
20007ParentClusterNotFound404Parent cluster not foundParent cluster with such lookup key not found.
20008ClusterNotAllowed405Cluster is not allowedNo permission for the cluster