Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions wix-bookings/guides/About Wix Bookings.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
The Wix Bookings APIs allow you to build and customize booking experiences for any service-based business.
You can manage services, staff members, resources, pricing, availability, and customer bookings throughout their entire lifecycle.

To build a custom booking app with its own identity using the [Bookings Platform](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings-platform/introduction), see [Building a custom booking app](#building-a-custom-booking-app).

## Wix Bookings APIs

Wix Bookings APIs include:
Expand Down Expand Up @@ -39,8 +41,8 @@ Wix Bookings integrates with the [Calendar APIs](https://dev.wix.com/docs/api-re

Wix Bookings uses 2 key components to manage when services can be booked:

- **Events** are time-specific instances of services (like an appointment or class session).
- **Schedules** organize these events and define when services are available or when resources are booked.
- [Events](https://dev.wix.com/docs/api-reference/business-management/calendar/events/introduction) are time-specific instances of services, such as an appointment or class session.
- [Schedules](https://dev.wix.com/docs/api-reference/business-management/calendar/schedules-v3/introduction) organize these events and define when services are available or when resources are booked.

Each service, [staff member](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members/introduction), and [resource](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/introduction) has associated schedules and events in the calendar system.
Wix Bookings automatically creates and manages schedules and events when you create services, staff members, or bookings.
Expand Down Expand Up @@ -93,6 +95,20 @@ To customize the checkout process, you can choose between 2 approaches:

For step-by-step implementation examples, see our [end-to-end booking flows](https://dev.wix.com/docs/api-reference/business-solutions/bookings/end-to-end-booking-flows).

## Building a custom booking app

The Wix Bookings APIs are designed to work with the Wix Bookings app by default. You can also use the [Bookings Platform](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings-platform/introduction) to build custom booking apps with their own identity and behavior.

With the Bookings Platform, you can:

- Create services and bookings under your app's own [`appId`](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/platform/about-apps-created-by-wix), keeping data separate from Wix Bookings.
- Override default permissions for API operations.
- Configure custom Wix Forms namespaces and automation triggers.

This is useful if you're building a specialized booking app, such as a meetings scheduler or appointment system, rather than extending the standard Wix Bookings experience.

Learn more about [the Bookings Platform](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings-platform/introduction) and how to [build a custom booking app](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings-platform/build-a-custom-booking-app).

## See also

- [Wix Bookings Terminology](https://dev.wix.com/docs/rest/business-solutions/bookings/terminology)
Expand Down
18 changes: 17 additions & 1 deletion wix-bookings/guides/Terminology.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,18 @@ Use the [Add-Ons API](https://dev.wix.com/docs/rest/business-solutions/bookings/
## Add-on group

A collection of related [add-ons](#add-on) linked to a booking service.
Groups define the maximum number of different add-ons customers can select from the group and include customer-facing information like prompts (instructional text displayed to customers to explain the group's purpose and selection rules) and display order (the sequence in which add-ons appear to customers in the group, determined by their order in the group's `add-on IDs` array).
Groups define the maximum number of different add-ons customers can select from the group and include customer-facing information like prompts and display order.
Prompts are instructional text displayed to customers to explain the group's purpose and selection rules.
Display order is the sequence in which add-ons appear to customers in the group, determined by their order in the group's `addOnIds` array.
Use the [Services V2 API](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/about-add-on-groups) to organize add-ons into groups.

## App ID

A unique identifier assigned to each app in the [Wix Developers Center](https://dev.wix.com/).
In the [Bookings Platform](#bookings-platform), the `appId` determines which app owns a service, booking, or policy.
Entities created by the standard Wix Bookings app use the Wix Bookings [`appId`](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/platform/about-apps-created-by-wix), while custom booking apps use their own `appId`.
Learn more about [app identity in the Bookings Platform](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings-platform/app-identity-in-the-bookings-platform).

## Appointment

[Appointments](https://support.wix.com/en/article/creating-the-right-booking-service-for-your-business#appointments) are bookings for on-demand services such as haircuts or consultations.
Expand All @@ -38,6 +47,13 @@ See also:
A fee for a specific booking that's calculated according to the associated booking [policy](#policy).
For example, a cancellation or no-show fee.

## Bookings Platform

The underlying infrastructure that powers Wix Bookings and enables custom booking apps.
The platform provides APIs for creating services, managing bookings, and handling availability, with support for multiple app identities.
Apps built on the Bookings Platform can define custom permissions, forms integrations, and automation triggers through the [Bookings Platform Configuration service plugin](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings-platform/bookings-platform-configuration-service-plugin/introduction).
Learn more about [the Bookings Platform](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings-platform/introduction).

## Business hours

The default operating hours when appointment-based services are available for booking.
Expand Down