Home > @vsf-enterprise/bigcommerce-api > CategoryTree
# CategoryTree interface
Category tree model.
Signature:
export interface CategoryTree
# Properties
Property | Type | Description |
---|---|---|
children? | CategoryTree[] | (Optional) The list of children of the category. |
depth | number | Depth in a tree of categories. |
id | number | Unique ID of the category tree. |
is_visible? | boolean | (Optional) Flag to determine whether the product should be displayed to customers browsing the store. If true, the category will be displayed. If false, the category will be hidden from view. |
name | string | The name displayed for the category. Name is unique with respect to the category’s siblings. |
parent_id | number | The unique numeric ID of the category's parent. This field controls where the category sits in the tree of categories that organize the catalog. Required in a POST if creating a child category. |
path | number[] | Path made of parent categories ids for current category tree level. |
url? | string | (Optional) The custom URL for the category on the storefront. |