ClusterOption

Cluster option for configuring cluster product selections

type ClusterOption implements IClusterOption {
  id: Int!
  clusterOptionId: Int!
  isRequired: YesNo
  hidden: YesNo
  uuid: ID!
  tenant: String!
  createdAt: DateTime!
  createdBy: Int!
  lastModifiedAt: DateTime!
  lastModifiedBy: Int!
  clusterId: Int!
  defaultProductId: Int
  names(language: String): [LocalizedString!]!
  descriptions(language: String): [LocalizedString!]!
  shortDescriptions(language: String): [LocalizedString!]!
  products(input: ClusterOptionProductSearchInput): [Product!]!
  sortOrder: Int
  sources: [Source!]!
  defaultProduct(hidden: Boolean): Product
}

Fields

ClusterOption.id ● Int! non-null scalar

Cluster option ID (alias for clusterOptionId for backward compatibility)

ClusterOption.clusterOptionId ● Int! non-null scalar

Identifier of the cluster option, unique within its cluster.

ClusterOption.isRequired ● YesNo enum

Indicates whether the customer must choose a value for the option to complete the cluster configuration.

ClusterOption.hidden ● YesNo enum

Hides the option from public catalog and configuration surfaces when set.

ClusterOption.uuid ● ID! non-null scalar

Globally unique identifier for the cluster option.

ClusterOption.tenant ● String! non-null scalar

Identifier of the tenant the cluster option belongs to.

ClusterOption.createdAt ● DateTime! non-null scalar

Timestamp marking when the cluster option was created, in UTC ISO 8601 format.

ClusterOption.createdBy ● Int! non-null scalar

Identifier of the user account that created the cluster option.

ClusterOption.lastModifiedAt ● DateTime! non-null scalar

Timestamp marking the last modification of the cluster option, in UTC ISO 8601 format.

ClusterOption.lastModifiedBy ● Int! non-null scalar

Identifier of the user account that last modified the cluster option.

ClusterOption.clusterId ● Int! non-null scalar

Reference to the cluster that owns the option.

ClusterOption.defaultProductId ● Int scalar

Identifier of the product preselected as the default choice for the option.

ClusterOption.names ● [LocalizedString!]! non-null object

Localized names shown to end users when presenting the option. The catalogue's default language must be present.

ClusterOption.names.language ● String scalar

Two-letter ISO 639-1 language code that filters the localized names.

ClusterOption.descriptions ● [LocalizedString!]! non-null object

Localized long-form descriptions shown when the customer explores the option.

ClusterOption.descriptions.language ● String scalar

Two-letter ISO 639-1 language code that filters the localized descriptions.

ClusterOption.shortDescriptions ● [LocalizedString!]! non-null object

Localized short descriptions shown next to the option in listings and configurators.

ClusterOption.shortDescriptions.language ● String scalar

Two-letter ISO 639-1 language code that filters the localized short descriptions.

ClusterOption.products ● [Product!]! non-null object

Products that the customer can pick from for the option.

ClusterOption.products.input ● ClusterOptionProductSearchInput input

Visibility and additional filtering criteria for the products selectable for the option.

ClusterOption.sortOrder ● Int scalar

Sort order within the cluster

ClusterOption.sources ● [Source!]! non-null object

Pairs of external system names and the identifiers each system assigned to the cluster option.

ClusterOption.defaultProduct ● Product object

Product preselected as the default choice for the cluster option.

Falls back to the earliest-attached product when no product is explicitly marked as default.

ClusterOption.defaultProduct.hidden ● Boolean scalar

Restricts the default product to one matching the supplied visibility flag.

Interfaces

IClusterOption interface

Returned By

clusterOption query ● clusterOptionAssignProducts mutation ● clusterOptionCreate mutation ● clusterOptionMoveAbove mutation ● clusterOptionMoveBelow mutation ● clusterOptionRemoveProducts mutation ● clusterOptionUpdate mutation

Member Of

Cluster object ● ClusterOptionsResponse object