Get to know our frameworks

Select an app template built on your preferred framework.

Build apps on our native app editor. Use drag and drop elements, Velo code and Wix APIs to develop custom features.

Streamline your app development process with the Wix CLI. Get a familiar developer experience with minimal setup and configuration.

Take full control over your app's tech stack, deployment, and hosting.

App templates

Wix Blocks templates

Wix CLI templates

Self-hosted templates

Kickstart your app development with templates built on your preferred Wix developer tool. Browse templates for practical foundation and get to know the Wix ecosystem.

Wix App Templates for Developers

This example apps can be used as a starting point for building your own app, for concrete examples of how to use Wix framework, or for inspiration.

Choose a template.<0 />Build an app.

Browse by:

How to build it step by step:

This template is built with:

Read how this template was built, step by step.

How we built this template

Deployment instructions:

Choose a package manager and run the command in your terminal.

Copy command

Before you get started, make sure you have the following:

Prerequisite steps

Get started with Wix CLI

Begin by setting up your Next.js project with your preferred hosting platform.

Select your hosting service

Start the deployment flow and set up your template repo on Netlify. After you finish set up, come back here and add your Netlify custom domain.

Copy the code from our Git repo to deploy your app on any platform that supports Next.js.

Start the deployment flow and set up your template repo on Vercel. After you finish set up, come back here and add your Vercel generated URL.

Add the base URL and give your app a name.

App details

Go to the app dashboard and test your app to ensure a smooth integration within the Wix ecosystem. <0>Learn more about app checks and testing</0>

Define your environment

Terminal

Related templates

Note

Warning

Your app name will be used as the namespace suffix.

Name your app to generate a namespace. This lets you refer to your app in code later on.

Go Headless

Build Apps

Client

API Preview

Ricos

Develop Websites

REST

Velo

GraphQL (Alpha)

List of booking IDs to retrieve policy snapshots for.

bookingIds

Retrieves a list of booking policy snapshots by booking IDs.

import { bookingPolicySnapshots } from '@wix/bookings';

async function listPolicySnapshotsByBookingIds(bookingIds) {
  const response = await bookingPolicySnapshots.listPolicySnapshotsByBookingIds(bookingIds);
};

listPolicySnapshotsByBookingIds: Wix-hosted

import { createClient } from '@wix/sdk';
import { bookingPolicySnapshots } from '@wix/bookings';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { bookingPolicySnapshots },
  // Include the auth strategy and host as relevant
});


async function listPolicySnapshotsByBookingIds(bookingIds) {
  const response = await myWixClient.bookingPolicySnapshots.listPolicySnapshotsByBookingIds(bookingIds);
};

Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).

listPolicySnapshotsByBookingIds: Self-hosted

listPolicySnapshotsByBookingIds

Manage Bookings Services and Settings

Manage Bookings - all permissions

Read Bookings - all read permissions

Manage Bookings

Read Bookings - Public Data

Read Bookings - Including Participants

ListPolicySnapshotsByBookingIdsResponse

# About the Booking Policy Snapshots API

A booking policy snapshot is the version of a service's
[booking policy](https://dev.wix.com/docs/sdk/backend-modules/bookings/policies/introduction)
at the time a bookings is created. This is important since a policy may change after
the customer books the service. With the Booking Policy Snapshots API, you can:

- Retrieve booking policy snapshots for a list of bookings.

You can use the [Booking Fees API](https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-fees/introduction)
to manage cancellation fees.

## Before You Begin

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

- Every booking with corresponding [eCommerce order](https://dev.wix.com/docs/sdk/backend-modules/ecom/orders/introduction)
  has exactly one policy snapshot. Bookings without related eCommerce order don't have
  a policy snapshot.
- You can't create a booking policy snapshot using this service, you can only
  retrieve policy snapshots. But you could use [getBookingPolicy()](https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-policies/get-booking-policy)
  to retrieve a service's booking policy just before or after you create a
  booking.

## Use Cases

- [Notify business owners of bookings under outdated policy](https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-policy-snapshots/sample-flows#backend-modules_bookings_booking-policy-snapshots_notify-business-owners-of-bookings-under-an-outdated-policy).

## Terminology

- **Booking policy**: Rules set by the business owner regarding booking a service
  and canceling a booking. These may include how far in advance customers can book,
  the deadline for cancellations and resulting cancellation fees, and the maximum number
  of participants allowed per booking.
- **Booking policy snapshot**: The version of a service's booking policy at the
  time a bookings is created. This is important since a policy may change after
  the customer books the service.

For a comprehensive glossary of Wix Bookings terms, see
[Terminology](https://dev.wix.com/docs/sdk/backend-modules/bookings/terminology).

To use the BookingPolicySnapshots API, install the `@wix/bookings` package using npm or Yarn:
  ```console
npm install @wix/bookings
```

or

```console
yarn add @wix/bookings
```

Then import `{ bookingPolicySnapshots }` from `@wix/bookings`:

```js
import { bookingPolicySnapshots } from '@wix/bookings'
```
  

# Booking Policy Snapshots API: Sample Use Cases and Flows

This article shares some possible use cases your code 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 code's implementation.

## Notify business owners of bookings under an outdated policy

Your app could give business owners an overview of all bookings made under an
older version of a service policy.

To display a list of bookings with outdated booking policy:

1. Listen to [onBookingPolicyUpdated()](https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-policies/on-booking-policy-updated).
1. Retrieve all services that are using the affected policy with
   [queryServices()](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/query-services).
   Make sure to pass the relevant policy ID from the previous step as filter.
1. Use [queryExtendedBookings()](https://dev.wix.com/docs/sdk/backend-modules/bookings/extended-bookings/query-extended-bookings).
   For appointment-based service include `bookedEntity.item.slot.serviceId` in
   the filter. For classes or courses include `bookedEntity.item.schedule.serviceId`
   in the filter. You may use a conditional `or` for both filter options in a
   single call.
1. Retrieve the policy snapshots for the affected bookings with
   [listPolicySnapshotsByBookingIds()](https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-policy-snapshots/list-policy-snapshots-by-booking-ids).
1. Create a summary of these bookings, highlighting the policy changes for each booking.
1. Send the summary to the business owners.

bookings_booking-policy-snapshots

BookingPolicy

Date and time the booking policy was created.

_createdDate

string

Date and time the booking policy was updated.

_updatedDate

cancellationFeePolicy

CancellationFeePolicy

cancellationPolicy

CancellationPolicy

Custom description for the booking policy and whether the booking policy is displayed to the participant.

customPolicyDescription

PolicyDescription

Whether the booking policy is the default.

default

boolean

name

reschedulePolicy

ReschedulePolicy

Revision number, which increments by 1 each time the booking policy is updated. To prevent conflicting changes, the current `revision` must be passed when updating the booking policy.

revision

saveCreditCardPolicy

SaveCreditCardPolicy

BookingPolicySnapshot

Date and time the booking policy snapshot was created in `YYYY-MM-DDThh:mm:ssZ` format.

ID of the booking that's associated with this policy snapshot.

bookingId

Snapshot of the [booking policy](https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-policies/get-booking-policy).
at the time the corresponding booking was created.

policy

Whether Wix automatically charges the cancellation fee from the customer once
they cancel their booking.

Default: true

autoCollectFeeEnabled

Time windows relative to the session start during which customers can cancel
their booking. Each window includes details about the fee for canceling
within it.

cancellationWindows

Whether customers must pay a cancellation fee when canceling a booking.

Default: `false`

enabled

Whether customers can cancel the booking. `true` means customers can cancel
the booking.

Default: `false`

Minimum number of minutes before the start of the session customers can cancel.
For courses, this refers to the start of the first course session.

Default: `1440` minutes (1 day)
Min: `1` minute

latestCancellationInMinutes

number

Whether there's a limit on the latest cancellation time. `false` means
customers can cancel the booking until the last minute before the course or
session starts.

Default: `false`

limitLatestCancellation

CancellationWindow

Fixed amount customers must pay when canceling the booking within this window.

amount

Percentage of the booking price customers must pay when canceling within this window.

Min: `0.01` percent
Max: `100` percent

percentage

Start of the cancellation window in minutes before the session start. For
courses, this refers to the start of the first course session.

startInMinutes

bookingPolicySnapshots

Money

Currency code. Must be valid ISO 4217 currency code (e.g., USD).

currency

Monetary amount. Decimal string in local format (e.g., 1 000,30). Optionally, a single (-), to indicate that the amount is negative.

formattedValue

Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, a single (-), to indicate that the amount is negative.

value

Description of the booking policy.

Default: Empty
Max length: 2500 characters

description

Description of the translated booking policy.

Default: Empty
Max length: 2500 characters

descriptionTranslated

Whether the description is displayed to the participant. `true` means the
description is displayed.

Default: `false`

Whether customers can reschedule a booking for an appointment-based service.
`true` means customers can reschedule.

Default: `false`

Minimum number of minutes before the session start session customers can
reschedule their booking.

Default: `1440` minutes (1 day)
Min: `1` minute

latestRescheduleInMinutes

Whether there's a limit on the latest supported rescheduling time. `false`
means customers can reschedule until the last minute before the session start.

Default: `false`

limitLatestReschedule

Whether Wix stores credit card details of the customer. Storing the details
allows Wix to prefill the checkout and thus increases the likelyhood that the
customer completes the booking process.

Default: `false`

Setup