ProductCategory

A product category can be used to categorize products into a hierarchy of categories.

Properties

idstringRequired

The product category's ID

created_atDateRequired

The date with timezone at which the resource was created.

productCategoryProductJoinTablestringRequired

Default: "product_category_product"

treeRelationsstring[]Required

updated_atDateRequired

The date with timezone at which the resource was updated.

namestringRequired

The product category's name

descriptionstringRequired

The product category's description.

handlestringRequired

A unique string that identifies the Product Category - can for example be used in slug structures.

is_activeBooleanRequired

A flag to make product category visible/hidden in the store front

Default: false

is_internalBooleanRequired

A flag to make product category an internal category for admins

Default: false

parent_categorynull | ProductCategoryRequired

The details of the parent of this category.

parent_category_idnull | stringRequired

The ID of the parent category.

Default: null

category_childrenProductCategory[]Required

The details of the category's children.

ranknumberRequired

An integer that depicts the rank of category in a tree node

Default: 0

metadataRecord<string, unknown>Required

An optional key-value map with additional details

productsProduct[]Required

The details of the products that belong to this category.