<footer id="WIX_FOOTER" class style="visibility:hidden;"><nav class="zEGd0F" aria-label="More Wix pages" data-hook="footer__wrapper"><div class="qiiRxY"><div class="qSmvZl"><a class="LtfG6S" aria-label="Wix logo, homepage" title="Wix.com" href="https://www.wix.com"><svg xmlns="http://www.w3.org/2000/svg" width="71" height="28" fill="none" viewBox="0 0 166 64"><g fill="#000" clip-path="url(#a)"><path d="M165.301 0h-9.131a7.64 7.64 0 0 0-6.323 3.352l-12.212 18.014a.82.82 0 0 1-1.356 0L124.068 3.352A7.64 7.64 0 0 0 117.745 0h-9.131l21.753 32.09L108.734 64h9.131a7.64 7.64 0 0 0 6.323-3.352l12.091-17.836a.82.82 0 0 1 1.356 0l12.091 17.836A7.64 7.64 0 0 0 156.05 64h9.131l-21.634-31.91zM89.828 6.546V64h4.364a6.546 6.546 0 0 0 6.547-6.547V0h-4.364a6.546 6.546 0 0 0-6.547 6.546M81.83 0h-3.885a9.154 9.154 0 0 0-8.928 7.126L60.33 45.318 52.725 9.666C51.318 3.077 44.557-1.367 37.639.544c-4.407 1.217-7.674 4.94-8.627 9.41L21.485 45.27 12.813 7.128A9.16 9.16 0 0 0 3.883 0H0l14.555 63.997h5.515c5.004 0 9.328-3.499 10.372-8.393l9.305-43.664c.114-.542.6-.934 1.153-.934.552 0 1.038.392 1.153.934l9.312 43.667a10.6 10.6 0 0 0 10.373 8.39h5.533z"></path></g><defs><clipPath id="a"><path fill="#fff" d="M0 0h165.305v64H0z"></path></clipPath></defs></svg></a><p class="bUSBWm">Wix is a website builder that lets any business or individual build their own professional website. By combining design tools and business solutions in one AI-powered platform, Wix makes it easy for anyone to create without limits and scale confidently online.</p><ul class="uLHFcA"><li><a href="https://www.wix.com/about/us" target="_self" class="PlWjyD">About</a></li><li><a href="https://www.wix.com/about/contact-us" target="_self" class="PlWjyD">Contact Us</a></li></ul><ul class="SUCknL FgSyBI" data-hook="social-bar__wrapper"><li><a class="ACLKzf" href="https://www.facebook.com/wix" target="_blank" aria-label="facebook" title="Facebook" data-hook="social-bar__socialLink socialLink--id_facebook"><svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" fill="none" viewBox="0 0 20 20"><path fill="#000" d="M10 0C-2.399.363-3.663 17.76 8.43 20v-7.03H5.876V10.06H8.43V7.845c.072-4.058 3.333-4.207 6.047-3.718v2.476H13.21c-1.249 0-1.639.775-1.639 1.57v1.888h2.788l-.445 2.909H11.57V20C23.666 17.759 22.396.362 10 0"></path></svg></a></li><li><a class="ACLKzf" href="https://www.youtube.com/user/Wix" target="_blank" aria-label="youtube" title="Youtube" data-hook="social-bar__socialLink socialLink--id_youtube"><svg xmlns="http://www.w3.org/2000/svg" width="28" height="20" fill="none" viewBox="0 0 28 20"><path fill="#000" d="M11.83.005c-2.96.056-4.594.12-6.14.237C3.805.385 3.093.511 2.475.81c-.357.173-.62.357-.92.648C.825 2.173.53 2.913.321 4.569l-.085.67a45 45 0 0 0-.162 2.222c-.099 2.083-.099 2.994 0 5.083.03.662.121 1.906.162 2.221l.085.67c.21 1.657.503 2.397 1.234 3.112.714.696 1.393.95 3.008 1.118C6.72 19.89 9.763 20 14 20c3.646 0 6.203-.073 8.31-.235 1.899-.148 2.597-.27 3.215-.57.357-.173.62-.357.92-.648.73-.715 1.025-1.455 1.234-3.111l.085-.67c.04-.316.132-1.56.162-2.222.099-2.089.099-3 0-5.083a45 45 0 0 0-.162-2.221l-.085-.67c-.21-1.657-.503-2.397-1.234-3.112C25.956.98 25.43.695 24.736.536c-.983-.23-3.269-.397-6.684-.492A295 295 0 0 0 11.83.005m.192 6.266c1.055.611 2.063 1.195 5.324 3.08.594.341 1.083.635 1.083.651 0 .014-.789.484-1.753 1.04a2861 2861 0 0 0-5.511 3.187c-.014.006-.022-1.897-.022-4.226 0-2.33.008-4.232.022-4.227.01.003.395.226.857.495"></path></svg></a></li><li><a class="ACLKzf" href="https://www.instagram.com/wix" target="_blank" aria-label="instagram" title="Instagram" data-hook="social-bar__socialLink socialLink--id_instagram"><svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" fill="none" viewBox="0 0 20 20"><path fill="#000" d="M5.858.07c-1.064.05-1.79.22-2.425.47-.658.256-1.215.6-1.77 1.156a4.9 4.9 0 0 0-1.15 1.772C.267 4.105.1 4.832.053 5.897s-.057 1.407-.052 4.122c.005 2.716.017 3.056.069 4.123.05 1.064.22 1.79.47 2.426.256.657.6 1.214 1.156 1.769a4.9 4.9 0 0 0 1.774 1.15c.636.245 1.363.413 2.428.46 1.064.046 1.407.057 4.122.052s3.056-.017 4.123-.068c1.067-.05 1.79-.221 2.425-.47a4.9 4.9 0 0 0 1.769-1.156 4.9 4.9 0 0 0 1.15-1.774c.246-.636.413-1.363.46-2.427.046-1.067.057-1.408.052-4.123s-.018-3.056-.068-4.122c-.05-1.067-.22-1.79-.47-2.427a4.9 4.9 0 0 0-1.156-1.769 4.9 4.9 0 0 0-1.773-1.15C15.895.269 15.168.1 14.104.054 13.039.009 12.697-.003 9.98.002S6.925.018 5.858.07m.117 18.078c-.975-.043-1.504-.205-1.857-.34-.467-.18-.8-.398-1.152-.746a3.1 3.1 0 0 1-.75-1.149c-.137-.352-.302-.881-.347-1.856-.05-1.054-.06-1.37-.066-4.04s.004-2.986.05-4.04c.042-.974.205-1.504.34-1.857.18-.468.397-.8.746-1.151a3.1 3.1 0 0 1 1.15-.75c.351-.138.88-.302 1.855-.348 1.054-.05 1.37-.06 4.04-.066s2.986.004 4.041.05c.974.043 1.505.204 1.857.34.467.18.8.397 1.151.746.352.35.568.682.75 1.15.138.35.302.88.348 1.855.05 1.054.062 1.37.066 4.04s-.004 2.986-.05 4.04c-.043.975-.205 1.504-.34 1.857a3.1 3.1 0 0 1-.747 1.152c-.349.35-.681.567-1.148.75-.352.137-.882.301-1.855.347-1.055.05-1.371.06-4.042.066s-2.985-.005-4.04-.05m8.153-13.493a1.2 1.2 0 1 0 2.4-.003 1.2 1.2 0 0 0-2.4.003M4.865 10.01a5.134 5.134 0 1 0 10.27-.02 5.134 5.134 0 0 0-10.27.02m1.802-.004a3.334 3.334 0 1 1 6.667-.013 3.334 3.334 0 0 1-6.667.013"></path></svg></a></li><li><a class="ACLKzf" href="https://www.tiktok.com/@wix" target="_blank" aria-label="tiktok" title="TikTok" data-hook="social-bar__socialLink socialLink--id_tiktok"><svg xmlns="http://www.w3.org/2000/svg" width="17" height="20" fill="none" viewBox="0 0 17 20"><path fill="#000" d="M14.46 4.009A4.8 4.8 0 0 1 12.417.873 5 5 0 0 1 12.337 0H8.986L8.98 13.78c-.057 1.544-1.294 2.782-2.811 2.782-.472 0-.916-.121-1.307-.332a2.9 2.9 0 0 1-1.51-2.558c0-1.594 1.263-2.89 2.817-2.89.29 0 .568.048.831.133v-3.51a6 6 0 0 0-.831-.062C2.767 7.343 0 10.183 0 13.672a6.37 6.37 0 0 0 2.633 5.181A6.03 6.03 0 0 0 6.17 20c3.4 0 6.168-2.839 6.168-6.329V6.683A7.83 7.83 0 0 0 17 8.222V4.783a4.55 4.55 0 0 1-2.539-.775z"></path></svg></a></li><li><a class="ACLKzf" href="https://www.pinterest.com/wixcom" target="_blank" aria-label="pinterest" title="Pinterest" data-hook="social-bar__socialLink socialLink--id_pinterest"><svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" fill="none" viewBox="0 0 20 20"><path fill="#000" d="M10 0C4.479 0 0 4.477 0 10a10 10 0 0 0 5.986 9.159c-.03-.699-.006-1.536.173-2.296.193-.812 1.288-5.45 1.288-5.45s-.32-.638-.32-1.581c0-1.483.86-2.59 1.928-2.59.91 0 1.35.685 1.35 1.502 0 .914-.583 2.282-.883 3.549-.25 1.06.532 1.926 1.577 1.926 1.895 0 3.172-2.434 3.172-5.317 0-2.19-1.476-3.831-4.161-3.831-3.034 0-4.923 2.261-4.923 4.788 0 .872.256 1.486.66 1.96.183.22.21.308.142.559-.048.184-.157.627-.204.802-.066.254-.271.344-.5.251-1.398-.571-2.047-2.1-2.047-3.82 0-2.842 2.395-6.247 7.145-6.247 3.819 0 6.333 2.762 6.333 5.728 0 3.923-2.182 6.854-5.398 6.854-1.079 0-2.094-.585-2.442-1.247 0 0-.581 2.304-.703 2.749-.213.77-.628 1.542-1.007 2.142.9.265 1.85.41 2.835.41C15.524 20 20 15.523 20 9.999 20 4.477 15.524 0 10 0"></path></svg></a></li><li><a class="ACLKzf" href="https://twitter.com/wix" target="_blank" aria-label="twitter" title="Twitter" data-hook="social-bar__socialLink socialLink--id_twitter"><svg xmlns="http://www.w3.org/2000/svg" width="19" height="20" fill="none" viewBox="0 0 19 20"><path fill="#000" d="m.044.063 7.352 11.022.023.034-3.667 4.39-3.71 4.44L0 20h1.677l3.241-3.881c1.783-2.134 3.242-3.88 3.245-3.88.002 0 1.169 1.745 2.592 3.88L13.344 20H19l-.023-.035-3.84-5.758c-2.1-3.148-3.82-5.73-3.82-5.737a883 883 0 0 1 3.527-4.234C16.783 1.914 18.372.01 18.372.006A28 28 0 0 0 17.54 0h-.835L13.64 3.67a1080 1080 0 0 1-3.074 3.673c-.004.001-1.11-1.65-2.457-3.67L5.658 0H0zM5.339 2.01l11.36 16.74c.005.007-.253.01-1.28.01h-1.286l-2.7-3.977L5.512 6.06C3.739 3.447 2.289 1.308 2.289 1.304s.54-.008 1.283-.008h1.281z"></path></svg></a></li><li><a class="ACLKzf" href="https://www.linkedin.com/company/wix-com?trk=biz-companies-cym" target="_blank" aria-label="linkedin" title="Linkedin" data-hook="social-bar__socialLink socialLink--id_linkedin"><svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" fill="none" viewBox="0 0 20 20"><path fill="#000" d="M18.522.003C15.446-.006 4.1.009 1.478.003.662.003 0 .645 0 1.435v17.133C0 19.358.662 20 1.478 20h17.044c.816 0 1.478-.641 1.478-1.432V1.435c0-.79-.662-1.432-1.478-1.432M6.078 16.738H3.085V7.735h2.993v9.003M4.582 6.506c-1.008.01-1.675-.684-1.673-1.555-.003-2.06 3.358-2.084 3.366 0 0 .864-.65 1.555-1.693 1.555M16.87 16.738h-2.993v-4.816c0-1.21-.433-2.036-1.516-2.036-1.111.04-1.663.901-1.634 1.825v5.027H7.735s.039-8.158 0-9.002h2.992l-.02 1.305c.394-.615 1.103-1.517 2.718-1.517 1.968 0 3.445 1.287 3.445 4.052z"></path></svg></a></li></ul></div><div class="lcWAzl"><div class="C2Sjqd" data-hook="column__column column--name_product"><p class="FBGLaT">Product</p><ul class="BWy7Sp "><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/website/templates" target="_self">Website Templates</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com" target="_self">Website Builder</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/website/design" target="_self">Website Design</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/features/main" target="_self">Wix Features</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/app-market" target="_blank">App Market</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/free/web-hosting" target="_self">Web Hosting</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/domains" target="_self">Domain Names</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/accessibility" target="_self">Website Accessibility</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/app-builder" target="_self">Mobile App Builder</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/ai-website-builder" target="_self">AI Website Builder</a></li></ul></div><div class="C2Sjqd" data-hook="column__column column--name_solutions"><p class="FBGLaT">Solutions</p><ul class="BWy7Sp "><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/ecommerce/online-store" target="_blank">Online Store</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/scheduling-software" target="_blank">Online Booking</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/start/blog" target="_self">Blog Website</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/portfolio-website" target="_self">Portfolio Website</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/ecommerce/website" target="_blank">eCommerce Website</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/studio" target="_self">Wix Studio</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/studio/enterprise" target="_self">Enterprise Solutions</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/university" target="_self">Wix University</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/tools" target="_self">Professional Tools</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/logo/maker" target="_blank">Logo Maker</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/landing-page-builder" target="_blank">Landing Page Builder</a></li></ul></div><div class="C2Sjqd" data-hook="column__column column--name_learn"><p class="FBGLaT">Learn</p><ul class="BWy7Sp "><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/blog" target="_blank">Wix Blog</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/manage/privacy-security-hub" target="_self">Privacy and Security Hub</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/seo/learn" target="_blank">SEO Learning Hub</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/encyclopedia" target="_blank">Wix Encyclopedia</a></li></ul></div><div class="C2Sjqd" data-hook="column__column column--name_support"><p class="FBGLaT">Support</p><ul class="BWy7Sp "><li class="LjUlS_"><a class="KuIaYs" href="https://support.wix.com/en" target="_self">Help Center</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/marketplace" target="_blank">Hire a Professional</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/abuse" target="_self">Report Abuse</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://status.wix.com" target="_self">System Status</a></li></ul></div><div class="C2Sjqd" data-hook="column__column column--name_company"><p class="FBGLaT">Company</p><ul class="BWy7Sp "><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/channels" target="_self">Channel Partnerships</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/press-room/home" target="_self">Press &amp; Media</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://investors.wix.com" target="_self">Investor Relations</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/wix-capital" target="_self">Wix Ventures</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/about/terms-accessibility" target="_self">Accessibility Statement</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/about/patent-notice" target="_self">Patent Notice</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://www.wix.com/about/sitemap" target="_self">Sitemap</a></li><li class="LjUlS_"><a class="KuIaYs" href="https://careers.wix.com" target="_self">Careers</a></li></ul></div></div></div><div class="PXtX5X"><div class="q2YDTr ehx5BU"><div class="JwIlOl"><div class="waU9GL"><ul class="fLy152"><li><a href="https://www.wix.com/about/terms-of-use" target="_self" class="FzJOdO">Terms of Use</a></li><li><a href="https://www.wix.com/about/privacy" target="_self" class="FzJOdO">Privacy Policy</a></li></ul><span class="GiYy1B">© 2006-2025 Wix.com, Inc</span></div></div></div></div></nav></footer>

Get to know our frameworks

Select an app template built on your preferred framework.

Build native Wix apps using a drag-and-drop editor, and add custom code for your business logic.

Streamline your app development process by coding on your local machine with your preferred IDE.

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

App templates

Wix Blocks templates

Wix CLI templates

Self-hosted templates

Kickstart app development and get a practical foundation that you can customize and build upon with templates built for your preferred Wix framework.

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.

2. Copy command

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

1. Complete prerequisites

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.

# About the Bookings Writer V2 API

The Bookings Writer V2 API allows you to manage bookings for a business's services.
You can create single-service bookings or multi-service bookings that combine the booking of multiple services into a single transaction.
For payment processing, you can integrate with Wix eCommerce (Checkout and Orders APIs) or implement your own custom checkout flow.
The booking object holds information about the customer and the session or schedule they have booked.

With the Bookings Writer V2 API you can:

+ Create single-service and multi-service bookings.
+ Manage bookings' life cycles.

## Booking lifecycle

Bookings can progress through different statuses depending on service configuration and business workflow:

#### Core statuses

- `CREATED`: Initial booking created, customer hasn't completed payment. Doesn't appear on the [Booking Calendar](fallback::https://support.wix.com/en/article/wix-bookings-about-the-wix-booking-calendar) or block availability.
- `PENDING`: Awaiting manual business confirmation. Doesn't appear on the Booking Calendar or block availability.
- `CONFIRMED`: Active booking that appears on the Booking Calendar and blocks resource availability.

#### Terminal statuses

- `CANCELED`: Customer-initiated cancellation that may include fees or refunds.
- `DECLINED`: Business has rejected the booking before customer payment.

#### Special status

- `WAITING_LIST`: Booking is placed on a waitlist when the requested class session is at capacity. Only available for class bookings when capacity is exceeded.

#### Common booking flows

- Direct confirmation: `CREATED` → `CONFIRMED` with automatic booking approval.
- Manual approval: `CREATED` → `PENDING` → `CONFIRMED` or `DECLINED`.
- Waitlist flow: `CREATED` → `WAITING_LIST` → `CONFIRMED` or `DECLINED` for classes only.
- Cancellation: Any active status → `CANCELED`.

### Double booking management

Wix Bookings prevents double bookings by default, but conflicts can occasionally occur.
When they do, the system sets a booking's `doubleBooked` flag to `true` and requires the business to manually resolve the conflict.

To prevent conflicts, always use the [Time Slots V2 API](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/time-slots/time-slots-v2/introduction) before creating or rescheduling bookings to verify availability.
When conflicts do occur, you can detect them through events and choose from these resolution options:
- Standard resolution: Reschedule conflicted bookings to an alternative time or cancel them.
- Force resolution: Force confirm or decline bookings regardless of conflicts.

See complete implementation details for [handling double booking conflicts](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/sample-flows#handle-double-booking-conflicts) in the sample flows article.

## Multi-service bookings

Multi-service bookings enable businesses to offer comprehensive service packages where customers can book multiple related services together in a single transaction.
Each multi-service booking contains several single-service bookings.
Single-service bookings in the package must be scheduled sequentially with each booking starting when the previous booking ends.

### Requirements and constraints


Multi-service bookings have the following requirements and limitations:

- Booking creation: You can't create a multi-service booking using existing single-service bookings.
  [Create Multi Service Booking](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/create-multi-service-booking) creates the multi-service booking and all included single-service bookings simultaneously.
- Number of single-service bookings: 2-8 single-service bookings per multi-service booking.
- Scheduling type: Sequential only with single-service bookings running consecutively without gaps.
- Location requirement: All single-service bookings must be at the same business location.
- Service type limitation: Only appointment-based services are supported. Courses and classes aren't supported.
- Status synchronization: Operations affect all grouped single-service bookings simultaneously.
- Pricing: Total price equals the sum of all individual service prices. There are no automatic package discounts.

### Operational behaviors

Multi-service bookings have specific operational characteristics:

- Method restrictions: Single-service bookings in a multi-service booking must be managed using multi-service methods only.
  For example, call [Reschedule Multi Service Booking](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/reschedule-multi-service-booking) instead of [Reschedule Booking](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/reschedule-booking).
- Booking modifications: You can add or remove single-service bookings after creating a multi-service booking.
  If only 1 booking remains after removals, Wix Bookings automatically deletes the multi-service booking while keeping the remaining single-service booking.
- Error handling: Multi-service bookings can experience partial failures where some operations succeed while others fail due to availability conflicts, policy violations, or capacity issues.

## Use cases

- [Book an appointment](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::4e5dc40a-a044-4f4c-900a-64eab9c1a879#book-an-appointment*fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/sample-booking-flows#book-an-appointment).
- [Book a class session](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::4e5dc40a-a044-4f4c-900a-64eab9c1a879#book-a-class-session*fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/sample-booking-flows#book-a-class-session).
- [Book a course](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::4e5dc40a-a044-4f4c-900a-64eab9c1a879#book-a-course*fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/sample-booking-flows#book-a-course).
- [Create a multi-service booking](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::4e5dc40a-a044-4f4c-900a-64eab9c1a879#create-a-multi-service-booking*fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/sample-booking-flows#create-a-multi-service-booking).
- [Reschedule a multi-service booking and add a single-service booking](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::4e5dc40a-a044-4f4c-900a-64eab9c1a879#reschedule-a-multi-service-booking-and-add-a-single-service-booking*fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/sample-booking-flows#reschedule-a-multi-service-booking-and-add-a-single-service-booking).

Refer to [End-to-End Booking Flows](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/end-to-end-booking-flows) for a complete step-by-step overview of the full booking process (including service selection, availability checks, and payment).

## Before you begin

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

- [Wix Bookings](fallback::https://www.wix.com/app-market/web-solution/bookings) must be installed on a site before you can use the Bookings V2 APIs.
- The Bookings Writer V2 API doesn't include methods to retrieve individual single-service bookings. Use the [Bookings Reader V2 API](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-reader-v2/introduction) for reading single-service bookings. The Bookings Writer V2 API does include multi-service booking retrieval methods: [Get Multi Service Booking](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/get-multi-service-booking) and [Bulk Get Multi Service Booking Allowed Actions](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/bulk-get-multi-service-booking-allowed-actions).
- You can handle checkout and payment flows with the [eCommerce Checkout](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::38074d2d-0934-4f0e-a442-db544d43e9cbslug::introduction*fallback::https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction) and [eCommerce Orders](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::546b2514-6a71-4148-bccf-1fb8d8604792slug::introduction*fallback::https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction) APIs or use your own custom flow. When customers pay via a Wix eCommerce checkout, Wix Bookings automatically syncs the booking's payment status with the [Wix eCommerce order](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::546b2514-6a71-4148-bccf-1fb8d8604792slug::introduction*fallback::https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction), so avoid manually updating the booking status. Only for custom payment flows, you must manually update the booking's payment status using [Confirm Booking or Decline Booking](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/confirm-or-decline-booking).
- You can't track attendance with the Bookings Writer V2 API. Instead, use the [Attendance API](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/attendance/introduction).
- Always call the [Time Slots V2 API](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/time-slots/time-slots-v2/introduction) before creating bookings to ensure the requested time slot is available.

## Terminology

- **Booking**: A customer's reservation for a specific service, time slot, or schedule. This is the standard booking type used by most businesses.
- **Single-service booking**: Another term for "booking" used in multi-service booking contexts to distinguish individual bookings from packages.
- **Multi-service booking**: A package that combines multiple bookings under a single ID, scheduled sequentially for a seamless customer experience. All bookings in a multi-service booking are managed together as a group.
- **Service**: A bookable offering such as an appointment, class, or course.
- **Slot**: A specific time period when a service is available for booking.
- **Schedule**: A recurring pattern of availability for a service, such as a weekly yoga class.
- **Session**: An individual occurrence of a class or course.

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

## See also
  
+ [Bookings Reader V2 API](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-reader-v2/introduction):
  Retrieve single-service bookings, allowed actions, and query booking data.
+ [Bookings Services API](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/introduction):
  Manage a business's services so customers can book appointments, class sessions, and courses.
+ [Availability Calendar API](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/time-slots/availability-calendar/introduction):
  Calculate the availability of appointments and class sessions.
+ [Attendance API](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/attendance/introduction):
  Lets you track attendance data for booking sessions.  
+ [Calendar V3 APIs](fallback::https://dev.wix.com/docs/rest/business-management/calendar/introduction):
  Manage a business' schedules and events.
+ [eCommerce Checkout](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::38074d2d-0934-4f0e-a442-db544d43e9cbslug::introduction*fallback::https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction) and [eCommerce Orders](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::546b2514-6a71-4148-bccf-1fb8d8604792slug::introduction*fallback::https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction) APIs:
  Manage checkout and payment flows for a business' bookings.

@sdk_package_setup

@package_metadata:@wix/bookings

To use the Bookings API, install the `@wix/bookings` package.

#### Install the package

Follow the installation instructions for your development environment.

| Development environment | Installation method |
|--|--|
| Wix sites (editor or IDE) | Use the [package manager](fallback::https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/packages/work-with-npm-packages-in-the-editor). |
| Wix sites (local IDE) | Run `wix install @wix/bookings` using the [Wix CLI](fallback::https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/packages/work-with-npm-packages-with-the-wix-cli).|
| Blocks apps | Use the same installation method as Wix sites. |
| CLI and self-hosted apps | Run `npm install @wix/bookings` or `yarn add @wix/bookings`. |
| Headless sites and apps | Run `npm install @wix/bookings` or `yarn add @wix/bookings`. |

#### Import the package

To import the package in your code:

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

# Sample Flows
 This article provides sample flows focusing on the technical details of creating appointment, class session, and course bookings using [Create Booking](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/create-booking). It also shows how to create and reschedule multi-service bookings. For a complete step-by-step overview of the full booking process (including service selection, availability checks, and payment), see [End-to-End Booking Flows](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/end-to-end-booking-flows).

## Book an appointment

To create a booking for an appointment:

1. Identify the business time zone and relevant service ID. For example, as described in [End-to-End Booking Flows](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/end-to-end-booking-flows#book-an-appointment).
1. Call [List Availability Time Slots](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/time-slots/time-slots-v2/list-availability-time-slots) specifying `serviceId`, `timeZone`, `fromLocalDate`, and `toLocalDate` as filters. Save the relevant time slot details.
1. To obtain the selected slot's full capacity and booking-policy status, call [Get Availability Time Slot](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/time-slots/time-slots-v2/get-availability-time-slot). Specify the selected slot's `localStartDate` and `localEndDate`.
1. Call [Create Booking](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/create-booking).
   Specify the slot's `startDate`, `endDate`, `resource` and `location`  in `booking.bookedEntity.slot`. If the slot's availability hasn't changed since calling List Availability Time Slots, the call succeeds and the status of the booking is `CREATED`.

## Book a class session

To create a booking for a class session:

1. Identify the business time zone and relevant service ID. For example, as described in [End-to-End Booking Flows](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/end-to-end-booking-flows#book-a-class-session).
1. Call [List Event Time Slots](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/time-slots/time-slots-v2/list-event-time-slots) specifying `serviceId`, `timeZone`, `fromLocalDate`, `toLocalDate`, and the number of `openSpots` the customer intends to book as filters. Save the `eventId` from the selected time slot.
1. To obtain the selected slot's full capacity and booking-policy status, call [Get Event Time Slot](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/time-slots/time-slots-v2/get-event-time-slot). Specify `eventId` to get detailed information about the class session.
1. Call [Create Booking](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/create-booking) specifying the event ID in `booking.bookedEntity.slot.eventId`.
   If the class session's availability hasn't changed since calling List Event Time Slots, the call succeeds and the status of the booking is `CREATED`.

## Book a course

To create a booking for a course:

1. Identify the relevant business time zone, service ID, service default capacity, and service schedule ID. For example, as described in [End-to-End Booking Flows](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/end-to-end-booking-flows#book-a-course).
1. Retrieve all bookings for this service with [Query Extended Bookings](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-reader-v2/query-extended-bookings) and calculate how many people are already booked for the course.
1. Make sure the intended `numberOfParticipants` doesn't exceed the remaining places.
1. Call [Create Booking](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/create-booking) specifying the relevant schedule ID as `booking.bookedEntity.scheduleId`. If the course's availability hasn't changed since calling Query Extended Bookings, the call succeeds and the status of the booking is `CREATED`.

<blockquote class="important">

__Important:__
Calling [Create Booking](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/create-booking) can fail if the service is no longer available.
To ensure success, for example if you want to create a booking on behalf of the business owner, call Create Booking with `options.flowControlSettings.skipAvailabilityValidation` set to `true`.
Using other `flowControlSettings` lets you override the maximum number of participants per session, or allow payment methods that aren't supported for the service.

</blockquote>

## Create a multi-service booking

To create a multi-service booking (for example, a spa package with massage, facial, and manicure):

1. Identify the business time zone and relevant service IDs for each service in the package. For example, as described in the [single-service appointment end-to-end booking flow](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/end-to-end-booking-flows#book-an-appointment).
1. Call [List Multi Service Availability Time Slots](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/time-slots/time-slots-v2/list-multi-service-availability-time-slots) specifying `services` with `serviceId` for each service, `fromLocalDate`, `toLocalDate`, `timeZone`, and `location` with `locationType`.
1. Call [Create Multi Service Booking](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/create-multi-service-booking) with an array of `bookings` (minimum 2, maximum 8) and `multiServiceBookingType` set to `SEQUENTIAL_BOOKINGS`. You must specify individual slot timing for each service with no gaps between bookings. If availability hasn't changed, the call succeeds and each single-service booking has a status of `CREATED`.

## Reschedule a multi-service booking and add a single-service booking

To reschedule a multi-service booking and then add an additional single-service booking (for example, moving a spa package to a different time and adding a pedicure that couldn't be scheduled at the original end time):

1. Call [Get Multi Service Booking](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/get-multi-service-booking) to retrieve the current multi-service booking details, including all single-service booking IDs and their current revision numbers.
1. For each service you want to reschedule, identify the new slot details (`scheduleId`, `startDate`, `endDate`, `resource`, and `location`).
   For example, as described in the [single-service appointment end-to-end booking flow](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/end-to-end-booking-flows#book-an-appointment).
1. Call [List Multi Service Availability Time Slots](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/time-slots/time-slots-v2/list-multi-service-availability-time-slots) specifying `services` with `serviceId` for each service, `fromLocalDate`, `toLocalDate`, `timeZone`, and `location` with `locationType` to verify availability for the new timing, ensuring all services can still be scheduled sequentially.
1. To obtain the selected multi-service slot's full capacity and booking-policy status, call [Get Multi Service Availability Time Slot](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/time-slots/time-slots-v2/get-multi-service-availability-time-slot). Specify the exact `localStartDate` and `localEndDate` values from the selected slot.
1. Call [Reschedule Multi Service Booking](fallback::https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings/bookings-writer-v2/reschedule-multi-service-booking) specifying the ID of the multi-service booking and an array of `rescheduleBookingsInfo`. For each single-service booking to reschedule, include the `bookingId`, current `revision` number, and new slot details with exact timing to maintain sequential scheduling with all services back-to-back and no gaps or overlaps.
1. Make sure you have an independent single-service booking to add to the package. For example, by following the [single-service appointment end-to-end booking flow](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/end-to-end-booking-flows#book-an-appointment). Ensure the booking timing is compatible with the multi-service booking's sequential schedule and the booking has a compatible status.
1. Call [Add Bookings to Multi Service Booking](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/add-bookings-to-multi-service-booking) specifying the `multiServiceBookingId` and an array of `bookings` containing the `bookingId` and `revision` number.
   The existing timing of the added booking must be compatible with the multi-service booking's sequential schedule for successful integration.

## Handle payments

Once you've created a booking, handle payments using [Wix eCommerce](fallback::https://dev.wix.com/docs/rest/business-solutions/e-commerce/introduction) or your own custom checkout flow. For step-by-step instructions for payment processing, see the [End-to-End Booking Flows article](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/end-to-end-booking-flows#handle-payments).

## Handle double booking conflicts

When scheduling conflicts occur and a booking's `doubleBooked` flag is set to `true`, you can follow this flow to resolve the conflict and handle necessary refunds.

To detect and resolve double booking conflicts:

1. Detect conflicts by listening for these events:
   + [Booking Confirmed](fallback::https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings/bookings-writer-v2/booking-confirmed): Check if `booking.doubleBooked` is `true`.
   + [Booking Marked as Pending](fallback::https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings/bookings-writer-v2/booking-marked-as-pending): Check if `booking.doubleBooked` is `true`.
   
   <blockquote class="important">

   __Important:__
   Only start conflict resolution for events where `booking.flowControlSettings.skipAvailabilityValidation` is `false` or `undefined`. Events with `skipAvailabilityValidation: true` indicate that force resolution was already applied, so processing them again would create an infinite loop.

   </blockquote>
1. Determine resolution options by calling [Bulk Calculate Allowed Actions](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/bulk-calculate-allowed-actions), specifying the relevant booking ID.
   If both `cancel` and `reschedule` flags are `false`, standard resolution isn't available and you'll need to force resolution.
1. Choose a resolution approach:
   - [Standard reschedule](fallback::#standard-reschedule).
   - [Standard cancel](fallback::#standard-cancel).
   - [Force resolution](fallback::#force-resolution).
1. Notify the customer and business about the conflict resolution.

### Standard reschedule

Move an appointment or class booking to a different available time slot that works for the customer.
Course bookings can't be rescheduled.

1. Identify alternative time slots using the Time Slots V2 API:
   - For appointments: Call [List Availability Time Slots](fallback::https://dev.wix.com/docs/api-reference/business-solutions/bookings/time-slots/time-slots-v2/list-availability-time-slots).
   - For class events: Call [List Event Time Slots](fallback::https://dev.wix.com/docs/api-reference/business-solutions/bookings/time-slots/time-slots-v2/list-event-time-slots).
1. Show alternatives to the customer and let them choose.
1. After customer selection, verify the chosen slot is still available:
   - For appointments: Call [Get Availability Time Slot](fallback::https://dev.wix.com/docs/api-reference/business-solutions/bookings/time-slots/time-slots-v2/get-availability-time-slot).
   - For classes: Call [Get Event Time Slot](fallback::https://dev.wix.com/docs/api-reference/business-solutions/bookings/time-slots/time-slots-v2/get-event-time-slot).
1. [Reschedule the booking](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/reschedule-booking) to the new time slot.
1. If the booking was `PENDING` and used a custom checkout, call [Confirm Or Decline Booking](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/confirm-or-decline-booking) to finalize the booking status after rescheduling.

### Standard cancel

Cancel the conflicted booking and process any necessary refunds.
   
1. Call [Cancel Booking](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/cancel-booking).
   Use flow control settings to protect the customer from penalties due to the conflict:
   - `withRefund: true` to ensure customers receive refunds for [pricing plans](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::caf54f25-5469-4058-9b4c-86d1dfc4d5d5*fallback::https://dev.wix.com/docs/api-reference/business-solutions/pricing-plans/plans/plans-v3/introduction) payments since the conflict wasn't their fault.
   - `waiveCancellationFee: true` to waive the [cancellation fee](fallback::https://dev.wix.com/docs/api-reference/business-solutions/bookings/pricing/booking-fees/introduction) as the customer shouldn't be penalized for a booking conflict.

### Force resolution

Override availability validation to confirm or decline the booking when standard options aren't available.
Force resolution options differ significantly between checkout types:

#### For eCommerce checkouts

- **Confirmation option**: Call [Reschedule Booking](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/reschedule-booking), specifying the existing `slot` and `flowControlSettings: { skipAvailabilityValidation: true }`.
  If the service requires manual approval, also specify `skipBusinessConfirmation: true`.
- **Decline option**: 
  - Pricing plan payments: We recommend implementing the standard Cancel Booking call described above with `withRefund: true` instead of force declining. Use `ignoreCancellationPolicy: true` if you need to override timing restrictions.
  - Other payment methods: Manually issue a refund using the [eCommerce Orders API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::546b2514-6a71-4148-bccf-1fb8d8604792slug::introduction*fallback::https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction).
  For step-by-step instruction, you can refer to these [sample flows](fallback::https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/order-billing/sample-flows).
  Then, Wix Bookings automatically updates the booking's `status` to `REFUNDED`.
  
#### For custom checkouts

- **Confirmation option**: Call [Confirm Or Decline Booking](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/confirm-or-decline-booking), specifying `flowControlSettings: { skipAvailabilityValidation: true }` to confirm regardless of conflicts.
- **Decline option**:
  1. Process any necessary refunds through the external payment system.
  2. Update the [eCommerce order](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::546b2514-6a71-4148-bccf-1fb8d8604792slug::introduction*fallback::https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction) to reflect the refund.
     For step-by-step instructions, you can refer to these [sample flows](fallback::https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/order-billing/sample-flows).
     Then, Wix Bookings automatically updates the booking status to `REFUNDED`.

Delete Like