Skip to main content

cluster

Retrieve a single cluster by identifier or localized slug.

Exactly one lookup parameter must be supplied. When looking up by slug the matching language must also be supplied. The lookup honours orderlist permissions and can be scoped to a specific user or company for personalised catalog views.

Possible errors:

  • CLUSTER_NOT_FOUND: No cluster matched the supplied lookup parameters.

AUTH: Role=[product.OWNER,product.EDITOR,product.VIEWER]

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

Arguments​

cluster.clusterId ● Int scalar​

Numeric identifier of the cluster to retrieve.

Mutually exclusive with the other lookup parameters.

cluster.slug ● String scalar​

Localized slug of the cluster to retrieve.

Must be paired with the language argument so the catalogue can disambiguate slugs across languages.

cluster.language ● String scalar​

Two-letter ISO 639-1 language code paired with the slug lookup.

cluster.applyOrderlists ● Boolean scalar​

Enable or disable applying orderlists

cluster.hidden ● Boolean scalar​

cluster.orderlistIds ● [Int!] list scalar​

List orderlists to apply

cluster.userId ● Int scalar​

Browse catalog as a specific User. Permissions, orderlists, favorite will be merged with the logged in user.

cluster.companyId ● Int scalar​

Browse catalog as a specific Company. Permissions, orderlists, favorite will be merged with the logged in user.

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.