Category Object


Categories organize services (SDK | REST) by controlling the order in which customers see services on the live site and business owners see them in the dashboard.

Properties
idstringRead-onlyformat GUID

Category ID.


revisionstringRead-onlyformat int64

Revision number, which increments by 1 each time the category is updated. To prevent conflicting changes, you must specify the current revision when updating the category.

Ignored when creating a category.


createdDatestringRead-onlyformat date-time

Date and time the category was created in YYYY-MM-DDThh:mm:ss.sssZ format.


updatedDatestringRead-onlyformat date-time

Date and time the Category was last updated in YYYY-MM-DDThh:mm:ss.sssZ format.


namestringminLength 1maxLength 100

Category name.


sortOrderintegerRead-onlyminimum 0format int32

Defines the category's position in the categories list relative to other categories. Wix Bookings assigns sortOrder values with large gaps between adjacent categories, allowing efficient reordering without updating the entire list. When gaps become too small, the system automatically reassigns new sortOrder values to restore larger gaps.


extendedFieldsExtendedFields

Custom field data for the category object.

Extended fields must be configured in the app dashboard before they can be accessed with API calls.

Did this help?