Skip to main content

categoryBySource

Retrieve a single category by its external source / source identifier pair.

Used by upstream systems to resolve a category they originated using the identifiers they assigned, without needing to know the catalogue's internal identifiers.

Possible errors:

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

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

categoryBySource(
  source: SourceInput!
  hidden: YesNo
): Category!

Arguments​

categoryBySource.source ● SourceInput! non-null input​

External system name paired with the identifier it assigned to the category.

Both fields must be supplied.

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