Magidoc

Category
Object

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

Fields

#

allowProductAssignment

Boolean !
Non-null

ancestors

CategoryCountableConnection

List of ancestors of the category.

backgroundImage

Image

children

CategoryCountableConnection

List of children of the category.

customFields

[ SelectedAttribute !]!
Non-null

List of custom fields assigned to this category.

description

String !
Non-null

descriptionHtml

String !
Non-null

externalId

String

externalSource

String

id

ID !
Non-null

The ID of the object

level

Int !
Non-null

metadata

[ MetadataItem !]!
Non-null

List of public metadata items. Can be accessed without permissions.

name

String !
Non-null

parent

Category

privateMetadata

[ MetadataItem !]!
Non-null

List of private metadata items.Requires proper staff permissions to access.

products

ProductCountableConnection

List of products in the category and ancestor categories. This information preferable to request only for a single category details query.

seoDescription

String

seoTitle

String

slug

String !
Non-null

trailingBreadcrumbs

[ Category !]

List providing entire parent-to-child lineage of categories leading to current category

Interfaces

#

Also implements Node , ObjectWithMetadata .

Usages

#

References

#

  • Field allCategories from Query