A category for organizing items into a hierarchical structure.
Categories can be nested to create a multi-level hierarchy. Each category belongs to a specific category tree, identified by its treeReference. Each Wix Stores site has one category tree.
Note: Currently, only Wix Stores Catalog (V3) categories are supported. Pass appNamespace: "@wix/stores" in the treeReference for all API calls.
Category breadcrumbs, representing the path from the top-level ancestor category down to the parent of the current category.
Breadcrumbs are useful for building navigation UI and for SEO purposes. For top-level categories, the breadcrumbs list is empty.
Returned only when you pass "BREADCRUMBS_INFO" to the fields array.
Date and time the category was created.
Plain-text category description.
Returned only when you pass "DESCRIPTION" to the fields array.
Custom extended fields for the category object.
Extended fields must be configured in the app dashboard before they can be accessed with API calls.
Category ID.
Category image.
Number of items directly assigned to this category. Doesn't include items in subcategories.
ID of the app responsible for managing items in this category.
When set, only the specified app can add or remove items from this category. This is useful for third-party apps that want to create categories exclusively managed by their app, preventing site owners or other apps from modifying the category's items.
You can get your app's ID from the app dashboard.
Category name.
Information about the category's parent. Top-level categories don't have a parent.
Revision number, which increments by 1 each time the category is updated. To prevent conflicting changes, the current revision must be passed when updating.
Ignored when creating a category.
Category description using rich content.
Note: Returned only when you pass "RICH_CONTENT_DESCRIPTION" to the fields array in Categories API requests.
Custom SEO data for the category.
Category slug.
If not provided, the slug is autogenerated based on the category name.
Reference to the category tree this category belongs to.
When working with Wix Stores categories, always pass appNamespace: "@wix/stores" and treeKey: null.
Date and time the category was updated.
Whether the category is visible to site visitors.
Visibility cascades to subcategories: if a parent category's visibility is set to false, all its subcategories become hidden as well.
Setting a subcategory's visibility to true fails if any of its parent categories are hidden.
Notes:
visible field can only be changed using the Update Category Visibility method.true