Service Object

Attributes
idstringRead-onlyformat GUID
Service ID.

infoobject
Information about the service.

policyobject
Description of the bookings policy for the service.

paymentOptionsobject
Payment options available for use when booking the service.

categoryIdstringformat GUID
ID of the category to which the service belongs.

bookingFormIdstringformat GUID
ID of the form that visitors fill out when booking the service.

scheduleIdsArray <string>Read-only
List of schedule IDs for the sessions and slots that can be booked for the service. The list can include schedules with any status values, however the Bookings application only uses the schedules with a status of "CREATED". There is only one schedule with a status of "CREATED" per service. The ID of that schedule must always be the first in the list.

customPropertiesobjectmaxItems 256format map
Set of custom properties for the service.

statusstringRead-only
2 supported values:
CREATEDDELETED
Service status.

sortOrderintegerformat int32
Sort order of the service within its category.

advancedSeoDataobject
Advanced SEO data

seoDataobject
SEO data

includeConferenceOptionboolean
Whether a conference is to be generated for the service.
Was this helpful?
Yes
No

GetGet Service

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Deprecation Notice

This endpoint has been replaced with Services V2's Get Service and will be removed on December 31, 2023. If your app uses this endpoint, we recommend updating your code as soon as possible.

Retrieves a service by ID

Permissions This endpoint requires the Read Bookings - Public Data or Read Bookings - Including Participants permissions scope

Endpoint
GET
https://www.wixapis.com/bookings/v1/services/{id}

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

PutUpdate Service

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Updated a service

Endpoint
PUT
https://www.wixapis.com/bookings/v1/services

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

GetList Services

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Deprecation Notice

This endpoint has been replaced with Services V2's Query Services and will be removed on December 31, 2023. If your app uses this endpoint, we recommend updating your code as soon as possible.

Lists all services in the business

Permissions This endpoint requires the Read Bookings - Public Data or Read Bookings - Including Participants permissions scope

Endpoint
GET
https://www.wixapis.com/bookings/v1/services

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

PostCreate Service

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Creates a service

Endpoint
POST
https://www.wixapis.com/bookings/v1/services

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

PostDelete Service

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Deletes a service

Endpoint
POST
https://www.wixapis.com/bookings/v1/services/{id}/delete

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

Service Notification

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
serviceobject
Updated service entity.

eventstring
4 supported values:
UnspecifiedUpdatedDeletedCreated

policyobject

ONE OF:


deleteMetadataobject
Was this helpful?
Yes
No