Category
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.
type Category {
id: Int! @deprecated
categoryId: Int!
attributes(
input: AttributeResultSearchInput
): AttributeResultResponse
name(
language: String
): [LocalizedString!]!
description(
language: String
): [LocalizedString!]!
shortDescription(
language: String
): [LocalizedString!]!
slug(
language: String
): [LocalizedString!]!
path: String!
categories(
hidden: YesNo
): [Category!]
parent(
hidden: YesNo
): Category
defaultLanguage: String!
metadataTitles: [LocalizedString!]
metadataDescriptions: [LocalizedString!]
metadataKeywords: [LocalizedString!]
metadataCanonicalUrls: [LocalizedString!]
hidden: YesNo!
categoryPath(
hidden: YesNo
): [Category!]!
sources: [Source!]!
products(
input: CategoryProductSearchInput
): ProductsResponse!
}
Fields
Category.id ● Int! deprecated non-null scalar
This property is no longer relevant or necessary, use categoryId instead.
Legacy category identifier (deprecated).
Historical identifier maintained for backward compatibility. Use categoryId for all new implementations.
Category.categoryId ● Int! non-null scalar
Unique category identifier for direct access and management.
Primary identifier for the category used throughout the system for category operations, product associations, and hierarchy management.
Category.attributes ● AttributeResultResponse object
Lists attributes for this category based on the search input.
Category.attributes.input ● AttributeResultSearchInput input
Category.name ● [LocalizedString!]! non-null object
Localized category names for multilingual support.
Collection of category names in different languages for international catalogs. Defaults to the category's default language when specific language is not available. Maximum length: 150 characters per name.
Category.name.language ● String scalar
Language code filter.
When provided, returns only names in the specified language. Must be a valid ISO 639-1 language code. Case-insensitive.
Category.description ● [LocalizedString!]! non-null object
Comprehensive category descriptions with HTML formatting support.
Detailed descriptions of the category that can include HTML formatting for rich content presentation. Supports translation for multilingual catalogs and provides complete category context. Used for category pages and detailed product organization.
Category.description.language ● String scalar
Language code filter.
When provided, returns only descriptions in the specified language. Must be a valid ISO 639-1 language code. Case-insensitive.
Category.shortDescription ● [LocalizedString!]! non-null object
Brief category summaries with HTML formatting support.
Concise descriptions suitable for category listings and navigation elements. Supports HTML formatting and multilingual translation for international catalogs.
Category.shortDescription.language ● String scalar
Language code filter.
When provided, returns only short descriptions in the specified language. Must be a valid ISO 639-1 language code. Case-insensitive.
Category.slug ● [LocalizedString!]! non-null object
SEO-friendly URL slugs for category pages.
URL-friendly identifiers for each language used in category page URLs and navigation. Each language has its own optimized slug for better SEO and user experience. Generated automatically from category names if not provided.
Category.slug.language ● String scalar
Language code filter.
When provided, returns only slugs in the specified language. Must be a valid ISO 639-1 language code. Case-insensitive.
Category.path ● String! non-null scalar
Hierarchical path from root to current category.
Slash-separated path of category IDs from the root category to the current category. Used for hierarchy navigation and product search API integration. Format: "rootId/parentId/currentId"
Category.categories ● [Category!] list object
Child categories within this category.
Array of subcategories that belong to this category, enabling hierarchical category navigation and organization.
Category.categories.hidden ● YesNo enum
Filter by visibility status.
Y = include only hidden categories, N = include only visible categories. When omitted, includes both hidden and visible categories.
Category.parent ● Category object
Parent category in the hierarchy.
The immediate parent category of this category, used for breadcrumb navigation and hierarchy traversal. Null for root-level categories.
Category.parent.hidden ● YesNo enum
Filter by visibility status.
Y = include only if parent is hidden, N = include only if parent is visible. When omitted, includes parent regardless of visibility status.
Category.defaultLanguage ● String! non-null scalar
Default language code for fallback content.
Primary language used when requested language content is not available. Ensures consistent content delivery across multilingual catalogs. Must be a valid ISO 639-1 language code.
Category.metadataTitles ● [LocalizedString!] list object
SEO-optimized page titles for search engines.
Localized title tag content used for search engine optimization and browser tab display. Should be concise, descriptive, and include relevant keywords for better search visibility. Recommended length: 50-60 characters.
Category.metadataDescriptions ● [LocalizedString!] list object
SEO meta descriptions for search engine results.
Localized meta description tag content that appears in search engine results pages. Should be compelling, informative, and within recommended character limits to improve click-through rates. Recommended length: 150-160 characters.
Category.metadataKeywords ● [LocalizedString!] list object
SEO keywords for search engine optimization.
Localized meta keywords relevant to the category content. Used by search engines to understand category context and improve discoverability for relevant search queries. Comma-separated list of relevant keywords.
Category.metadataCanonicalUrls ● [LocalizedString!] list object
Canonical URLs for duplicate content management.
Localized canonical URLs that tell search engines which version of the category page is the authoritative source. Prevents duplicate content issues and consolidates SEO value.
Category.hidden ● YesNo! non-null enum
Visibility status of the category.
Controls whether the category is visible to customers in navigation and search results. Hidden categories are only accessible to administrators and can be used for draft content or temporary organization. Values: Y (hidden) or N (visible).
Category.categoryPath ● [Category!]! non-null object
Complete category path from root to current category.
Retrieves the full hierarchical path from the root category to the current category. Returns an ordered array of categories representing the breadcrumb navigation path.
Category.categoryPath.hidden ● YesNo enum
Filter path categories by visibility status.
Y = include only hidden categories in path, N = include only visible categories in path. When omitted, includes all categories in the path regardless of visibility status.
Category.sources ● [Source!]! non-null object
Source systems associated with the category.
Retrieves information about the external systems or sources that this category originates from or is synchronized with. Useful for tracking category origins in multi-system integrations.
Category.products ● ProductsResponse! non-null object
Products belonging to this category.
Paginated collection of products that are classified under this category, including search results, filtering options, and pagination metadata.
Category.products.input ● CategoryProductSearchInput input
Search and filtering criteria for category products.
Optional search parameters to filter and sort products within this category. If not provided, returns all accessible products in the category with default pagination.
Returned By
category query ● categoryCreate mutation ● categoryUpdate mutation
Member Of
Category object ● CategoryAddProductsClustersResponse object ● CategoryRemoveProductsClustersResponse object ● CategoryResponse object ● Cluster object ● Discount object ● Product object