Home > @vsf-enterprise/bigcommerce-api > Category
# Category interface
Bigcommerce Category
Signature:
export interface Category
# Properties
| Property | Type | Description |
|---|---|---|
| custom_url? | CustomUrl | (Optional) The custom URL for the product on the storefront. |
| default_product_sort? | string | (Optional) Determines how the products are sorted on category page load. |
| description? | string | (Optional) The product description, which can include HTML formatting. |
| id | number | Unique ID of the Category. Increments sequentially |
| image_url? | string | (Optional) Image URL used for this category on the storefront. Images can be uploaded via form file post to /categories/{categoryId}/image, or by providing a publicly accessible URL in this field. |
| 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. |
| layout_file? | string | (Optional) A valid layout file. (Please refer to this article on creating category files.) This field is writable only for stores with a Blueprint theme applied. |
| meta_description? | string | (Optional) Custom meta description for the category page. If not defined, the store’s default meta description will be used. |
| meta_keywords? | string[] | (Optional) Custom meta keywords for the category page. If not defined, the store’s default keywords will be used. Must post as an array like: [“awesome”,“sauce”]. |
| name | string | The name displayed for the category. Name is unique with respect to the category’s siblings. |
| page_title? | string | (Optional) Custom title for the category page. If not defined, the category name will be used as the meta title. |
| 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 if creating a child category. |
| search_keywords? | string | (Optional) A comma-separated list of keywords that can be used to locate the category when searching the store. |
| sort_order? | number | (Optional) Priority this category will be given when included in the menu and category pages. The lower the number, the closer to the top of the results the category will be. |
| views? | number | (Optional) Number of views the category has on the storefront. |