UpdateCategoryInput

Fields to update on an existing category.

Only the fields supplied in the input are modified; omitted fields are left untouched. Cannot be used to move a category across catalogue roots.

input UpdateCategoryInput {
  names: [LocalizedStringInput!]
  descriptions: [LocalizedStringInput!]
  shortDescriptions: [LocalizedStringInput!]
  slugs: [LocalizedStringInput!]
  parent: Int
  parentUuid: ID
  hidden: YesNo
  metadataTitles: [LocalizedStringInput!]
  metadataDescriptions: [LocalizedStringInput!]
  metadataKeywords: [LocalizedStringInput!]
  metadataCanonicalUrls: [LocalizedStringInput!]
  autoGenerateSlugs: Boolean
  sources: [SourceInput!]
}

Fields

UpdateCategoryInput.names ● [LocalizedStringInput!] list input

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

Every entry must declare a distinct language. Cannot be combined with the single-language counterpart on the same input.

UpdateCategoryInput.descriptions ● [LocalizedStringInput!] list input

Localized long-form descriptions shown on category landing surfaces.

Every entry must declare a distinct language. Each localized value is capped at 300,000 characters. Cannot be combined with the single-language counterpart on the same input.

UpdateCategoryInput.shortDescriptions ● [LocalizedStringInput!] list input

Localized short descriptions surfaced in listings and tiles.

Every entry must declare a distinct language. Each localized value is capped at 300,000 characters. Cannot be combined with the single-language counterpart on the same input.

UpdateCategoryInput.slugs ● [LocalizedStringInput!] list input

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

Every entry must declare a distinct language. Each value must be a lowercase URL-friendly slug. Cannot be combined with the single-language counterpart on the same input.

UpdateCategoryInput.parent ● Int scalar

Legacy numeric identifier of the parent category; superseded by the structured parent reference.

Cannot be combined with parentUuid on the same input.

UpdateCategoryInput.parentUuid ● ID scalar

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

Cannot be combined with the legacy parent field on the same input.

UpdateCategoryInput.hidden ● YesNo enum

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

UpdateCategoryInput.metadataTitles ● [LocalizedStringInput!] list input

Localized titles surfaced in search engine result pages.

Every entry must declare a distinct language.

UpdateCategoryInput.metadataDescriptions ● [LocalizedStringInput!] list input

Localized descriptive snippets surfaced in search engine result pages.

Every entry must declare a distinct language.

UpdateCategoryInput.metadataKeywords ● [LocalizedStringInput!] list input

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

Every entry must declare a distinct language.

UpdateCategoryInput.metadataCanonicalUrls ● [LocalizedStringInput!] list input

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

Every entry must declare a distinct language.

UpdateCategoryInput.autoGenerateSlugs ● Boolean scalar

Generates missing slugs from the localized names when set; existing slugs are preserved.

When enabled, slugs are regenerated from the localized names for any language whose slug is not explicitly supplied.

UpdateCategoryInput.sources ● [SourceInput!] list input

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

Replaces the existing list of external sources entirely.

Member Of

categoryUpdate mutation