Skip to main content

clusterCreate

Create a cluster in the catalogue, optionally attaching it to a parent category.

Clusters group related products and expose them through configurable options. A cluster must reference an existing cluster configuration. The catalogue's default language must be present in the localized name list.

Possible errors:

  • CLUSTER_EXISTS: A cluster with the supplied SKU, code or source identifier already exists.
  • CLUSTER_CONFIG_NOT_FOUND: The supplied cluster configuration identifier did not match any configuration.
  • CATEGORY_NOT_FOUND: The supplied parent category does not exist.
  • SCHEMA_VALIDATION: One or more input fields failed validation.

AUTH: Role=[product.OWNER]

clusterCreate(
  input: ClusterCreateInput!
): Cluster!

Arguments​

clusterCreate.input ● ClusterCreateInput! non-null input​

Cluster creation data including localized content, SKU or code, configuration reference, and parent category.

Type​

Cluster object​

Cluster entity representing grouped products with shared characteristics.

External entity from the catalog service that provides cluster identification and categorization. Clusters group related products together based on shared attributes, features, or business logic. Used as a reference for cluster-specific attributes and group-level properties within the attribute system.