Skip to main content

category Query

Look up a category by ID or slug.

category(
id: ID
slug: String
slugLanguageCode: LanguageCodeEnum
): Category
Details
type Category implements Node, ObjectWithMetadata {
id: ID!
privateMetadata: [MetadataItem!]!
privateMetafield(
key: String!
): String
privateMetafields(
keys: [String!]
): Metadata
metadata: [MetadataItem!]!
metafield(
key: String!
): String
metafields(
keys: [String!]
): Metadata
seoTitle: String
seoDescription: String
name: String!
description: JSONString
slug: String!
parent: Category
level: Int!
descriptionJson: JSONString @deprecated
updatedAt: DateTime!
ancestors(
before: String
after: String
first: Int
last: Int
): CategoryCountableConnection
products(
filter: ProductFilterInput
where: ProductWhereInput
sortBy: ProductOrder
search: String
channel: String
before: String
after: String
first: Int
last: Int
): ProductCountableConnection
children(
before: String
after: String
first: Int
last: Int
): CategoryCountableConnection
backgroundImage(
size: Int
format: ThumbnailFormatEnum = ORIGINAL
): Image
translation(
languageCode: LanguageCodeEnum!
): CategoryTranslation
}

Arguments

id ● ID

ID of the category.

slug ● String

Slug of the category

slugLanguageCode ● LanguageCodeEnum

Language code of the category slug, omit to use primary slug.

Added in Saleor 3.21

Type

Category

Represents a single category of products. Categories allow to organize products in a tree-hierarchies which can be used for navigation in the storefront.