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
| Key | Type | Description |
|---|---|---|
id | integer | Propeller cluster config id, auto-generated |
name | string | Cluster config name |
Fields
| Name | Description | Type |
|---|---|---|
name | Cluster config name | string (only alphanumeric characters combined with underscore) |
settings | Cluster config settings | array |
Settings
| Name | Description | Type |
|---|---|---|
attributeName | Setting attribute name | string |
displayType | Setting display type | enum - dropdown - radio - image - color |
priority | Setting priority | integer |
Cluster Config Errors
This section describes error codes specific for the ClusterConfig resource.
| Code | Error Type | Status Code | Message | Reason |
|---|---|---|---|---|
21004 | ClusterConfigExists | 400 | Cluster Config already exists | Cluster config with such name already exists |
21005 | ClusterConfigNotFound | 404 | Cluster Config does not exist | Cluster config with such lookup key not found |
21006 | ClusterConfigSettingExists | 400 | Cluster Config Setting already exists | Cluster config setting with such attribute name already exists |
21007 | ClusterConfigSettingNotFound | 404 | Cluster Config Setting does not exist | Cluster config setting with such lookup key not found |
📄️ Create Cluster Config
Use this endpoint to create a cluster config. If a cluster config is successfully created, the response will include the cluster config `id`.
📄️ Get Cluster Config by lookup key
Use this endpoint to retrieve cluster config details by lookup key.
📄️ Remove Cluster Config
Use this endpoint to delete cluster config by lookup key.
📄️ Add Setting to Cluster Config
Use this endpoint to add additional settings to a cluster config. If a cluster config setting is successfully created, the response will include the `id`.
📄️ Remove Setting from Cluster Config
Use this endpoint to delete a setting on the cluster config by cluster config lookup key and setting id.
📄️ Update Cluster Config Setting
Use this endpoint to update a setting on the cluster config by cluster config lookup key and setting id. Attrubute name can't be updated.