MageSmith
INTERFACE Magento 2.4.9

CategoryInterface

Contains the full set of attributes that can be returned in a category search.

Declared or extended by: Catalog, CatalogCms, CatalogUrlRewrite

Fields

id Int Deprecated

An ID that uniquely identifies the category.

uid ID! Required

The unique ID for a `CategoryInterface` object.

description String

An optional description of the category.

name String

The display name of the category.

path String

The full category path.

path_in_store String

The category path within the store.

url_key String

The URL key assigned to the category.

url_path String

The URL path assigned to the category.

canonical_url String

The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Categories' is enabled.

position Int

The position of the category relative to other categories at the same level in tree.

level Int

The depth of the category within the tree.

created_at String Deprecated

The timestamp indicating when the category was created.

updated_at String Deprecated

The timestamp indicating when the category was updated.

product_count Int

The number of products in the category that are marked as visible. By default, in complex products, parent products are visible, but their child products are not.

default_sort_by String

The attribute to use for sorting.

The list of products assigned to the category.

breadcrumbs [Breadcrumb]

An array of breadcrumb items.

cms_block CmsBlock

Contains a category CMS block.

url_suffix String

The part of the category URL that is appended after the url key

Every Magento dev tool, in one hosted workspace.

Free to sign up. Nothing to install. Drafts, audits, and projects saved across every tool.