Skip to main content

category

Retrieve a single category by identifier, slug or external source.

Supports lookup by global identifier, numeric identifier, localized slug, or source / source identifier pair. Exactly one lookup parameter must be supplied. Hidden categories can be filtered in or out for catalog-facing surfaces.

Possible errors:

  • CATEGORY_NOT_FOUND: No category matched the supplied lookup parameters.
  • CATEGORY_FIND_ERROR: The catalogue could not be queried for the supplied lookup parameters.

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

category(
  categoryId: Float
  uuid: String
  slug: String
  language: String
  hidden: YesNo
): Category!

Arguments​

category.categoryId ● Float scalar​

Numeric identifier of the category to retrieve.

Mutually exclusive with the other lookup parameters.

category.uuid ● String scalar​

Global identifier of the category to retrieve.

Mutually exclusive with the other lookup parameters.

category.slug ● String scalar​

Localized slug of the category to retrieve.

When supplied, the language argument should also be supplied to disambiguate between languages.

category.language ● String scalar​

Two-letter ISO 639-1 language code paired with the slug lookup.

Used to disambiguate slugs that exist in more than one language.

category.hidden ● YesNo enum​

Restricts the lookup to categories matching the supplied visibility flag.

Omit to fall back to the caller's default visibility scope.

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.