Skip to main content

cluster

Retrieve detailed information about a specific product cluster.

Returns comprehensive cluster data including configuration options, products, drill-down settings, and localized content. Can be accessed by cluster ID or slug with language-specific support for localized content.

cluster(
  id: Int
  clusterId: Int
  slug: String
  language: String
  applyOrderlists: Boolean = true
  hidden: Boolean
  orderlistIds: [Int!]
): Cluster!

Arguments​

cluster.id ● Int scalar​

Legacy cluster identifier (deprecated).

Use clusterId instead. This field will be removed in future versions.

cluster.clusterId ● Int scalar​

Unique numeric identifier of the cluster.

Primary cluster ID used throughout the system. Either this or slug must be provided to identify the cluster.

cluster.slug ● String scalar​

URL-friendly cluster identifier.

Human-readable cluster identifier used in URLs. Can be language-specific when used with the language parameter.

cluster.language ● String scalar​

Language code for localized slug lookup.

ISO 639-1 uppercase language code (e.g., 'EN', 'NL', 'DE') used when searching by slug to find language-specific cluster URLs.

cluster.applyOrderlists ● Boolean scalar​

Enable orderlist-based cluster filtering.

When true, applies orderlist restrictions to determine cluster visibility and product availability based on customer permissions.

cluster.hidden ● Boolean scalar​

Include hidden clusters in results.

When true, includes clusters marked as hidden. When false or not specified, only shows visible clusters.

cluster.orderlistIds ● [Int!] list scalar​

Specific orderlists to apply for cluster filtering.

List of orderlist IDs to use for determining cluster and product visibility. If not specified, uses default orderlists based on customer context.

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.