<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">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><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.

The Bookings Time Slots API allows you to retrieve information about when services are available for booking. You can check availability for single-service or multi-service bookings, and get detailed information about each time slot including: whether the slot is bookable, available resources, and any booking restrictions.

New API: Bookings Time Slots

The Bookings Availability Calendar API will be deprecated on Mar 31, 2026. It has been replaced with the Bookings Time Slots API and will be removed on March 31, 2026.

Deprecated API: Bookings Availability Calendar

New methods in the Bookings API enable you to create and manage multi-service bookings. This allows customers to book service packages that include multiple single-service bookings, scheduled sequentially within a single transaction.

New methods: Bookings API

The Data Permissions API manages access control for data collections, allowing you to determine who can perform actions on collection items. 

New Release: Data Permissions API

A new method is available to retrieve a list of up to 100 events that belong to the same event category.

New method: Events V3 API List Events By Category

A new method is available to delete multiple item variants at once. 

New method: Restaurants Item Variants API Bulk Delete Variants

The following Form Submissions API webhooks are no longer in Developer Preview:

- [Submission Created](https://dev.wix.com/docs/api-reference/crm/forms/form-submissions/submission-created)
- [Submission Updated](https://dev.wix.com/docs/api-reference/crm/forms/form-submissions/submission-updated)
- [Submission Deleted](https://dev.wix.com/docs/api-reference/crm/forms/form-submissions/submission-deleted)

This means these webhooks aren't subject to breaking changes and can be used in production.

Fully released: Form Submissions API Webhooks

The Projects API allows you to programmatically create new Wix projects. A project can be a Wix site, headless project, branded app, or Wix Vibe site.

New release: Projects API

New [slots](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/site-extensions/site-plugins/supported-wix-app-pages/about-slots) are now available in the Side Cart for building [site plugins](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/site-extensions/site-plugins/about-site-plugin-extensions). These slots allow you to extend the Side Cart's functionality and customize the shopping experince. 

New release: Wix eCommerce Site Plugin

The Notification Recipients API manages notification recipients for restaurant orders. Notification recipients receive notifications via SMS or phone calls when orders are created at their associated restaurants.

New release: Restaurants Notification Recipients API

The Wix AI Site Chat APIs are no longer in Developer Preview. This means that these APIs are not subject to breaking changes and can be used in production.

Fully released: Wix AI Site Chat APIs

The Interactive Form Sessions API enables you to create AI-powered conversational form experiences where users complete forms through natural language conversations instead of traditional form filling. This transforms static forms into engaging, dynamic interactions that guide users step-by-step through data collection.

New release: Interactive Form Sessions API

The article explains the possible ways of creating Ricos documents. Ricos documents are a form of rich content, and are required by some APIs as input when calling certain methods.

New article: Create a Ricos Document

A new method, Set Visitor Primary Locale, is now available in the Multilingual Locales API. This method allows you to set a default language that site visitors see when they visit the site without specifying a language in the site's URL. 

New method: Multilingual Locales API

A comprehensive guide for consent app creators that explains everything you need to know about managing consent policies on Wix sites.

New article: About Consent Apps

The Form Schemas API allows you to create and manage form schemas. These are structural blueprints that define forms on Wix sites. 

New release: Form Schemas API

REST and SDK backend documentation are now unified in a [single API reference](https://dev.wix.com/docs/api-reference). Toggle between REST and SDK instantly, access aligned content from a single source of truth, and enjoy a smoother, faster documentation and navigation experience.

**Note:** Frontend, core, and host APIs remain in a [separate SDK reference](https://dev.wix.com/api/sdk/introduction).

New release: Unified API Reference

Registers a listener for all events triggered by trackEvent().

New method: Register Event Listener

An overview of Wix-Managed Business Flows that allow headless users to save development time by redirecting site visitors and members to pre-built Wix managed pages for complex processes including:
- Booking pages
- Booking checkout pages
- eCommerce checkouts
- Events checkouts
- Pricing plans checkouts
- Product pages

New article: About Wix Managed Business Flows

The following methods in the Restaurants Operations API have been deprecated and replaced by new methods.
- [CreateOperation](https://dev.wix.com/docs/api-reference/business-solutions/restaurants/wix-restaurants-new/online-orders/operations/create-operation) is replaced by [Create Operation Group](https://dev.wix.com/docs/api-reference/business-solutions/restaurants/wix-restaurants-new/online-orders/operation-groups/create-operation-group).
- [DeleteOperation](https://dev.wix.com/docs/api-reference/business-solutions/restaurants/wix-restaurants-new/online-orders/operations/delete-operation) is replaced by [Delete Operation Group](https://dev.wix.com/docs/api-reference/business-solutions/restaurants/wix-restaurants-new/online-orders/operation-groups/delete-operation-group).


Deprecated methods: Restaurants Operations Create Operation and Delete Operation 

The following Events Orders methods will be deprecated on March 31, 2026:
- [Create Reservation](https://dev.wix.com/docs/api-reference/business-solutions/events/orders/create-reservation) will be replaced by [Create Ticket Reservation](https://dev.wix.com/docs/api-reference/business-solutions/events/ticket-reservations/create-ticket-reservation).
- [Cancel Reservation](https://dev.wix.com/docs/api-reference/business-solutions/events/orders/cancel-reservation) will be replaced by [Cancel Ticket Reservation](https://dev.wix.com/docs/api-reference/business-solutions/events/ticket-reservations/cancel-ticket-reservation).

Deprecated methods: Events Orders Create Reservation and Cancel Reservation

The AI Assistant Training Messages API will be deprecated on Sep 1, 2025. There is no replacement for this API.

Deprecated API: AI Assistant Training Messages

The Ticket Reservations API lets you hold tickets for a specified time period during the checkout process. 

New release: Events Ticket Reservations API

The Ticket Reservations API lets you hold tickets for a specified time period during the checkout process.

The Reports V2 API is no longer in Developer Preview. This means that the API is not subject to breaking changes and can be used in production.

Fully released: Reports V2 API

The [$w Breadcrumbs](https://dev.wix.com/docs/velo/velo-only-apis/$w/breadcrumbs/introduction) element now supports the `ariaLabel` property in its `accessibility` object. This allows you to specify a custom [ARIA label](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-label) for Breadcrumbs, improving accessibility for assistive technology users. 

New param: $w Breadcrumbs accessibility ariaLabel property

The Contacts Notes API allows you to create and manage notes associated with a specific contact on a site. With this new API, Wix users can document interactions, meetings, phone calls, and other important details about their contacts to stay organized and have relevant context for future interactions.

New release: Contacts Notes API

This template is a great starting point for building engaging quiz apps on Wix Blocks. It includes: 
* Nested widgets
* Responsive design presets for mobile and desktop
* A custom panel
* A CMS collection 

New template: Blocks Quiz

Developing your Wix app with the Wix MCP? See our new sample prompts for ideas on how the MCP can help you build your app.

New article: Wix MCP Sample Prompts for App Developers

The aggregatePipeline() method builds and runs an aggregation pipeline on a data collection. 

New method: aggregatePipeline()

The Aggregate Pipeline Data Items method builds and runs an aggregation pipeline on a data collection. 

New method: Aggregate Pipeline Data Items

A new account-level Get Account method is now available in the User Management Accounts API. 

New method: Accounts API Get Account

The Bookings Services API has the following new methods:

* [Query Categories](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/query-categories)
* [Query Locations](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/query-locations)

New methods: Bookings Services

The Bookings Staff Members API is no longer in Developer Preview. This means that the API is not subject to breaking changes and can be used in production.

Fully released: Bookings Staff Members API

The Wix Branches API enables you to create and manage branches within a Wix site. A branch is a version of draft site content that can be edited independently of the published site, that is also known as a test site.

New release: Branches API

The Bookings Services API has the following new methods:

* [Query Categories](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/query-categories)
* [Query Locations](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/query-locations)

The `accessibility` object for supported $w elements now includes these additional properties: 
- `ariaAtomic`
- `ariaBusy`
- `ariaControls`
- `ariaErrorMessage`
- `ariaLive`
- `ariaOwns`
- `ariaRelevant`

Note that not all elements support the `accessibility` object, and support for individual accessibility properties varies by element. For example:
- [TextBox](https://dev.wix.com/docs/velo/velo-only-apis/$w/text-box/accessibility) supports 6 of the 7 new properties. 
- [MultiStateBox](https://dev.wix.com/docs/velo/velo-only-apis/$w/multi-state-box/accessibility) supports a different set of 6 of the new properties. 
 

New param:  Accessibility Properties for $w Elements

The FAQ Categories API allows you to view and manage categories in the Wix FAQ app.
The FAQ Question Entries API lets you manage FAQ questions and answers.
Together, the Categories and Question Entries APIs provide a complete FAQ management system: categories structure the information, while question entries hold the content.

New release: FAQ Categories and Question Entries V2 APIs

You can now publish pricing changes for your published apps instantly, without needing to submit them for review. The previous 30-day notice period for pricing updates is no longer required, making it faster and easier to adjust your app's pricing.

New feature: Build Apps Instant Pricing Updates

The Wix Chat Backend API has been deprecated.

- The `sendMessage()` function has been replaced with the Inbox SDK  [`sendMessage()`](https://dev.wix.com/docs/sdk/backend-modules/inbox/messages/send-message) method.
- Events have been replaced with [Velo Inbox Events](https://dev.wix.com/docs/velo/events-service-plugins/inbox/events/on-message-sent-to-business).

Learn more about how to [migrate from Wix Chat Backend](https://dev.wix.com/docs/velo/apis/wix-chat-backend/migrate-from-wix-chat-backend#apis_wix-chat-backend_migration-steps).

Deprecated API: Wix Chat Backend

The method updates a booking's status to pending.

New method: Mark Booking As Pending

The Bookings Pricing API is no longer in Developer Preview. This means that the API is not subject to breaking changes and can be used in production.

Fully released: Bookings Pricing API

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

The Portfolio APIs include:
- [Collections API](https://dev.wix.com/docs/sdk/backend-modules/portfolio/collections/introduction): All methods fully released.
- [Projects API](https://dev.wix.com/docs/sdk/backend-modules/portfolio/projects/introduction): All methods fully released.
- [Project Items API](https://dev.wix.com/docs/sdk/backend-modules/portfolio/project-items/introduction): All methods fully released.
- [Portfolio Settings API](https://dev.wix.com/docs/sdk/backend-modules/portfolio/portfolio-settings/introduction): All methods fully released.

Fully released: Portfolio APIs

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

The Portfolio APIs include:
- [Collections API](https://dev.wix.com/docs/rest/business-solutions/portfolio/collections/introduction): All methods fully released.
- [Projects API](https://dev.wix.com/docs/rest/business-solutions/portfolio/projects/introduction): All methods fully released.
- [Project Items API](https://dev.wix.com/docs/rest/business-solutions/portfolio/project-items/introduction): All methods fully released.
- [Portfolio Settings API](https://dev.wix.com/docs/rest/business-solutions/portfolio/portfolio-settings/introduction): All methods fully released.

New method: Delete Marketing Tag V2

The SEO Tags API allows you to generate and resolve SEO tags for sites based on site and page specific metadata.

New release: SEO Tags API

Combined the following previously separate topics into a single article to avoid repetition and improve clarity:
- Authentication strategies
- Identities
- Login options

New article: About Authentication

The settings submodule allows the code in an app's frontend extensions to access the active time zone for each interface. Currently limited to dashboard pages in CLI or self-hosted app development.

New release: Essentials Settings API

The Code tab in in [Wix Vibe](https://support.wix.com/en/article/wix-vibe-an-overview) lets you explore your generated project, review extension code, and navigate files with ease. It includes:
* Full file access with jump-to-definition support
* Built-in linter and dark mode
* Floating AI chat for code fixes and explanations

New feature: Wix Vibe Code tab

This article provides a comprehensive guide to choosing between Wix's headless development approaches. The article descibes:

* The different development paths.
* When to use each approach based on project requirements and technical preferences.
* A detailed feature comparison between both development paths.

New article: Headless Development Paths

The Data Movement Jobs API allows you to create and manage jobs to move data to and from a Wix site. Jobs can transfer data items or localized CMS content between data collections, files, or sites.

New release: Data Movement Jobs API

The Operations API has the following new methods:

* [Calculate First Available Time Slot Per Fulfillment Type](https://dev.wix.com/docs/rest/business-solutions/restaurants/wix-restaurants-new/online-orders/operations/calculate-first-available-time-slot-per-fulfillment-type)
* [Calculate First Available Time Slots Per Operation](https://dev.wix.com/docs/rest/business-solutions/restaurants/wix-restaurants-new/online-orders/operations/calculate-first-available-time-slots-per-operation)
* [Calculate First Available Time Slots Per Menu](https://dev.wix.com/docs/rest/business-solutions/restaurants/wix-restaurants-new/online-orders/operations/calculate-first-available-time-slots-per-menu)
* [Calculate Available Time Slots For Date](https://dev.wix.com/docs/rest/business-solutions/restaurants/wix-restaurants-new/online-orders/operations/calculate-available-time-slots-for-date)
* [Calculate Available Dates In Range](https://dev.wix.com/docs/rest/business-solutions/restaurants/wix-restaurants-new/online-orders/operations/calculate-available-dates-in-range)

New methods: Restaurants Operations API

The Operations API has the following new methods:

* [Calculate First Available Time Slot Per Fulfillment Type](https://dev.wix.com/docs/sdk/backend-modules/restaurants/wix-restaurants-new/online-orders/operations/calculate-first-available-time-slot-per-fulfillment-type)
* [Calculate First Available Time Slots Per Operation](https://dev.wix.com/docs/sdk/backend-modules/restaurants/wix-restaurants-new/online-orders/operations/calculate-first-available-time-slots-per-operation)
* [Calculate First Available Time Slots Per Menu](https://dev.wix.com/docs/sdk/backend-modules/restaurants/wix-restaurants-new/online-orders/operations/calculate-first-available-time-slots-per-menu)
* [Calculate Available Time Slots For Date](https://dev.wix.com/docs/sdk/backend-modules/restaurants/wix-restaurants-new/online-orders/operations/calculate-available-time-slots-for-date)
* [Calculate Available Dates In Range](https://dev.wix.com/docs/sdk/backend-modules/restaurants/wix-restaurants-new/online-orders/operations/calculate-available-dates-in-range)

Many APIs in the Wix JavaScript SDK now include Search methods. These methods support both structured and free-text search, along with advanced features such as fuzzy matching, aggregations, and result counting. Learn more about [Search, Query, and List methods](https://dev.wix.com/docs/rest/articles/get-started/search-query-and-list-methods).

The following Search methods have been added to existing APIs:

+ Bookings: [Search Resources](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/search-resources)
+ Bookings: [Search Services](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/search-services)
+ Bookings: [Search Staff members](https://dev.wix.com/docs/sdk/backend-modules/bookings/staff-members/search-staff-members)
+ eCommerce: [Search Orders](https://dev.wix.com/docs/sdk/backend-modules/ecom/orders/search-orders)
+ eCommerce: [Search Abandoned Checkouts](https://dev.wix.com/docs/sdk/backend-modules/ecom/abandoned-checkouts/search-abandoned-checkouts)
+ Events: [Search Rsvps](https://dev.wix.com/docs/sdk/backend-modules/events/rsvp-v2/search-rsvps)
+ Get Paid: [Search Payment Links](https://dev.wix.com/docs/sdk/backend-modules/get-paid/payment-links/payment-links/search-payment-links)
+ Get Paid: [Search Payment Link Payments](https://dev.wix.com/docs/sdk/backend-modules/get-paid/payment-links/payment-link-payments/search-payment-link-payments)
+ Loyalty: [Search Accounts](https://dev.wix.com/docs/sdk/backend-modules/loyalty/accounts/search-accounts)
+ Multilingual: [Search Contents](https://dev.wix.com/docs/sdk/backend-modules/multilingual/translation/translation-content/search-contents)
+ Restaurants: [Search Items](https://dev.wix.com/docs/sdk/backend-modules/restaurants/wix-restaurants-new/menus/items/items/search-items) 
+ Restaurants: [Search Reservations](https://dev.wix.com/docs/sdk/backend-modules/restaurants/wix-restaurants-new/reservations/reservations/search-reservations)
+ Stores: [Search Products](https://dev.wix.com/docs/sdk/backend-modules/stores/catalog-v3/products-v3/search-products)
+ Stores: [Search Inventory Items](https://dev.wix.com/docs/sdk/backend-modules/stores/catalog-v3/inventory-items-v3/search-inventory-items)

New Search methods

We've added a new sample flows article for the Wix Restaurants Menus API, as well as supporting articles that explain how to retrieve and build full menu structures.

New articles: Wix Restaurants Menus Sample Flows

The Item Modifiers API has the following new method:

* [Bulk Delete Modifiers](https://dev.wix.com/docs/rest/business-solutions/restaurants/wix-restaurants-new/menus/items/item-modifiers/bulk-delete-modifiers)

New method: Restaurants Item Modifiers API

The Sections API has the following new method:

* [Duplicate Section](https://dev.wix.com/docs/sdk/backend-modules/restaurants/wix-restaurants-new/menus/sections/duplicate-section)

New method: Restaurants Sections API

The Item Modifiers API has the following new method:

* [Bulk Delete Modifiers](https://dev.wix.com/docs/sdk/backend-modules/restaurants/wix-restaurants-new/menus/items/item-modifiers/bulk-delete-modifiers)

The Verification API allows you to implement secure member registration with a Wix Headless site or app by enabling email verification during authentication flows.

New release: Headless Verification API

New release: Identity Verification API for Headless

The Sections API has the following new method:

* [Duplicate Section](https://dev.wix.com/docs/rest/business-solutions/restaurants/wix-restaurants-new/menus/sections/duplicate-section)

Wix app developers can now integrate Google Analytics to gain insights into user interactions with your Wix App Market app page.

New release: Google Analytics Integration

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 Product Plugin API has 4 new fields:
- `selectedVariantID`: The ID of the selected product variant.
- `selectedChoices`: An object containing all the choices the site visitor picks from the options on the product page.
- `quantity`: The number of product items the site visitor sets on the product page. 
- `customText`: An array of text values entered by the site visitor in custom text fields on the product page.

New fields: Product Plugin API

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

# About the Wix Stores Catalog API

Wix Stores creates a catalog of store owners’ items for purchase and allows store owners to create smaller collections of products by type or theme. A catalog organizes the store’s products and collections and facilitates inventory management. With the Wix Stores Catalog API you can query individual products, collections or the entire catalog, as well as create products and add their media.

Querying the products and collections in the catalog enables you to coordinate a store’s inventory across other sales platforms (e.g., Facebook marketplace), or inventory management tools (e.g., NetSuite, TradeGecko), among other uses.

<blockquote class="important">
  <strong>Catalog V3</strong>

Wix Stores is introducing **Catalog V3**, a new set of APIs for the Wix Stores product catalog, set to roll out in **Q2 2025**.
The new catalog will initially be rolled out to new users only, and over time, Catalog V3 will fully replace Catalog V1.

This upgraded catalog will provide Wix Stores owners with enhanced tools to build more comprehensive
product catalogs and streamline store management.

To remain compatible with all Wix Stores users, your app must be able to support both versions of the catalog:
+ Learn more about how to integrate with the [Catalog V3 APIs](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/introduction).
+ Use the [Catalog Versioning API](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-versioning/introduction) to determine which version of the Wix Stores Catalog a site is using.

</blockquote>

## Terminology
- **The catalog** is a complete list of all the store’s products.
- **Collections** are themed groupings of items for purchase that a store owner can create to organize their products (e.g., Spring 2019, Running shoes, etc.). Products can belong to multiple collections.
- **Options** are property types that customers can select within the specific product - e.g., color and size.
- **Choices** are the available selections within each option - e.g., red and green choices under the Color option.
- **Variants** are combinations of different product options and choices - e.g., a red shirt in size large.
A variant can override the following values from the parent product:
  - Price
  - SKU
  - Weight
  - Inventory

## Error handling
| Status code | Description                                                                                                                         |
|-------------|-------------------------------------------------------------------------------------------------------------------------------------|
| 200         | Success                                                                                                                             |
| 400         | Invalid input (e.g., when the filter format is not valid or when providing invalid options when calling productOptionsAvailability) |
| 401         | Invalid authorization token, or Wix stores is not installed                                                                         |
| 404         | Requested product or collection is not found                                                                                        |
| 500         | Unexpected error                                                                                                                    |

@sdk_package_setup

# Filter and sort

## Query Language

Endpoints that allow querying follow these format [guidelines](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::8158a590-f60c-4606-9fed-16a34e275f3a*fallback::https://dev.wix.com/api/rest/getting-started/api-query-language).

## Query Products

### Fields That Allow Filtering

| Field                     | Operators                                        | Sorting Allowed |
|---------------------------|--------------------------------------------------|-----------------|
| `name`                    | `$eq`,`$ne`,`$hasSome`,`$contains`,`$startsWith` | Allowed         |
| `description`             | `$eq`,`$ne`,`$hasSome`,`$contains`,`$startsWith` |                 |
| `sku`                     | `$eq`,`$ne`,`$hasSome`,`$contains`,`$startsWith` | Allowed         |
| `id`                      | `$eq`,`$ne`,`$hasSome`                           | Allowed         |
| `price`                   | `$eq`,`$ne`,`$hasSome`,`$lt`,`$lte`,`$gt`,`$gte` | Allowed         |
| `numericId`               | `$eq`,`$ne`,`$hasSome`,`$lt`,`$lte`,`$gt`,`$gte` | Allowed         |
| `productType`             | `$eq`,`$ne`,`$hasSome`                           | Allowed         |
| `slug`                    | `$eq`,`$ne`,`$hasSome`,`$contains`,`$startsWith` | Allowed         |
| `collections.id`          | `$eq`,`$ne`,`$hasSome`,`$hasAll`                 |                 |
| `options.\<option name\>` | `$eq`,`$ne`,`$hasSome`,`$hasAll`                 |                 |
| `inventoryStatus`         | `$eq`,`$ne`,`$hasSome`                           |                 |        
| `lastUpdated`             | `$eq`,`$ne`,`$hasSome`,`$lt`,`$lte`,`$gt`,`$gte` | Allowed         |
| `createdDate`             | `$eq`,`$ne`,`$hasSome`,`$lt`,`$lte`,`$gt`,`$gte` | Allowed         |

** Note that "hasSome" is same as the operator "IN" in SQL

### Examples

**Query products where price = 10**

```
curl 'https://www.wixapis.com/stores/v1/products/query' --data-binary '{"query":{"filter":"{\"price\": \"10\"}"}}' -H 'Content-Type: application/json' -H 'Authorization: XXX'
``` 

**Query products, order by price descending**

```
curl 'https://www.wixapis.com/stores/v1/products/query' --data-binary '{"query":{"sort":"[{\"price\": \"desc\"}]"}}' -H 'Content-Type: application/json' -H 'Authorization: XXX'
``` 

**Getting all products for a given collection**

```
curl 'https://www.wixapis.com/stores/v1/products/query' --data-binary '{"query":{"filter":"{\"collections.id\": { \"$hasSome\": [\"your_collection_id_here\"]} }"}}' -H 'Content-Type: application/json' -H 'Authorization: XXX'
```

**Getting multiple products by IDs**

```
curl 'https://www.wixapis.com/stores/v1/products/query' --data-binary '{"query":{"filter":"{\"id\": {\"$hasSome\": [\"YOUR_PRODUCT_ID_HERE\", \"YOUR_PRODUCT_ID_HERE\"]}}"}}' -H 'Content-Type: application/json' -H 'Authorization: XXX'
```

**Getting all products with a specific choice**

```
curl 'https://www.wixapis.com/stores/v1/products/query' --data-binary '{"query":{"filter":"{\"productOptions.size\": \"L\"}}"}}' -H 'Content-Type: application/json' -H 'Authorization: XXX'
```

**Getting all products in a store**

1. Get the first page:
```
curl 'https://www.wixapis.com/stores/v1/products/query' --data-binary '{"query":{"sort":"[{\"numericId\": \"asc\"}]"}}' -H 'Content-Type: application/json' -H 'Authorization: XXX'
``` 

2. Take the numericId of the last returned item and run the following query:
```
curl 'https://www.wixapis.com/stores/v1/products/query' --data-binary '{"query":{"sort":"[{\"numericId\": \"asc\"}]","filter":"{\"numericId\": {\"$gt\": LAST_NUMERIC_ID}}"}}' -H 'Content-Type: application/json' -H 'Authorization: XXX'
```

3. Continue until no more records are returned.

## Query Collections

### Fields That Allow Filtering

| Field | Operators                                        | Sorting Allowed |
|-------|--------------------------------------------------|-----------------|
| name  | `$eq`,`$ne`,`$hasSome`,`$contains`,`$startsWith` | Allowed         |
| id    | `$eq`,`$ne`,`$hasSome`,`$contains`,`$startsWith` | Allowed         |

** Note that "hasSome" is same as the operator "IN" in SQL

### Examples

**Query collections where name = my collection**

```
curl 'https://www.wixapis.com/stores/v1/collections/query' --data-binary '{"query":{"filter":"{\"name\": \"my collection\"}}"}}' -H 'Content-Type: application/json' -H 'Authorization: XXX'
```

# Use Cases

In this example we will query a product variant: 
* The product is a `Shirt`.
* The `Shirt` has 2 **options** - `Size` and `Color`.
* The size option has 3 **choices** - `S`/`M`/`L`.
* The color option has 3 **choices** - `Red`/`Green`/`Blue`.
* The product **variant** `S`+`Red` is out of stock.

**Call [Get Product](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog/get-product) to retrieve product options**

::::tabs
:::REST_TAB
```curl
    curl -X GET \
    'https: //www.wixapis.com/stores/v1/products/91f7ac8b-2baa-289c-aa50-6d64764f35d3' \
    -H 'Authorization: <AUTH>'
   ```
:::
:::SDK_TAB
```js
import { products } from "@wix/stores";

const id = "91f7ac8b-2baa-289c-aa50-6d64764f35d3"

async function getProduct(id) {
  const response = await products.getProduct(id);
}
```
:::
::::

```json
{
  ...
  "productOptions": [
    {
      "optionType": "drop_down",
      "name": "Size",
      "choices": [
        {
          "value": "S",
          "description": "S",
          "inStock": true,
          "visible": true
        },
        {
          "value": "M",
          "description": "M",
          "inStock": true,
          "visible": true
        },
        {
          "value": "L",
          "description": "L",
          "inStock": true,
          "visible": true
        }
      ]
    },
    {
      "optionType": "color",
      "name": "Color",
      "choices": [
        {
          "value": "#FF0000",
          "description": "Red",
          "inStock": true,
          "visible": true
        },
        {
          "value": "#00FF00",
          "description": "Green",
          "inStock": true,
          "visible": true
        },
        {
          "value": "#00000FF",
          "description": "Blue",
          "inStock": true,
          "visible": true
        }
      ]
    }
  ]
}
```

**Call [Get Product Options Availability](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog/get-product-options-availability) to retrieve the `S` size availability**  

Notice in the response that:
- `Red` is out of stock because `S`+`Red` is out of stock.
- `availableForPurchase` is false because both size and color must be given for this product.

::::tabs
:::REST_TAB
```curl
   curl -X POST \
    'https://www.wixapis.com/stores/v1/products/1044e7e4-37d1-0705-c5b3-623baae212fd/productOptionsAvailability' \
    -d '{
          "options": {
            "size": "S"
          }
        }' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: <AUTH>'
   ```
:::
:::SDK_TAB
```js
import { products } from "@wix/stores";

const id = "1044e7e4-37d1-0705-c5b3-623baae212fd"

const options = {
  size = "S"
}

async function getProductOptionsAvailability(id, options) {
  const response = await products.getProductOptionsAvailability(id, options);
}
```
:::
::::

```json
{
  "productOptions": [
    {
      "optionType": "drop_down",
      "name": "Size",
      "choices": [
        {
          "value": "S",
          "description": "S",
          "inStock": true,
          "visible": true
        },
        {
          "value": "M",
          "description": "M",
          "inStock": true,
          "visible": true
        },
        {
          "value": "L",
          "description": "L",
          "inStock": true,
          "visible": true
        }
      ]
    },
    {
      "optionType": "color",
      "name": "Color",
      "choices": [
        {
          "value": "#FF0000",
          "description": "Red",
          "inStock": false,
          "visible": true
        },
        {
          "value": "#00FF00",
          "description": "Green",
          "inStock": true,
          "visible": true
        },
        {
          "value": "#00000FF",
          "description": "Blue",
          "inStock": true,
          "visible": true
        }
      ]
    }
  ],
  "availableForPurchase": false
}
```

**Call [Get Product Options Availability](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog/get-product-options-availability) to retrieve the availability of `S`+`Green`**

Notice in the response that:
- We get the selected variant, with proper values for price, weight, SKU and inventory.
- `availableForPurchase` is true.

::::tabs
:::REST_TAB
```curl
   curl -X POST \
    'https://www.wixapis.com/stores/v1/products/1044e7e4-37d1-0705-c5b3-623baae212fd/productOptionsAvailability' \
    -d '{
          "options": {
            "size": "S",
            "color": "Green"
          }
        }' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: <AUTH>'
   ```
:::
:::SDK_TAB
```js
import { products } from "@wix/stores";

const id = "1044e7e4-37d1-0705-c5b3-623baae212fd"

const options = {
    size = "S"
    color = "Green"
}

async function getProductOptionsAvailability(id, options) {
  const response = await products.getProductOptionsAvailability(id, options);
}
```
:::
::::

```json
{
  "selectedVariant": {
    "price": {
      "currency": "USD",
      "price": 81,
      "discountedPrice": 81,
      "formatted": {
        "price": "$81.00",
        "discountedPrice": "$81.00"
      }
    },
    "weight": 0,
    "sku": "364215376135191",
    "inStock": true,
    "visible": true
  },
  "productOptions": [
    {
      "optionType": "drop_down",
      "name": "Size",
      "choices": [
        {
          "value": "S",
          "description": "S",
          "inStock": true,
          "visible": true
        },
        {
          "value": "M",
          "description": "M",
          "inStock": true,
          "visible": true
        },
        {
          "value": "L",
          "description": "L",
          "inStock": true,
          "visible": true
        }
      ]
    },
    {
      "optionType": "color",
      "name": "Color",
      "choices": [
        {
          "value": "#FF0000",
          "description": "Red",
          "inStock": false,
          "visible": true
        },
        {
          "value": "#00FF00",
          "description": "Green",
          "inStock": true,
          "visible": true
        },
        {
          "value": "#00000FF",
          "description": "Blue",
          "inStock": true,
          "visible": true
        }
      ]
    }
  ],
  "availableForPurchase": true
}
```

Delete Product