ProductCategory
A product category can be used to categorize products into a hierarchy of categories.
Properties
id
stringRequiredThe product category's ID
created_at
DateRequiredThe date with timezone at which the resource was created.
productCategoryProductJoinTable
stringRequiredDefault: "product_category_product"
treeRelations
string[]Requiredupdated_at
DateRequiredThe date with timezone at which the resource was updated.
name
stringRequiredThe product category's name
description
stringRequiredThe product category's description.
handle
stringRequiredA unique string that identifies the Product Category - can for example be used in slug structures.
is_active
BooleanRequiredA flag to make product category visible/hidden in the store front
Default: false
is_internal
BooleanRequiredA flag to make product category an internal category for admins
Default: false
The details of the parent of this category.
parent_category_id
null | stringRequiredThe ID of the parent category.
Default: null
The details of the category's children.
rank
numberRequiredAn integer that depicts the rank of category in a tree node
Default: 0
metadata
Record<string, unknown>RequiredAn optional key-value map with additional details
The details of the products that belong to this category.
Was this section helpful?