Skip to main content

Category

Category entity representing product classification and organization.

External entity from the catalog service that provides category identification and hierarchy information. Used as a reference for category-specific attributes and organizational relationships within the attribute system.

type Category {
  id: Int! @deprecated
  categoryId: Int!
  attributes(input: AttributeResultSearchInput): AttributeResultResponse
  uuid: ID!
  rootCategoryId: Int!
  parentUuid: ID
  sortOrder: Int
  path: String! @deprecated
  hidden: YesNo!
  names(language: String): [LocalizedString!]!
  name(language: String): [LocalizedString!]! @deprecated
  descriptions(language: String): [LocalizedString!]!
  description(language: String): [LocalizedString!]! @deprecated
  shortDescriptions(language: String): [LocalizedString!]!
  shortDescription(language: String): [LocalizedString!]! @deprecated
  slugs(language: String): [LocalizedString!]!
  slug(language: String): [LocalizedString!]! @deprecated
  metadataTitles(language: String): [LocalizedString!]!
  metadataDescriptions(language: String): [LocalizedString!]!
  metadataKeywords(language: String): [LocalizedString!]!
  metadataCanonicalUrls(language: String): [LocalizedString!]!
  sources: [Source!]!
  createdAt: DateTime!
  lastModifiedAt: DateTime!
  parent(hidden: YesNo): Category
  categories(
    hidden: YesNo
    sortField: CategorySortableFields = categoryOrder
    sortOrder: SortOrder = ASC
  ): [Category!]!
  categoryPath(hidden: YesNo): [Category!]!
  baseProducts(input: CategoryBaseProductsSearchInput): BaseProductsResponse!
  products(input: CategoryProductSearchInput): ProductsResponse!
  parentId: Int @deprecated
  defaultLanguage: String!
}

Fields​

Category.categoryId ● Int! non-null scalar​

Numeric category identifier retained for compatibility with legacy integrations.

Category.attributes ● AttributeResultResponse object​

Lists attributes for this category based on the search input.

Category.attributes.input ● AttributeResultSearchInput input​

Category.uuid ● ID! non-null scalar​

Globally unique identifier for the category.

Category.rootCategoryId ● Int! non-null scalar​

The ID of the root category this category belongs to

Category.parentUuid ● ID scalar​

Globally unique identifier of the parent category. Omitted for root categories.

Category.sortOrder ● Int scalar​

Sort order within the parent category

Category.hidden ● YesNo! non-null enum​

Hides the category from public catalog and navigation surfaces when set.

Category.names ● [LocalizedString!]! non-null object​

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

Category.names.language ● String scalar​

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

Category.descriptions ● [LocalizedString!]! non-null object​

Localized long-form descriptions shown on category landing surfaces.

Category.descriptions.language ● String scalar​

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

Category.shortDescriptions ● [LocalizedString!]! non-null object​

Localized short descriptions surfaced in listings and tiles.

Category.shortDescriptions.language ● String scalar​

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

Category.slugs ● [LocalizedString!]! non-null object​

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

Category.slugs.language ● String scalar​

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

Category.metadataTitles ● [LocalizedString!]! non-null object​

Localized titles surfaced in search engine result pages.

Category.metadataTitles.language ● String scalar​

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

Category.metadataDescriptions ● [LocalizedString!]! non-null object​

Localized descriptive snippets surfaced in search engine result pages.

Category.metadataDescriptions.language ● String scalar​

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

Category.metadataKeywords ● [LocalizedString!]! non-null object​

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

Category.metadataKeywords.language ● String scalar​

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

Category.metadataCanonicalUrls ● [LocalizedString!]! non-null object​

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

Category.metadataCanonicalUrls.language ● String scalar​

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

Category.sources ● [Source!]! non-null object​

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

Category.createdAt ● DateTime! non-null scalar​

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

Category.lastModifiedAt ● DateTime! non-null scalar​

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

Category.parent ● Category object​

Parent category of the current category, or null when the current category is a root category.

Category.parent.hidden ● YesNo enum​

Restricts the parent to a category matching the supplied visibility flag.

Category.categories ● [Category!]! non-null object​

Direct child categories of the current category.

Category.categories.hidden ● YesNo enum​

Restricts the children to categories matching the supplied visibility flag.

Category.categories.sortField ● CategorySortableFields enum​

Field by which the child categories are ordered.

Category.categories.sortOrder ● SortOrder enum​

Direction in which the child categories are ordered.

Category.categoryPath ● [Category!]! non-null object​

Ancestor chain of the category, from the root down to the category itself.

Category.categoryPath.hidden ● YesNo enum​

Restricts the ancestor chain to categories matching the supplied visibility flag.

Category.baseProducts ● BaseProductsResponse! non-null object​

Products and clusters attached to the category, returned through a single page of results.

Category.baseProducts.input ● CategoryBaseProductsSearchInput input​

Filtering, sorting and pagination criteria for the category's products and clusters.

Category.products ● ProductsResponse! non-null object​

Products attached to the category, resolved through the external product search service.

Returns enriched search results that include facets, sort options and pagination metadata.

Category.products.input ● CategoryProductSearchInput input​

Filtering, sorting and pagination criteria for the product search within the category.

Category.defaultLanguage ● String! non-null scalar​

Default language used to render category content when a requested language is unavailable.

Show deprecated

Returned By​

category query ● categoryBySlug query ● categoryBySource query ● categoryChildren query ● categoryCreate mutation ● categoryHierarchy query ● categoryMoveAbove mutation ● categoryMoveBelow mutation ● categoryUpdate mutation

Member Of​

BaseProductCategoryRelationship object ● Category object ● CategoryAddProductsClustersResponse object ● CategoryRemoveProductsClustersResponse object ● CategoryResponse object ● Cluster object ● Discount object ● Product object ● ProductCategoryRelationship object