Service Object


The service object represents an offering that a business provides to its customers.

Properties
addOnDetailsArray <AddOnDetails>Read-onlymaxItems 50

Details about all add-ons customers can choose when booking the service.


addOnGroupsArray <AddOnGroup>maxItems 3

Information about the add-on groups associated with the service.


bookingPolicyBookingPolicy

Policy determining under what conditions this service can be booked. For example, whether the service can only be booked up to 30 minutes before it begins.


categoryCategory

Category the service is associated with.


conferencingConferencing

Conferencing options for the service.


createdDatestringRead-onlyformat date-time

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


defaultCapacityintegerminimum 1maximum 1000format int32

Default maximum number of customers that can book the service. The service cannot be booked beyond this capacity.


descriptionstringmaxLength 7000

Service description. For example, High-class hair styling, cuts, straightening and color.


extendedFieldsExtendedFields

Extensions enabling users to save custom data related to the service.


formForm

Form the customer filled out when booking the service.


hiddenboolean

Whether the service is hidden from Wix Bookings pages and widgets.


idstringRead-onlyformat GUID

Service ID.


locationsArray <Location>immutablemaxItems 500

The locations this service is offered at. Read more about service locations.


mainSlugMainSlugRead-only

Active slug for the service. Learn more about service slugs.


mediaMedia

Media associated with the service.


namestringmaxLength 400minLength 1

Service name.


onlineBookingOnlineBooking

Online booking settings.


paymentPayment

Payment options for booking the service. Learn more about service payments.


revisionstringRead-onlyformat int64

Revision number, which increments by 1 each time the service is updated. To prevent conflicting changes, the existing revision must be used when updating a service.


scheduleSchedule

The service's schedule, which can be used to manage the service's events.


seoDataSeoData

Custom SEO data for the service.


serviceResourcesArray <ServiceResource>maxItems 3

Information about which resources must be available so customers can book the service. For example, a meeting room or equipment.


sortOrderintegerformat int32

Order of the service within a category.


staffMemberIdsArray <string>maxItems 220format GUID

IDs of the resources that are associated with the staff members providing the service. Note that these are the resources IDs, not the staff member IDs. Available only for appointment-based services.


supportedSlugsArray <Slug>Read-onlymaxItems 100

A slug is the last part of the URL address that serves as a unique identifier of the service. The list of supported slugs includes past service names for backwards compatibility, and a custom slug if one was set by the business owner.


tagLinestringmaxLength 6000

Short service description, such as Hair styling.


taxableAddressTaxableAddress

Taxable address used to calculate tax


typestring

Service type. Learn more about service types.


updatedDatestringRead-onlyformat date-time

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


urlsUrlsRead-only

URLs to various service-related pages, such as the calendar page and the booking page.

Did this help?