Category Object

Short description of CategoriesService

Properties
idstringformat GUID

Category ID.

revisionintegerRead-onlyformat int64

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.

createdDatestringRead-onlyformat date-time

Date and time the category was created.

updatedDatestringRead-onlyformat date-time

Date and time the category was updated.

namestringminLength 1maxLength 80

Category name.

imageobject

Category image.

  • Pass WixMedia image ID for media previously saved in the Wix Media Manager.
  • Pass full image URL to upload to Wix Media Manager.
itemCounterintegerRead-only

Number of items in this category.

descriptionstringminLength 1maxLength 600

Category description.

Note: This field is returned only when you pass fields: "DESCRIPTION" in the request.

visibleboolean

Whether the category is visible to site visitors in dynamic pages.

  • If the parent category's visibility is set to false, all the children categories' visibility will also be set to false.
  • Passing true will fail if the visibility of any parent categories is false.
  • Default: false.
breadcrumbsobjectRead-only

Category breadcrumbs.

Note: Returned only when you pass "BREADCRUMBS" to the fields array in Categories API requests.

parentCategoryobject

Parent category reference data.

slugstringformat URL_SLUG

Category slug.

If not provided, the slug is autogenerated based on the category name.

richContentDescriptionobject

Category description using rich content.

Learn more about Working with Rich Content.

Note: Returned only when you pass "RICH_CONTENT_DESCRIPTION" to the fields array in Categories API requests.

managingAppIdstringformat GUID

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.

extendedFieldsobject

Custom extended fields for the category object.

Extended fields must be configured in the Wix Dev Center before they can be accessed with API calls.

Was this helpful?
Yes
No