<footer id="WIX_FOOTER" style="visibility:hidden;" class><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">The Wix website builder offers a complete solution from enterprise-grade infrastructure and business features to advanced SEO and marketing tools–enabling anyone to create and grow 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></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/restaurant/website" target="_self">Restaurant Website</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/students" target="_self">Student Website</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></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/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 Capital</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.

With the Robots Txt API, Wix users can define which crawlers are allowed to access and index their website content.

New release: Robots Txt API

The Wix CLI for Headless is now available, opening up an entirely Wix-managed development path for building Wix Headless projects. The CLI is a powerful tool that automates project setup and integrates your frontend with Wix's backend services.
 
Key features include:

- Seamless integration with Astro.
- Serverless hosting for your project's frontend, managed by Wix.
- Extensions to expand dashboard capabilities, handle events, and create service plugins.
- Local development environment with hot reloading and shareable previews.

With the Wix CLI for Headless, you can focus on building your project features while Wix handles infrastructure, authentication, and deployment.

New release: Wix CLI for Headless

The Reservations API has the following new methods:

* [Bulk Archive Reservations](https://dev.wix.com/docs/rest/business-solutions/restaurants/wix-restaurants-new/reservations/reservations/bulk-archive-reservations)
* [Bulk Unarchive Reservations](https://dev.wix.com/docs/rest/business-solutions/restaurants/wix-restaurants-new/reservations/reservations/bulk-unarchive-reservations)

New methods: Restaurants Reservations API

The Items API has the following new method:

* [Search Items](https://dev.wix.com/docs/rest/business-solutions/restaurants/wix-restaurants-new/menus/items/items/search-items)

New method: Restaurants Items API

The Plans V3 API allows you to create and manage pricing plans that determine charges for site content and services.

New release: Pricing Plans V3 API

The Items API has the following new method:

* [Search Items](https://dev.wix.com/docs/sdk/backend-modules/restaurants/wix-restaurants-new/menus/items/items/search-items)

The Reservations API has the following new methods:

* [Bulk Archive Reservations](https://dev.wix.com/docs/sdk/backend-modules/restaurants/wix-restaurants-new/reservations/reservations/bulk-archive-reservations)
* [Bulk Unarchive Reservations](https://dev.wix.com/docs/sdk/backend-modules/restaurants/wix-restaurants-new/reservations/reservations/bulk-unarchive-reservations)

This article provides step-by-step examples for implementing common redirect scenarios using the Redirects API in Wix Headless projects. The article covers:

* [Redirecting to a Wix-managed checkout page](https://dev.wix.com/docs/rest/business-management/headless-authentication/redirects/sample-flows#redirect-to-a-wix-managed-checkout-page)
* [Redirecting to a Wix-managed login page](https://dev.wix.com/docs/rest/business-management/headless-authentication/redirects/sample-flows#redirect-to-a-wix-managed-login-page)
* [Redirecting to an external thank you page after an event checkout](https://dev.wix.com/docs/rest/business-management/headless-authentication/redirects/sample-flows#redirect-to-an-external-thank-you-page-after-an-event-checkout)

New article: Headless Redirects: Sample Flows

The Sender Emails API has new events:

- [Sender Email Created](https://dev.wix.com/docs/sdk/backend-modules/sender-emails/sender-emails/on-sender-email-created)
- [Sender Email Updated](https://dev.wix.com/docs/sdk/backend-modules/sender-emails/sender-emails/on-sender-email-updated)
- [Sender Email Deleted](https://dev.wix.com/docs/sdk/backend-modules/sender-emails/sender-emails/on-sender-email-deleted)

New events: Wix Emails Sender Emails API

The Site Payment Method Types API allows you to get the payment method types potentially available for use on a site. Some examples of payment method types are Mastercard and Visa cards, Apple Pay, Google Pay, PayPal, iDEAL, Klarna, and Pix.

New release: Payments Site Payment Method Types API

The Sender Details API has new events:

- [Sender Details Created](https://dev.wix.com/docs/sdk/backend-modules/sender-details/sender-details/on-sender-details-created)
- [Sender Details Updated](https://dev.wix.com/docs/sdk/backend-modules/sender-details/sender-details/on-sender-details-updated)
- [Sender Details Deleted](https://dev.wix.com/docs/sdk/backend-modules/sender-details/sender-details/on-sender-details-deleted)

New events: Wix Emails Sender Details API

The Sender Emails API has new events:

- [Sender Email Created](https://dev.wix.com/docs/rest/business-management/marketing/sender-emails/sender-email-created)
- [Sender Email Updated](https://dev.wix.com/docs/rest/business-management/marketing/sender-emails/sender-email-updated)
- [Sender Email Deleted](https://dev.wix.com/docs/rest/business-management/marketing/sender-emails/sender-email-deleted)

The Sender Details API has new events:

- [Sender Details Created](https://dev.wix.com/docs/rest/business-management/marketing/sender-details/sender-details-created)
- [Sender Details Updated](https://dev.wix.com/docs/rest/business-management/marketing/sender-details/sender-details-updated)
- [Sender Details Deleted](https://dev.wix.com/docs/rest/business-management/marketing/sender-details/sender-details-deleted)

All calendar-related APIs under Bookings have been deprecated and replaced with the dedicated [Calendar APIs](https://dev.wix.com/docs/rest/business-management/calendar/introduction). 

**Exception:** The Bookings [External Calendar V2 API](https://dev.wix.com/docs/rest/business-solutions/bookings/calendar/external-calendar-v2/introduction) remains active and provides the current solution for external calendar integration.

Learn how to [migrate to the Calendar APIs](https://dev.wix.com/docs/rest/business-solutions/bookings/calendar/how-wix-bookings-uses-the-calendar-apis#migrate-from-deprecated-bookings-calendar-apis).

Deprecated APIs: Bookings Calendar

The Loyalty Accounts List Accounts method has been deprecated and replaced with the [Query Loyalty Accounts](https://dev.wix.com/docs/rest/crm/loyalty-program/accounts/query-loyalty-accounts) method.

Deprecated API method: Loyalty Accounts List Accounts

The Bookings Resources V1 API has been deprecated and replaced with [Bookings Resources V2](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/introduction).
 

Deprecated API: Bookings Resources V1

The Events RSVP V1 API has been deprecated and replaced with [Events RSVP V2](https://dev.wix.com/docs/rest/business-solutions/events/rsvp-v2/introduction).

Deprecated API: Events RSVP V1

The Multilingual [Credit Data API](https://dev.wix.com/docs/rest/business-management/multilingual/machine-translation/credit-data/introduction) is no longer in Developer Preview. This means that it isn't subject to breaking changes and can be used in production.

Fully released: Multilingual Credit Data API

The Multilingual [Credit Data API](https://dev.wix.com/docs/sdk/backend-modules/multilingual/machine-translation/credit-data/introduction) is no longer in Developer Preview. This means that it isn't subject to breaking changes and can be used in production.

The [Blocks AI](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/wix-blocks/get-started/about-the-blocks-ai) is a new tool for building and editing Wix Blocks apps. You can use the AI to:
- Build responsive widgets from scratch.
- Edit existing widgets.
- Generate widget and dashboard code.
- Create and edit CMS collections.

New release: the Blocks AI

The following Bookings APIs and methods are no longer in Developer Preview. This means that they aren't subject to breaking changes and can be used in production:

- [Attendance API](https://dev.wix.com/docs/sdk/backend-modules/bookings/attendance/introduction): All methods fully released.
- [Booking Fees API](https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-fees/introduction): All methods fully released.
- [Booking Policy Snapshots API](https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-policy-snapshots/introduction): All methods fully released.
- [Bookings API](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings/introduction): [Bulk Confirm Or Decline Bookings](https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings/bulk-confirm-or-decline-booking) method fully released.
- [Extended Bookings API](https://dev.wix.com/docs/sdk/backend-modules/bookings/extended-bookings/introduction): [Count Extended Bookings](https://dev.wix.com/docs/sdk/backend-modules/bookings/extended-bookings/count-extended-bookings) method fully released.
- [Resources API](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/introduction): All methods fully released.

Fully released: Selected Bookings APIs and methods

The following Bookings APIs and methods are no longer in Developer Preview. This means that they aren't subject to breaking changes and can be used in production:

- [Attendance API](https://dev.wix.com/docs/rest/business-solutions/bookings/attendance/introduction): All methods fully released.
- [Booking Fees API](https://dev.wix.com/docs/rest/business-solutions/bookings/booking-fees/introduction): All methods fully released.
- [Booking Policy Snapshots API](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policy-snapshots/introduction): All methods fully released.
- [Bookings Reader V2 API](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-reader-v2/introduction): [Count Extended Bookings](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-reader-v2/count-extended-bookings) method fully released.
- [Bookings Writer V2 API](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/introduction): [Bulk Confirm Or Decline Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/bulk-confirm-or-decline-booking) method fully released.
- [Resources V2 API](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/introduction): All methods fully released.

The Imports API has new [Loyalty Import Created](https://dev.wix.com/docs/rest/crm/loyalty-program/imports/loyalty-import-created) event.

New event: Loyalty Imports API

The Tiers API has new events:

- [Tier Created](https://dev.wix.com/docs/rest/crm/loyalty-program/tiers/tier-created)
- [Tier Deleted](https://dev.wix.com/docs/rest/crm/loyalty-program/tiers/tier-deleted)
- [Tier Updated](https://dev.wix.com/docs/rest/crm/loyalty-program/tiers/tier-updated)

New events: Loyalty Tiers API

The Billable Items API enables you to create, update, and organize billable items to streamline a site's billing process and integrate with Wix's business management platform. Billable items are custom billable products and services that can be added to invoices that are sent to customers for payment.

New release: Get Paid Billable Items API

The Read-Only Variants API allows you to query product variants as primary entities with enhanced pagination, filtering, and sorting capabilities.
Unlike the Product API where variants are nested within products, this service focuses exclusively on variants, making it easier to implement variant-focused features.

New release: Stores Read-Only Variants V3 API

The Bookings Resources V2 API has a new method: [Bulk Update Resources](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/bulk-update-resources) (Developer Preview).

New method: Bookings Resources V2 API

The Bookings Resources API has a new method: [Bulk Update Resources](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/bulk-update-resources) (Developer Preview).

New method: Bookings Resources API

The Automations V2 API allows you to manage automations on user sites. Automations help site owners streamline repetitive tasks they would otherwise have to perform manually, such as sending an invoice to a user after they make a purchase, or adding the purchase details to a database.

With the Automations V2 API you can:

- [Create Automation](https://dev.wix.com/docs/sdk/backend-modules/automations/automations-v2/create-automation): Create and configure automations.
- [Query Automations](https://dev.wix.com/docs/sdk/backend-modules/automations/automations-v2/query-automations): Query existing automations.
- [Update Automation](https://dev.wix.com/docs/sdk/backend-modules/automations/automations-v2/update-automation): Modify automation settings, triggers, and actions.
- [Delete Automation](https://dev.wix.com/docs/sdk/backend-modules/automations/automations-v2/delete-automation): Delete an automation.

New release: Automations V2 API

The Data Items API has a new method: [`search()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/search).

New method: Data Items API

The Data Items API has a new method: [Search Data Items](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/search-data-items).

The Wix Site Search API enables developers to search and retrieve specific types of documents from a site, and perform aggregations on the data queried.

New release: Wix Site Search API

The app dashboard now contains a [new page](https://dev.wix.com/app-selector?title=Select+an+App&primaryButtonText=Select+Site&actionUrl=https%3A%2F%2Fdev.wix.com%2Fapps%2F%7BappId%7D%2Fapp-settings) that lets you control your app's installation settings. Learn more about the [app settings page](https://dev.wix.com/docs/build-apps/develop-your-app/app-dashboard-setup/app-settings).

New release: App Settings

We've updated the test flow from the app dashboard, to make testing your apps on a premium site easier than ever. View our [updated article](https://dev.wix.com/docs/build-apps/launch-your-app/app-distribution/test-your-app-on-a-premium-site) to learn more about the new test flow.

Updated feature: Test Your App on a Free Premium Site

The Loyalty Transactions API is no longer in Developer Preview. This means that the API isn't subject to breaking changes and can be used in production.

Fully released: Transactions API

The Dashboard Favorite List API now includes 3 new webhooks that notify you when Wix users do any of the following:

- [Create](https://dev.wix.com/docs/rest/business-management/dashboard/dashboard-favorite-list/favorite-list-created) the dashboard favorite list.
- [Delete](https://dev.wix.com/docs/rest/business-management/dashboard/dashboard-favorite-list/favorite-list-deleted) the dashboard favorite list.
- [Add or delete pages](https://dev.wix.com/docs/rest/business-management/dashboard/dashboard-favorite-list/favorite-list-updated) from the dashboard favorite list.

New webhooks: Dashboard Favorite List API

If you have a [Partner Billed App](https://dev.wix.com/docs/build-apps/launch-your-app/pricing-and-billing/partner-billed-apps-reporting) (that charges users outside of the Wix billing system), report billing events related to your app to Wix using the External Billing Events API. This is required to obtain approval for any Partner Billed App.

If your app uses the Wix billing system to charge users, you don't need to implement this API.

New release: External Billing Events API

The new [Wix MCP](https://dev.wix.com/docs/sdk/articles/use-the-wix-mcp/about-the-wix-mcp) can help you speed up your headless development by extracting important information from the docs and even writing code for you. Check out our [sample prompts for Headless](https://dev.wix.com/docs/go-headless/get-started/about-headless/wix-mcp-sample-prompts-for-headless) to get some ideas about how to leverage the MCP in your own project.

New article: MCP sample prompts for Wix Headless

The Refunds API allows you to work with refunds for charges processed by Wix.

With the Refunds API, your app can:

- Create a refund.
- Get and query existing refunds.

New release: Payments Refunds API

The new [Locales API](https://dev.wix.com/docs/sdk/backend-modules/multilingual/locales/locales/introduction) allows you to create and manage the different locales on a site, making it easy to support multiple languages and regions. 

With the Locales API, you can:
- Create, update, and delete locales for a site.
- Retrieve and query locales.
- Change a site's primary locale.
- Retrieve a list of locales supported by Wix.

The new [Locale Settings API](https://dev.wix.com/docs/sdk/backend-modules/multilingual/locales/locale-settings/introduction) allows you to manage the general locale behavior for a site. 

With the Locale Settings API, you can:
- Retrieve locale settings.
- Enable or disable multilingual support. 
- Set the site's default URL structure for secondary languages. 
- Enable automatic locale redirection based on the visitor's browser settings.

New release: Multilingual Locales APIs

Wix Restaurants (New) now enables the management of online orders and menus across multiple restaurant locations. To facilitate this, entities in online orders and menus services are now linked to specific business locations. For more information, see [About Business Locations](https://dev.wix.com/docs/sdk/backend-modules/restaurants/wix-restaurants-new/about-business-locations).

New Feature: Business locations for Wix Restaurants (New)

The Operation Groups API allows you to manage a set of operations across all of a restaurant's locations. An [operation](https://dev.wix.com/docs/sdk/backend-modules/restaurants/wix-restaurants-new/online-orders/operations/introduction) is a distinct service provided at a single restaurant location. For example, the catering service provided at a restaurant's California location.

With the Operation Groups API, you can:

- Create, retrieve, update, and delete individual or multiple operation groups.
- Manage [tags](https://dev.wix.com/docs/sdk/backend-modules/tags/tags/introduction) for individual or multiple operation groups.

New release: Wix Restaurants Operation Groups

The new [Locales API](https://dev.wix.com/docs/rest/business-management/multilingual/locales/locales/introduction) allows you to create and manage the different locales on a site, making it easy to support multiple languages and regions.

With the Locales API, you can:

- Create, update, and delete locales for a site.
- Retrieve and query locales.
- Change a site's primary locale.
- Retrieve a list of locales supported by Wix.

The new [Locale Settings API](https://dev.wix.com/docs/rest/business-management/multilingual/locales/locale-settings/introduction) allows you to manage the general locale behavior for a site.

With the Locale Settings API, you can:

- Retrieve locale settings.
- Enable or disable multilingual support.
- Set the site's default URL structure for secondary languages.
- Enable automatic locale redirection based on the visitor's browser settings.

Wix Restaurants (New) now enables the management of online orders and menus across multiple restaurant locations. To facilitate this, entities in online orders and menus services are now linked to specific business locations. For more information, see [About Business Locations](https://dev.wix.com/docs/rest/business-solutions/restaurants/wix-restaurants-new/about-business-locations).

New feature: Business locations for Wix Restaurants (New)

The Operation Groups API allows you to manage a set of operations across all of a restaurant's locations. An [operation](https://dev.wix.com/docs/rest/business-solutions/restaurants/wix-restaurants-new/online-orders/operations/introduction) is a distinct service provided at a single restaurant location. For example, the catering service provided at a restaurant's California location.

With the Operation Groups API, you can:

- Create, retrieve, update, and delete individual or multiple operation groups.
- Manage [tags](https://dev.wix.com/docs/rest/business-management/tags/introduction) for individual or multiple operation groups.

The Product Restrictions service plugin allows 3rd-party fulfillment apps such as dropshipping and print-on-demand, to implement editing restrictions on their products.

New release: Wix Stores Product Restrictions Service Plugin

The Categories V2 API allows you to manage the order in which Wix Bookings displays [services](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/introduction) on both a site and its dashboard. Within a category, services are ordered by the service's `sortOrder` field.

With the Categories V2 API, you can:

- Retrieve categories.
- Create, update, and delete categories.
- Change the order in which categories appear.

New release: Bookings Categories V2 API

The Categories V2 API allows you to manage the order in which Wix Bookings displays [services](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/introduction) on both a site and its dashboard. Within a category, services are ordered by the service's `sortOrder` field.

With the Categories V2 API, you can:

- Retrieve categories.
- Create, update, and delete categories.
- Change the order in which categories appear.

The [Data Hooks](https://dev.wix.com/docs/velo/events-service-plugins/data/hooks/wix-data-hooks/introduction) module includes two new hooks:

- [`beforeDistinct()`](https://dev.wix.com/docs/velo/events-service-plugins/data/hooks/wix-data-hooks/before-distinct): Runs before a [distinct query](https://dev.wix.com/docs/velo/apis/wix-data/wix-data-distinct/introduction) operation.
- [`afterDistinct()`](https://dev.wix.com/docs/velo/events-service-plugins/data/hooks/wix-data-hooks/after-distinct): Runs after a [distinct query](https://dev.wix.com/docs/velo/apis/wix-data/wix-data-distinct/introduction) operation.

To refine a distinct query, use [`WixDataDistinct`](https://dev.wix.com/docs/velo/apis/wix-data/wix-data-distinct/introduction) methods in the [`beforeDistinct()`](https://dev.wix.com/docs/velo/events-service-plugins/data/hooks/wix-data-hooks/before-distinct) hook.

New hooks: Data API

The Window Frontend API has a new registerEventListener() method.

New method: Window Frontend registerEventListener

The Calendar APIs are no longer in Developer Preview. This means that the APIs aren't subject to breaking changes and can be used in production.

The Calendar APIs include:

- [Schedules API](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction): Create and manage schedules.
- [Schedule Time Frames API](https://dev.wix.com/docs/rest/business-management/calendar/schedule-time-frames-v3/introduction): Retrieve timing details of a schedule’s first and last event.
- [Events API](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction): Create and manage events.
- [Events View API](https://dev.wix.com/docs/rest/business-management/calendar/event-views-v3/introduction): Receive notifications about schedule updates.
- [Participations API](https://dev.wix.com/docs/rest/business-management/calendar/participations-v3/introduction): Track participation for events and schedules.

Fully released: Calendar APIs

The Automations V2 API allows you to manage automations on user sites. Automations help site owners streamline repetitive tasks they would otherwise have to perform manually, such as sending an invoice to a user after they make a purchase, or adding the purchase details to a database.

With the Automations V2 API you can:

- [Create Automation](https://dev.wix.com/docs/rest/business-management/automations/automations/automations-v2/create-automation): Create and configure automations.
- [Query Automations](https://dev.wix.com/docs/rest/business-management/automations/automations/automations-v2/query-automations): Query existing automations.
- [Update Automation](https://dev.wix.com/docs/rest/business-management/automations/automations/automations-v2/update-automation): Modify automation settings, triggers, and actions.
- [Delete Automation](https://dev.wix.com/docs/rest/business-management/automations/automations/automations-v2/delete-automation): Delete an automation.

The Calendar APIs are no longer in Developer Preview. This means that the APIs aren't subject to breaking changes and can be used in production.

The Calendar APIs include:

- [Schedules API](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction): Create and manage schedules.
- [Schedule Time Frames API](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedule-time-frames/introduction): Retrieve timing details of a schedule’s first and last event.
- [Events API](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction): Create and manage events.
- [Events View API](https://dev.wix.com/docs/sdk/backend-modules/calendar/event-views/introduction): Receive notifications about schedule updates.
- [Participations API](https://dev.wix.com/docs/sdk/backend-modules/calendar/participations/introduction): Track participation for events and schedules.

When developing websites with [collaborators](https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/overview/working-with-collaborators#element-related-considerations), a confirmation prompt now displays when anyone attempts to delete an element and/or its nested elements that are referenced by code. This protects the integrity of your code.

New feature: Confirmation needed before deleting elements referenced by code

The App Permissions API lets you manage the permissions your app requests when users install it on a site.

With the App Permissions API you can:

- [Create App Permission](https://dev.wix.com/docs/sdk/backend-modules/app-management/app-permissions/create-app-permission): Add an permission to your app. Users must grant this permission when they install your app on a site.
- [List App Permissions](https://dev.wix.com/docs/sdk/backend-modules/app-management/app-permissions/list-app-permissions): List the permissions your app asks users to grant when they install it on a site.
- [Delete App Permission](https://dev.wix.com/docs/sdk/backend-modules/app-management/app-permissions/delete-app-permission): Remove a permission your app no longer needs.

New release: App Permissions API

The App Permissions API lets you manage the permissions your app requests when users install it on a site.

With the App Permissions API you can:

- [Create App Permission](https://dev.wix.com/docs/rest/app-management/app-permissions/create-app-permission): Add an permission to your app. Users must grant this permission when they install your app on a site.
- [List App Permissions](https://dev.wix.com/docs/rest/app-management/app-permissions/list-app-permissions): List the permissions your app asks users to grant when they install it on a site.
- [Delete App Permission](https://dev.wix.com/docs/rest/app-management/app-permissions/delete-app-permission): Remove a permission your app no longer needs.

The Contributors API is no longer in Developer Preview. This means that the API isn't subject to breaking changes and can be used in production.

Fully released: Account Level User Management Contributors API

The Wix Accounts API is no longer in Developer Preview. This means that the API isn't subject to breaking changes and can be used in production.

Fully released: Account Level User Management Accounts API

The Wix Site Invites API is no longer in Developer Preview. This means that the API isn't subject to breaking changes and can be used in production.

Fully released: Account Level User Management Site Invites API

The Wix Account Invites API is no longer in Developer Preview. This means that the API isn't subject to breaking changes and can be used in production.

Fully released: Account Level User Management Account Invites API

The Users API is no longer in Developer Preview. This means that the API isn't subject to breaking changes and can be used in production.

Fully released: Account Level User Management Users API

Fully released: Account Level Users API

Fully released: Account Level Contributors API

The Reviews API has the following new methods:

- [Bulk Create Reviews](https://dev.wix.com/docs/rest/crm/community/reviews/reviews/bulk-create-review)
- [Bulk Delete Reviews](https://dev.wix.com/docs/rest/crm/community/reviews/reviews/bulk-delete-reviews)
- [Update Moderation Status](https://dev.wix.com/docs/rest/crm/community/reviews/reviews/update-moderation-status)
- [Bulk Update Moderation Status](https://dev.wix.com/docs/rest/crm/community/reviews/reviews/bulk-update-moderation-status)

New methods: Reviews API

Fully released: Account Level Account Invites API

The Reviews API has the following new methods:

- [Bulk Create Reviews](https://dev.wix.com/docs/sdk/backend-modules/reviews/reviews/bulk-create-review)
- [Bulk Delete Reviews](https://dev.wix.com/docs/sdk/backend-modules/reviews/reviews/bulk-delete-reviews)
- [Update Moderation Status](https://dev.wix.com/docs/sdk/backend-modules/reviews/reviews/update-moderation-status)
- [Bulk Update Moderation Status](https://dev.wix.com/docs/sdk/backend-modules/reviews/reviews/bulk-update-moderation-status)

Fully released: Account Level Site Invites API

Fully released: Account Level Accounts API

The Draft Orders API acts as a complementary service to the [Orders API](https://dev.wix.com/docs/sdk/backend-modules/ecom/orders/introduction).
A draft order is a temporary version of a regular order, allowing you to make multiple fine-tuned modifications to line items, discounts, fees, shipping, and more.

New release: eCommerce Draft Orders API

The [App Instances API](https://dev.wix.com/docs/sdk/backend-modules/app-management/app-instances/introduction) now includes 3 new webhooks that notify you when Wix users do any of the following:

- Complete a free trial and [move to a paid version](https://dev.wix.com/docs/sdk/backend-modules/app-management/app-instances/on-app-instance-plan-converted-to-paid) of your app.
- [Turn on auto-renewal](https://dev.wix.com/docs/sdk/backend-modules/app-management/app-instances/on-app-instance-plan-reactivated) for a paid plan of your app.
- [Transfer](https://dev.wix.com/docs/sdk/backend-modules/app-management/app-instances/on-app-instance-plan-transferred) a plan from one Wix account to another.

New release: Paid Plans Webhooks

The Draft Orders API acts as a complementary service to the [Orders API](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/orders/introduction).
A draft order is a temporary version of a regular order, allowing you to make multiple fine-tuned modifications to line items, discounts, fees, shipping, and more.

The [App Instance API](https://dev.wix.com/docs/rest/app-management/app-instance/introduction) now includes 3 new webhooks that notify you when Wix users do any of the following:

- Complete a free trial and [move to a paid version](https://dev.wix.com/docs/rest/app-management/app-instance/plan-converted-to-paid) of your app.
- [Turn on auto-renewal](https://dev.wix.com/docs/rest/app-management/app-instance/plan-reactivated) for a paid plan of your app.
- [Transfer](https://dev.wix.com/docs/rest/app-management/app-instance/plan-transferred) a plan from one Wix account to another.

New webhooks: Wix App Instance API

Learn how to [write unit tests for a Wix CLI application](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/wix-cli/app-development/write-unit-tests-for-a-wix-cli-application).

New article: Write Unit Tests for a Wix CLI Application

The Benefit Programs API enables you to create and manage benefit programs. Benefit programs allow you to issue credits to visitors which can be exchanged for rewards, products, or services.

New release: Benefit Programs API

This [new tutorial](https://dev.wix.com/docs/build-apps/get-started/tutorials/tutorial-create-a-coffee-catalog-with-blocks) uses nested repeaters and multiple dashboard pages to create a catalog of products.

New tutorial: Create a Coffee Catalog with Blocks

The Text Effects element is a decorative text element with which you can display text with styles, colors, fonts, and graphic effects, such as shadows, outlines, and gradients.

This element is only available in Wix Studio and is not yet available to all users.

New API: $w TextEffects element API

You can now [invite collaborators](https://dev.wix.com/docs/go-headless/get-started/setup/general-setup/invite-collaborators) to your project. Collaborators can view and manage your headless settings, including creating and connecting new headless clients.

New feature: Invite collaborators

Several SDK modules now include dashboard page builder methods. These methods provide the [destination object](https://dev.wix.com/docs/sdk/host-modules/dashboard/navigate#destination-object) for navigating to specific dashboard pages.

Builder methods are available for:

- [`@wix/ecom`](https://dev.wix.com/docs/sdk/backend-modules/ecom/extensions/dashboard-pages/delivery-profile) Version 1.0.1117
- [`@wix/bookings`](https://dev.wix.com/docs/sdk/backend-modules/bookings/extensions/dashboard-pages/export-booking-data) Version 1.0.784
- [`@wix/blog`](https://dev.wix.com/docs/sdk/backend-modules/blog/extensions/dashboard-pages/blog-analytics) Version 1.0.410

New release: Dashboard page builder methods

This [new tutorial](https://dev.wix.com/docs/build-apps/get-started/tutorials/tutorial-create-a-product-widget-with-blocks-cli) uses the Blocks-CLI Integration to build a product widget that displays product details with the `@wix/stores` SDK module.

New tutorial: Create a Product Widget with the Blocks-CLI integration

# About Products

The Products API allows you to create and manage a store's products. 

With the products API you can:
- [Create](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/create-product) and [Bulk Create Products](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/bulk-create-products)
- [Update](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/update-product) and [Bulk Update Products](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/bulk-update-products)
- [Delete](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/delete-product) and [Bulk Delete Products](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/bulk-delete-products)
- [Get](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/get-product), [Search](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/search-products), [Query](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/query-products), and [Count Products](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/count-products)
- [Bulk Update Variants](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/bulk-update-product-variants-by-filter)
- [Bulk Add](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/bulk-add-products-to-categories-by-filter) and [Bulk Remove Products From Categories](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/bulk-remove-products-from-categories-by-filter)
- And more

## Before you begin
It’s important to note the following points before starting to code:
- The site owner must install the Wix Stores app.

## Sample flows
* [Add and arrange products in category](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/sample-use-cases-and-flows#add-and-arrange-products-in-category)
* [Prepare store for Christmas Sale](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/sample-use-cases-and-flows#prepare-store-for-christmas-sale)
* [Extend product object with app specific fields](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/sample-use-cases-and-flows#extend-product-object-with-app-specific-fields)

# Sample Use Cases and Flows

This article shares a possible use case your app could support, as well as sample flows that could support this use case.
This can be a helpful jumping-off point as you plan your app's implementation.

## Add and arrange products in category

Help merchants to manage their products by using categories. For this we will be using the [Categories API](fallback::https://dev.wix.com/docs/rest/business-management/categories/introduction).

1. Call [Create Category](fallback::https://dev.wix.com/docs/rest/business-management/categories/create-category) and pass `"@wix/stores"` to the `treeReference.appNamespace` field.
2. Save `category.id` from the response. 
3. Call [Bulk Add Items To Category](fallback::https://dev.wix.com/docs/rest/business-management/categories/bulk-add-items-to-category) and pass the `items` you want to add to the category. After products added to category you can rearrange them for example to promote some products to be displayed in the beginning. Note that you can arrange only 100 products, more products can be added but you cannot control arrangement of them. Call [Set Arranged Items](fallback::https://dev.wix.com/docs/rest/business-management/categories/set-arranged-items) endpoint. Pass exactly same params as in step 2 but now `items` must be in same order in which you want to see them.
4. Now you can load all products that belongs to given category and keep their arrangement by calling [Search Products](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/search-products) endpoint of ProductService with next body 

```json
{
  "search": {
    "sort": [
      {
        "selectItemsBy": [
          {
            "directCategoriesInfo.categories.id": "<categoryId>"
          }
        ],
        "fieldName": "directCategoriesInfo.categories.index",
        "order": "ASC"
      }
    ],
    "filter": {
      "directCategoriesInfo.categories": {
        "$matchItems": [
          {
            "id": "<categoryId>"
          }
        ]
      }
    }
  }
}
```
Replace `<categoryId>` with real category id from step 1. Pay attention to `sort.selectItemsBy` parameter where you must pass filter by categoryId, this allows you to sort products by arrangement that you set in CategoriesService on step 3.

## Prepare store for Christmas Sale
Before big sale merchant might want to prepare store by creating a new category for products on sale, adding ribbons to products to catch visitors' attention and of course setting new actual prices and compare at prices. Let's see how to do it step by step.
1. [Add and arrange products in category](fallback::#add-and-arrange-products-in-category). This will allow visitor to filter by this category on storefront category page (if merchant enabled this filter in editor). Also it allows merchant to control which products visitor will see first.
2. Create new ribbon by calling [Create Ribbon](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/ribbons-v3/create-ribbon) endpoint of external RibbonService. Save `ribbon.id` that you received in response.
3. To add ribbon "Sale!" to all products in category call [Bulk Update Products By Filter](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/bulk-update-products-by-filter) endpoint. In `filter` send filter by category id. In `product` send only `ribbon`. So your request will look like:
```json
{
  "filter": {
    "directCategoriesInfo.categories.id": "<categoryId>"
  },
  "product": {
    "ribbon": {
      "id": "<ribbonId>"
    }
  }
}
```
4. Finally, we need to update the actual prices and compare-at prices. To simplify, consider a single product with one variant where the `actualPrice` is set at $100.
5. First we want to set a new `compareAtPrice`, this price will indicate to your client what is the price of the product before the sale. call [Bulk Update Product Variants By Filter](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/bulk-update-product-variants-by-filter) endpoint with variant with desired `compareAtPrice` and `actualPrice`:
```json
{
  "variant": {
    "price": {
      "compareAtPrice": {
        "amount": "100"
      },
      "actualPrice": {
        "amount": "90"
      }
    }
  }
}
```
After this call example product will have `compareAtPrice` 100$ and `actualPrice` 90$.

a) If you want to adjust all actual prices by some specific amount or percentage which depends on original `actualPrice` value call [Bulk Adjust Product Variants By Filter](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/bulk-adjust-product-variants-by-filter). For example if you want to decrease current actual prices by 10% pass next body:
```json
{
    "actualPrice": {
        "percentage": -10
    }
}
```
After this call example product will have `compareAtPrice` 100$ and `actualPrice` 81$.

b) If you want to calculate new `actualPrice` from `compareAtPrice` by applying some discount to it call [Bulk Adjust Product Variants By Filter](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/bulk-adjust-product-variants-by-filter) with `actualPriceFromCompareAtPrice`. For example if you want to set `actualPrice` as 20% discount from `compareAtPrice` pass next body:
```json
{
    "actualPriceFromCompareAtPrice": {
        "percentage": 20
    }
}
```
After this call example product will have `compareAtPrice` 100$ and `actualPrice` 80$.

c) If you want to set exact `actualPrice` same for all variants of all products call [Bulk Update Product Variants By Filter](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/bulk-update-product-variants-by-filter) endpoint with variant with desired `actualPrice`:
```json
{
    "variant": {
        "price": {
            "actualPrice": {
                "amount": "75"
            }
        }
    }
}
```
After this call example product will have `compareAtPrice` 100$ and `actualPrice` 75$.

## Extend product object with app specific fields
The Product object includes predefined fields that cannot be removed or renamed. However, there may be instances where you need to add additional fields to accommodate specific flows or use cases for your application.

For example, consider a real estate app that needs to store information about the total area and the type of unit (such as whether it is an apartment or a house). This can be achieved using the `extendedFields` field of the Product object.

Before proceeding, you may want to review our documentation on data extensions or schema plugins [here](fallback::https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions#extended-fields).
1. Follow this [guide](fallback::https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/extend-an-existing-object) to create an extension of type "Stores Catalog Product" in the Dev Center. Be sure to note the namespace of your app, as you will need it for the next steps. For this example, let's assume the namespace is `@my-user-name/real-estate-app`.
2. In the JSON Editor, enter the following value:
```json
{
  "type": "object",
  "properties": {
    "unitType": {
      "type": "string",
      "maxLength": 50,
      "x-wix-permissions": {
        "read": [
          "owning-app",
          "users"
        ],
        "write": [
          "owning-app",
          "users"
        ]
      }
    },
    "areaInSqm": {
      "type": "integer",
      "minimum": 15,
      "x-wix-permissions": {
        "read": [
          "owning-app",
          "users"
        ],
        "write": [
          "owning-app",
          "users"
        ]
      }
    }
  }
}
```
This defines two fields: `areaInSqm`, which includes minimum value validation, and `unitType`, which includes maximum length validation. Both fields can be read and written by your app as well as by users, such as the site owner.
3. Save your extension. Please note that, according to this [guide](fallback::https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/extend-an-existing-object), you must have your app approved before you can proceed with testing.
4. Once your app is approved, you can click "Test Your App" and select the site where you want to install it. Be sure to grant the app permissions to read and write to the stores catalog.
5. You can now create a product with extended fields by calling the [Create Product](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/create-product) endpoint or update an existing product by calling the [Update Product](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/update-product) endpoint. In your request, include the `extendedFields` object with your namespace and the relevant field values.
```json
{
  "product": {
    "id": "e0f16062-2f78-457b-ab47-78847e206e49",
    "revision": 1,
    "name": "Luxury apartment in the city center",
    "extendedFields": {
      "namespaces": {
        "@my-user-name/real-estate-app": {
          "unitType": "apartment",
          "areaInSqm": 120
        }
      }
    }
  }
}
```
Alternatively, you can update a product's extended fields without passing a revision by using the [Update Extended Fields](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/update-extended-fields) endpoint.
6. When you call the [Get Product](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/get-product) endpoint, the response will include the `extendedFields` object with your namespace.

# Stores Products: Supported Filters and Sorting


The following table shows field support for filters and sorting for the `SearchProducts` endpoint :

| Field                                                    | Supported Filters                                                      | Sortable |
|----------------------------------------------------------|------------------------------------------------------------------------|----------|
| `id`                                                     | `$eq`, `$ne`, `$exists`, `$in`, `$startsWith`                          |          |
| `handle`                                                 | `$eq`, `$ne`, `$exists`, `$in`, `$startsWith`                          |          |
| `slug`                                                   | `$eq`, `$ne`, `$exists`, `$in`, `$startsWith`                          |          |
| `directCategoriesInfo.categories`                        | `$matchItems`                                                          |          |
| `directCategoriesInfo.categories.id`                     | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith`              |          |
| `allCategoriesInfo.categories`                           | `$matchItems`                                                          |          |
| `allCategoriesInfo.categories.id`                        | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith`              |          |
| `productType`                                            | `$eq`, `$ne`, `$exists`, `$in`                                         |          |
| `inventory.availabilityStatus`                           | `$eq`, `$ne`, `$exists`, `$in`                                         |          |
| `inventory.preorderStatus`                               | `$eq`, `$ne`, `$exists`, `$in`                                         |          |
| `inventory.preorderAvailability`                         | `$eq`, `$ne`, `$exists`, `$in`                                         |          |
| `visible`                                                | `$eq`, `$ne`, `$exists`, `$in`                                         |          |
| `visibleInPos`                                           | `$eq`, `$ne`, `$exists`, `$in`                                         |          |
| `importId`                                               | `$eq`, `$ne`, `$exists`, `$in`, `$startsWith`                          |          |
| `modifiers.id`                                           | `$isEmpty`, `$hasAll`, `$hasSome`                                      |          |
| `modifiers.choicesSettings.choices.choiceId`             | `$isEmpty`, `$hasAll`, `$hasSome`                                      |          |
| `modifiers.choicesSettings.choices.name`                 | `$isEmpty`, `$hasAll`, `$hasSome`                                      |          |
| `modifiers.name`                                         | `$isEmpty`, `$hasAll`, `$hasSome`                                      |          |
| `options.id`                                             | `$isEmpty`, `$hasAll`, `$hasSome`                                      |          |
| `options.choicesSettings.choices.choiceId`               | `$isEmpty`, `$hasAll`, `$hasSome`                                      |          |
| `options.choicesSettings.choices.name`                   | `$isEmpty`, `$hasAll`, `$hasSome`                                      |          |
| `options.name`                                           | `$isEmpty`, `$hasAll`, `$hasSome`                                      |          |
| `flattenOptions`                                         | `$isEmpty`, `$hasAll`, `$hasSome`                                      |          |
| `flattenModifiers`                                       | `$isEmpty`, `$hasAll`, `$hasSome`                                      |          |
| `brand.id`                                               | `$eq`, `$ne`, `$exists`, `$in`, `$startsWith`                          |          |
| `brand.name`                                             | `$eq`, `$ne`, `$exists`, `$in`, `$startsWith`                          |          |
| `ribbon.id`                                              | `$eq`, `$ne`, `$exists`, `$in`, `$startsWith`                          |          |
| `ribbon.name`                                            | `$eq`, `$ne`, `$exists`, `$in`, `$startsWith`                          |          |
| `infoSections.id`                                        | `$isEmpty`, `$hasAll`, `$hasSome`                                      |          |
| `infoSections.uniqueName`                                | `$isEmpty`, `$hasAll`, `$hasSome`                                      |          |
| `taxGroupId`                                             | `$eq`, `$ne`, `$exists`, `$in`, `$startsWith`                          |          |
| `physicalProperties.fulfillerId`                         | `$eq`, `$ne`, `$exists`, `$in`, `$startsWith`                          |          |
| `physicalProperties.shippingGroupId`                     | `$eq`, `$ne`, `$exists`, `$in`, `$startsWith`                          |          |
| `physicalProperties.deliveryProfileId`                   | `$eq`, `$ne`, `$exists`, `$in`, `$startsWith`                          |          |
| `variantsInfo.variants`                                  | `$matchItems`                                                          |          |
| `variantsInfo.variants.visible`                          | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`                             |          |
| `variantsInfo.variants.price.actualPrice.amount`         | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$lt`, `$lte`, `$gt`, `$gte` |          |
| `variantsInfo.variants.price.compareAtPrice.amount`      | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$lt`, `$lte`, `$gt`, `$gte` |          |
| `variantsInfo.variants.choices.optionChoiceIds.optionId` | `$isEmpty`, `$hasAll`, `$hasSome`                                      |          |
| `variantsInfo.variants.choices.optionChoiceIds.choiceId` | `$isEmpty`, `$hasAll`, `$hasSome`                                      |          |
| `variantsInfo.variants.sku`                              | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith`              |          |
| `variantsInfo.variants.barcode`                          | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith`              |          |
| `variantsInfo.variants.physicalProperties.weight`        | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$lt`, `$lte`, `$gt`, `$gte` |          |
| `subscriptionDetails.allowOneTimePurchases`              | `$eq`, `$ne`, `$exists`, `$in`                                         |          |
| `name`                                                   | `$eq`, `$ne`, `$exists`, `$in`, `$startsWith`                          | Sortable |
| `updatedDate`                                            | `$eq`, `$ne`, `$exists`, `$in`, `$lt`, `$lte`, `$gt`, `$gte`             | Sortable |
| `createdDate`                                            | `$eq`, `$ne`, `$exists`, `$in`, `$lt`, `$lte`, `$gt`, `$gte`             | Sortable |
| `numericId`                                              | `$eq`, `$ne`, `$exists`, `$in`, `$lt`, `$lte`, `$gt`, `$gte`             | Sortable |
| `actualPriceRange.minValue.amount`                       | `$eq`, `$ne`, `$exists`, `$in`, `$lt`, `$lte`, `$gt`, `$gte`             | Sortable |
| `actualPriceRange.maxValue.amount`                       | `$eq`, `$ne`, `$exists`, `$in`, `$lt`, `$lte`, `$gt`, `$gte`             | Sortable |
| `compareAtPriceRange.minValue.amount`                    | `$eq`, `$ne`, `$exists`, `$in`, `$lt`, `$lte`, `$gt`, `$gte`             | Sortable |
| `compareAtPriceRange.maxValue.amount`                    | `$eq`, `$ne`, `$exists`, `$in`, `$lt`, `$lte`, `$gt`, `$gte`             | Sortable |
| `physicalProperties.shippingWeightRange.minValue`        | `$eq`, `$ne`, `$exists`, `$in`, `$lt`, `$lte`, `$gt`, `$gte`             | Sortable |
| `physicalProperties.shippingWeightRange.maxValue`        | `$eq`, `$ne`, `$exists`, `$in`, `$lt`, `$lte`, `$gt`, `$gte`             | Sortable |
| `directCategoriesInfo.categories.index`                  | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$lt`, `$lte`, `$gt`, `$gte` | Sortable |
| `allCategoriesInfo.categories.index`                     | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$lt`, `$lte`, `$gt`, `$gte` | Sortable |


The following table shows field support for filters and sorting for the `QueryProducts` endpoint :

| Field         | Supported Filters                                                      | Sortable |
|---------------|------------------------------------------------------------------------|----------|
| `id`          | `$eq`, `$ne`, `$exists`, `$in`, `$startsWith`                          |          |
| `handle`      | `$eq`, `$ne`, `$exists`, `$in`, `$startsWith`                          |          |
| `options.id`  | `$isEmpty`, `$hasAll`, `$hasSome`                                      |          |
| `slug`        | `$eq`, `$ne`, `$exists`, `$in`, `$startsWith`                          | Sortable |
| `createdDate` | `$eq`, `$ne`, `$exists`, `$in`, `$lt`, `$lte`, `$gt`, `$gte`             | Sortable |
| `updatedDate` | `$eq`, `$ne`, `$exists`, `$in`, `$lt`, `$lte`, `$gt`, `$gte`             | Sortable |
| `visible`     | `$eq`, `$ne`, `$exists`, `$in`                                         | Sortable |




__Related content:__
[API Query Language](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 Store Products](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/query-products),
[Search Store Products](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/search-products)