Skip to main content

CreateCategoryInput

Definition of the category to create.

Contains the localized content, optional parent reference, SEO metadata and visibility flag needed to place a new category in the catalogue tree. Either name or names must be supplied; the catalogue's default language must be among the supplied languages.

input CreateCategoryInput {
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

CreateCategoryInput.names ● [LocalizedStringInput!] list input

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

CreateCategoryInput.descriptions ● [LocalizedStringInput!] list input

Localized long-form descriptions shown on category landing surfaces.

CreateCategoryInput.shortDescriptions ● [LocalizedStringInput!] list input

Localized short descriptions surfaced in listings and tiles.

CreateCategoryInput.slugs ● [LocalizedStringInput!] list input

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

CreateCategoryInput.parent ● Int scalar

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

CreateCategoryInput.parentUuid ● ID scalar

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

CreateCategoryInput.hidden ● YesNo! non-null enum

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

CreateCategoryInput.metadataTitles ● [LocalizedStringInput!] list input

Localized titles surfaced in search engine result pages.

CreateCategoryInput.metadataDescriptions ● [LocalizedStringInput!] list input

Localized descriptive snippets surfaced in search engine result pages.

CreateCategoryInput.metadataKeywords ● [LocalizedStringInput!] list input

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

CreateCategoryInput.metadataCanonicalUrls ● [LocalizedStringInput!] list input

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

CreateCategoryInput.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.

CreateCategoryInput.sources ● [SourceInput!] list input

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

Member Of

categoryCreate mutation