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
| Key | Type | Description |
|---|---|---|
id | integer | Propeller cluster id, auto-generated |
sourceId | string | External system unique id. sourceId should be combined with source |
Fields
| Name | Description | Type |
|---|---|---|
clusterConfigId | Cluster config id | integer |
sourceId | External system unique id | string |
source | External system | string |
language | Cluster default language | string ISO 639-1 |
code | Cluster code | string |
names | Cluster name | array[LocalizedString] |
descriptions | Cluster description | array[LocalizedString] |
shortDescriptions | Cluster short description | array[LocalizedString] |
parent | Parent category | JSON object that identifies the parent. id or sourceId in combination with source |
Cluster Errors
This section describes error codes specific for the Cluster resource.
| Code | Error Type | Status Code | Message | Reason |
|---|---|---|---|---|
20004 | ClusterExists | 400 | Cluster already exists | Cluster with such lookup key already exists |
20005 | ClusterMultipleFound | 400 | Multiple clusters found. Please provide additional filters | Multiple clusters with such lookup key exist |
20006 | ClusterNotFound | 404 | Cluster does not exist | Cluster with such lookup key not found |
20007 | ParentClusterNotFound | 404 | Parent cluster not found | Parent cluster with such lookup key not found. |
20008 | ClusterNotAllowed | 405 | Cluster is not allowed | No permission for the cluster |
📄️ Get Options by Cluster lookup key
Use this endpoint to retrieve cluster options by cluster lookup key.
📄️ Create Cluster Option
Use this endpoint to create a single cluster option. If a cluster option is successfully created, the response will include the option `id`.
📄️ Get Option by Cluster lookup key and Option Id
Use this endpoint to get details of single cluster option by cluster lookup key and option id.
📄️ Delete Option by Cluster lookup key and Option Id
Use this endpoint to delete single cluster option by cluster lookup key and option id.
📄️ Update Option by Cluster lookup key and Option Id
Use this endpoint to update single cluster option by cluster lookup key and option id.
📄️ Bulk Cluster Options by lookupKey
The bulk endpoints offer an efficient way of importing/updating large amounts of cluster options with just a single API call. The same lookup key is used for the options as for the cluster. When using the bulk `id` endpoint, the options are identified by Propeller option `id`. If an option with such `id` doesn't already exist, it will be created. If it does exist, the option will be updated.
📄️ Get Products by Cluster lookup key
Use this endpoint to retrieve cluster products by cluster lookup key.
📄️ Create Option Product
> The same endpoints for option products are used as the cluster products, with a difference that option id is used in lookupValue variable instead if cluster id
📄️ Get Product by Cluster lookup key and Product Id
Use this endpoint to retrieve single cluster product details by cluster lookup key and product id.
📄️ Delete Product by Cluster lookup key and Product Id
Use this endpoint to delete single cluster product details by cluster lookup key and product id.
📄️ Update Product by Cluster lookup key and Product Id
Use this endpoint to update single cluster product details by cluster lookup key and product id.
📄️ Bulk Cluster Products by sourceId
The bulk endpoints offer an efficient way of importing/updating large amounts of cluster products with just a single API call. The same lookup key is used for the products as for the cluster. When using the bulk `id` endpoint, the products are identified by Propeller product `id`. If a product with such `id` doesn't already exist, it will be created. If it does exist, the product will be updated.
📄️ Create Cluster
Use this endpoint to create a single cluster. If a cluster is successfully created, the response will include the cluster `id`.
📄️ Get Cluster by lookup key
Use this endpoint to retrieve cluster details by lookup key.
📄️ Delete Cluster by lookup key
Use this endpoint to delete cluster by lookup key.
📄️ Update Cluster by lookup key
Use this endpoint to update a single cluster.
📄️ Bulk Clusters by sourceId
The bulk endpoints offer an efficient way of importing/updating large amounts of categories with just a single API call. When using the bulk `sourceId` endpoint, the categories are identified by `sourceId`, `source` and `language`. If a category doesn't already exist, it will be created. If it does exist, the category will be updated.
📄️ Bulk Clusters by Id
The bulk endpoints offer an efficient way of importing/updating large amounts of categories with just a single API call. When using the bulk `id` endpoint, the categories are identified by Propeller category `id`. If a category with such `id` doesn't already exist, it will be created. If it does exist, the category will be updated.