Skip to main content

categoryBySlug

Retrieve a single category by localized slug and language.

Each language is allowed to declare a distinct slug; the language must be supplied to disambiguate when the same slug exists in more than one language. Hidden categories can be filtered in or out for catalog-facing surfaces.

Possible errors:

  • CATEGORY_NOT_FOUND: No category matched the supplied slug and language.
  • CATEGORY_FIND_ERROR: The catalogue could not be queried for the supplied slug.

AUTH: Role=[product.OWNER,product.EDITOR,product.VIEWER]

categoryBySlug(
  slug: String!
  language: String!
  hidden: YesNo
): Category!

Arguments​

categoryBySlug.slug ● String! non-null scalar​

Localized slug of the category to retrieve.

Must match the slug stored on the category for the supplied language.

categoryBySlug.language ● String! non-null scalar​

Two-letter ISO 639-1 language code identifying which localized slug to match against.

categoryBySlug.hidden ● YesNo enum​

Restricts the lookup to categories matching the supplied visibility flag.

Type​

Category object​

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.