Skip to main content

ICluster

No description

interface ICluster {
uuid: ID!
id: Int!
type: ProductClass!
sku: String!
language: String @deprecated
hidden: YesNo!
priority: Int
categoryId: Int!
categoryIds: [Int!]!
defaultLanguage: String!
names(language: String): [LocalizedString!]!
descriptions(language: String): [LocalizedString!]!
shortDescriptions(language: String): [LocalizedString!]!
slugs(language: String): [LocalizedString!]!
shortNames(language: String): [LocalizedString!]!
metadataTitles: [LocalizedString!]!
metadataDescriptions: [LocalizedString!]!
metadataKeywords: [LocalizedString!]!
metadataCanonicalUrls: [LocalizedString!]!
sources: [Source!]!
createdAt: DateTime!
lastModifiedAt: DateTime!
class: ProductClass! @deprecated
clusterId: Int!
}

Fields

ICluster.uuid ● ID! non-null scalar

Globally unique identifier for the product or cluster.

ICluster.id ● Int! non-null scalar

Numeric identifier retained for compatibility with legacy integrations.

ICluster.type ● ProductClass! non-null enum

Discriminator that distinguishes between a product and a cluster within the shared catalogue.

ICluster.sku ● String! non-null scalar

Stock keeping unit. Uniquely identifies a product within the catalogue.

ICluster.hidden ● YesNo! non-null enum

Whether the product is hidden from public display

ICluster.priority ● Int scalar

Priority for sorting and display

ICluster.categoryId ● Int! non-null scalar

Default category ID

ICluster.categoryIds ● [Int!]! non-null scalar

All category IDs this base product belongs to

ICluster.defaultLanguage ● String! non-null scalar

The default language for this product or cluster, this is the language to fall back too, when there is no translation available in a specific language.

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

Localized names shown to end users in catalog and search surfaces. The catalogue's default language must be present.

ICluster.names.language ● String scalar

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

Localized long-form descriptions shown on product detail surfaces.

ICluster.descriptions.language ● String scalar

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

Localized short descriptions surfaced in listings and tiles.

ICluster.shortDescriptions.language ● String scalar

ICluster.slugs ● [LocalizedString!]! non-null object

URL-friendly identifiers, one per language, used in human-readable links.

ICluster.slugs.language ● String scalar

ICluster.shortNames ● [LocalizedString!]! non-null object

Localized short labels shown when the full name is too long.

ICluster.shortNames.language ● String scalar

ICluster.metadataTitles ● [LocalizedString!]! non-null object

Localized titles surfaced in search engine result pages.

ICluster.metadataDescriptions ● [LocalizedString!]! non-null object

Localized descriptive snippets surfaced in search engine result pages.

ICluster.metadataKeywords ● [LocalizedString!]! non-null object

Localized keyword lists used by search engines, supplied as comma-separated values.

ICluster.metadataCanonicalUrls ● [LocalizedString!]! non-null object

Localized canonical URLs that search engines should treat as the authoritative location.

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

Source/SourceId combinations for external system lookup

ICluster.createdAt ● DateTime! non-null scalar

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

ICluster.lastModifiedAt ● DateTime! non-null scalar

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

ICluster.clusterId ● Int! non-null scalar

Cluster ID (legacy field)

Show deprecated

Implemented By

Cluster object