Entities

Category

Category entity - components, queries, links, and related actions

Your storefront encounters the Category entity when building catalog navigation, rendering category listing pages, and displaying breadcrumb trails. A Category represents a product grouping in the catalog (e.g., "Shoes", "Electronics") and links to the products it contains.

Components

Base

CategoryBase

base

Category title and URL slug.

Schema

slug

stringrequired

title

stringrequired

Content

CategoryContent

content

HTML-formatted category description.

Schema

description

{ html }required

Media

CategoryMedia

media

Images and videos associated with the category.

Schema

media

({ type: "image" } | { type: "video" })[]required

SEO

CategorySeo

seo

Meta title, description, and robots directive for the category page.

Schema

title

string

description

string

robots

string

E.g. "index, follow", "noindex, nofollow", etc.

Queries

CategoryAllQuery - Retrieve all categories.
CategoryBySlugQuery - Retrieve a single category by its slug.

Links

CategoryBreadcrumbLink BreadcrumbItem multi - All breadcrumb items that are part of the category breadcrumb.
CategoryProductsLink Product multi - Products assigned to the category.

MenuItem - Navigation menu entries that may link to this category.

Edit this pageorReport an issue

ProductVariant

ProductVariant entity - components, queries, links, and related actions

Cart

Cart entity - components, queries, links, and related actions