Short description of CategoriesService
Category ID.
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.
Date and time the category was created.
Date and time the category was updated.
Category name.
Category image.
Number of items in this category.
Category description.
Note: This field is returned only when you pass fields: "DESCRIPTION"
in the request.
Whether the category is visible to site visitors in dynamic pages.
false
, all the children categories' visibility will also be set to false
.true
will fail if the visibility of any parent categories is false
.false
.Category breadcrumbs.
Note: Returned only when you pass "BREADCRUMBS_INFO"
to the fields
array in Categories API requests.
Parent category reference data.
Category slug.
If not provided, the slug is autogenerated based on the category name.
Category description using rich content.
Note: Returned only when you pass "RICH_CONTENT_DESCRIPTION"
to the fields
array in Categories API requests.
ID of the app responsible for managing the items in this category.
Pass your app ID to restrict updating and deleting items in this category to your app only.
Custom extended fields for the category object.
Extended fields must be configured in the app dashboard before they can be accessed with API calls.