Cluster Products

Manage the products that belong to a cluster, including create, update and bulk operations scoped to a single cluster.

📄️ Create a product within a cluster

Creates a product and attaches it to the cluster identified by the URL. The product becomes selectable through the cluster's options.

📄️ List products attached to a cluster

Returns every product currently attached to the cluster identified by the URL. Related data may be returned inline using the expands query parameter.

📄️ Retrieve a product attached to a cluster

Retrieves a single product attached to the cluster, identified either by internal identifier or, when looking up by external source identifier, by external source identifier.

📄️ Update a product attached to a cluster

Applies a partial update to the product attached to the cluster. Only fields supplied in the request body are modified.

📄️ Delete a product attached to a cluster

Removes the product attached to the cluster. The product itself is detached from the cluster and deleted from the catalogue.

📄️ Attach existing products to a cluster

Moves existing products from their current location in the catalogue (a category or another cluster) to the cluster identified by the URL.

📄️ Detach products from a cluster

Detaches products from the cluster and moves them to either a category or another cluster. Exactly one of category or cluster must be supplied as the destination.

📄️ Create or update products of a cluster in bulk

Processes up to two thousand products attached to the cluster identified by the URL in a single request.