# About the Booking Policies API

Booking policies are a set of rules that define how customers can book a
service, including:

+ How early or late customers can book sessions.
+ How late customers can cancel or reschedule sessions.
+ How many participants customers can add to a single booking.

With the Wix Bookings Policies API, you can:

+ Create a policy.
+ Query policies.
+ Change the default policy.

Learn more about how business owners can
[set up booking policies](fallback::https://support.wix.com/en/article/wix-bookings-setting-up-your-booking-policies).

## Before you begin

It’s important to note the following points before starting to code:

+ Every site with Wix Bookings comes with a default booking policy that you can
  update but can't delete.
+ Be aware that daylight saving time can affect booking policies. For example,
  if the time shifts an hour forward during a cancellation window, customers have
  1 hour less to cancel their booking.

## Use cases

+ [Assign a policy to a service](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::78933a77-2094-49ee-a41e-751bb4ba570cslug::sample-flows#assign-a-booking-policy-to-an-existing-service*fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/services/booking-policy/sample-flows#assign-a-booking-policy-to-an-existing-service).
+ [Change the default policy](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::78933a77-2094-49ee-a41e-751bb4ba570cslug::sample-flows#change-the-default-policy*fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/services/booking-policy/sample-flows#change-the-default-policy).

## Terminology

+ __Booking policy__: A set of rules that determine how customers can book a
  service, including timeframes for booking, canceling, or rescheduling.
+ __Default policy__: The booking policy that automatically applies to all
  services on the site. While you can't delete the default policy, you can
  update it or designate another policy as the default.

For a comprehensive glossary of Wix Bookings terms, see [Terminology](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/terminology).

@sdk_package_setup

# Booking Policies API: Sample Use Cases and Flows

This article shares some possible use cases you could support, as well as
a sample flow that could support each use case. This can be a helpful jumping
off point as you plan your implementation.

## Assign a booking policy to an existing service

You could allow the business owner to assign a booking policy to one of
their services.

To assign a booking policy to a service:

1. Call *Query Services*
   ([SDK](portalId::b85dea5b-341b-493b-b99e-4d4ca12baaa2resourceId::d1c98af6-5ad1-4df4-a38f-0b67797af4d4slug::query-services*fallback::https://dev.wix.com/docs/sdk/backend-modules/bookings/services/query-services) | [REST](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/query-services))
   to retrieve all relevant services and display them to the business owner.
   Make sure to save `id` and `revision` of the service for which the owner
   wants to change the booking policy.
1. Call *Query Booking Policies*
   ([SDK](fallback::https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-policies/query-booking-policies) | [REST](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/query-booking-policies))
   to retrieve all relevant booking policies and display them to the owner. Let
   them pick one and save the `bookingPolicy.id`.
1. _Optional_: Allow the owner to create a new policy if they can't find a policy
   that meets all their needs by calling *Create Booking Policy*
   ([SDK](fallback::https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-policies/create-booking-policy) | [REST](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/create-booking-policy))
   Let the owner input all relevant parameters for the policy and save the ID
   of the new policy.
1. Call *Update Service*
   ([SDK](portalId::b85dea5b-341b-493b-b99e-4d4ca12baaa2resourceId::d1c98af6-5ad1-4df4-a38f-0b67797af4d4slug::update-service*fallback::https://dev.wix.com/docs/sdk/backend-modules/bookings/services/update-service) | [REST](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/update-service))
   and provide `service.id`, `service.revision`, and `service.booking.policy.id`.

## Change the default policy

You could allow the business owners to set a new default booking policy for their site.

To change the default policy:

1. Call *Query Booking Policies*
   ([SDK](fallback::https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-policies/query-booking-policies) | [REST](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/query-booking-policies))
   to retrieve all relevant booking policies and display them to the business
   owner. Let them choose a policy and save its ID.
1. _Optional_: Allow the owner to create a new policy if they can't find a policy
   that meets all their needs by calling *Create Booking Policy*
   ([SDK](fallback::https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-policies/create-booking-policy) | [REST](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/create-booking-policy)).
   Let the owner input all relevant parameters for the policy and save the ID
   of the new policy.
1. Call *Set Default Booking Policy*
   ([SDK](fallback::https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-policies/set-default-booking-policy) | [REST](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/set-default-booking-policy))
   and pass the relevant `bookingPolicy.id`.

# Booking Policies: Supported Filters

*Query Booking Policies*
([SDK](fallback::https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-policies/query-booking-policies) | [REST](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/query-booking-policies))
and *Count Booking Policies*
([SDK](fallback::https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-policies/count-booking-policies) | [REST](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/count-booking-policies))
allow you to filter based on properties of the `bookingPolicy` object.

## Filtering

Specify the `filter` object in the following format:

```json
{
  "filter": {
    "fieldName": {
      "$eq": "value"
    }
  }
}
```

The following table shows field support for filters and sorting
for the `bookingPolicy` object:

| Field                                                    | Supported Filters                                         | Sortable |
|----------------------------------------------------------|-----------------------------------------------------------|----------|
| `id`                                                     | `$eq`, `$ne`, `$in`                                       | Sortable |
| `name`                                                   | `$eq`, `$ne`, `$startsWith`                               | Sortable |
| `customPolicyDescription.enabled`                      | `$eq`, `$ne`                                              | Sortable |
| `customPolicyDescription.description`                  | `$eq`, `$ne`, `$startsWith`                               | Sortable |
| `limitEarlyBookingPolicy.enabled`                     | `$eq`, `$ne`                                              | Sortable |
| `limitEarlyBookingPolicy.earliestBookingInMinutes` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$nin` | Sortable |
| `limitLateBookingPolicy.enabled`                      | `$eq`, `$ne`                                              | Sortable |
| `limitLateBookingPolicy.latestBookingInMinutes`    | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$nin` | Sortable |
| `bookAfterStartPolicy.enabled`                        | `$eq`, `$ne`                                              | Sortable |
| `cancellationPolicy.enabled`                            | `$eq`, `$ne`                                              | Sortable |
| `cancellationPolicy.limitLatestCancellation`          | `$eq`, `$ne`                                              | Sortable |
| `cancellationPolicy.latestCancellationInMinutes`     | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$nin` | Sortable |
| `reschedulePolicy.enabled`                              | `$eq`, `$ne`                                              | Sortable |
| `reschedulePolicy.limitLatestReschedule`              | `$eq`, `$ne`                                              | Sortable |
| `reschedulePolicy.latestRescheduleInMinutes`         | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$nin` | Sortable |
| `waitlistPolicy.enabled`                                | `$eq`, `$ne`                                              | Sortable |
| `waitlistPolicy.capacity`                               | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$nin` | Sortable |
| `waitlistPolicy.reservationTimeInMinutes`            | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$nin` | Sortable |
| `participantsPolicy.enabled`                            | `$eq`, `$ne`                                              | Sortable |
| `participantsPolicy.maxParticipantsPerBooking`       | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$nin` | Sortable |
| `resourcesPolicy.enabled`                               | `$eq`, `$ne`                                              | Sortable |
| `resourcesPolicy.autoAssignAllowed`                   | `$eq`, `$ne`                                              | Sortable |

## Sorting

By default, *Query Booking Policies*
([SDK](fallback::https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-policies/query-booking-policies) | [REST](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/query-booking-policies))
is sorted by `createdDate` in ascending order.

You can override the default sorting by specifying the `sort` object in the
following format:

```json
{
  "sort" : [
    {
      "fieldName": "sortOrder",
      "order": "ASC"
    },
    {
      "fieldName": "createdDate",
      "order": "DESC"
    }
  ]
}
```

__Related content:__
- *API Query Language*
  ([SDK](fallback::https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/api-query-language) | [REST](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::8158a590-f60c-4606-9fed-16a34e275f3a*fallback::https://dev.wix.com/docs/rest/articles/getting-started/api-query-language))
- *Query Booking Policies*
  ([SDK](fallback::https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-policies/query-booking-policies) | [REST](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/query-booking-policies))
- *Count Booking Policies*
  ([SDK](fallback::https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-policies/count-booking-policies) | [REST](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/count-booking-policies))

Field	Supported Filters	Sortable
`id`	`$eq`, `$ne`, `$in`	Sortable
`name`	`$eq`, `$ne`, `$startsWith`	Sortable
`customPolicyDescription.enabled`	`$eq`, `$ne`	Sortable
`customPolicyDescription.description`	`$eq`, `$ne`, `$startsWith`	Sortable
`limitEarlyBookingPolicy.enabled`	`$eq`, `$ne`	Sortable
`limitEarlyBookingPolicy.earliestBookingInMinutes`	`$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$nin`	Sortable
`limitLateBookingPolicy.enabled`	`$eq`, `$ne`	Sortable
`limitLateBookingPolicy.latestBookingInMinutes`	`$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$nin`	Sortable
`bookAfterStartPolicy.enabled`	`$eq`, `$ne`	Sortable
`cancellationPolicy.enabled`	`$eq`, `$ne`	Sortable
`cancellationPolicy.limitLatestCancellation`	`$eq`, `$ne`	Sortable
`cancellationPolicy.latestCancellationInMinutes`	`$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$nin`	Sortable
`reschedulePolicy.enabled`	`$eq`, `$ne`	Sortable
`reschedulePolicy.limitLatestReschedule`	`$eq`, `$ne`	Sortable
`reschedulePolicy.latestRescheduleInMinutes`	`$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$nin`	Sortable
`waitlistPolicy.enabled`	`$eq`, `$ne`	Sortable
`waitlistPolicy.capacity`	`$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$nin`	Sortable
`waitlistPolicy.reservationTimeInMinutes`	`$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$nin`	Sortable
`participantsPolicy.enabled`	`$eq`, `$ne`	Sortable
`participantsPolicy.maxParticipantsPerBooking`	`$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$nin`	Sortable
`resourcesPolicy.enabled`	`$eq`, `$ne`	Sortable
`resourcesPolicy.autoAssignAllowed`	`$eq`, `$ne`	Sortable