<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 Wix Holiday Sale will run from October 20, 2025, through January 2, 2026.

This seasonal promotion is designed to help you grow your user base and increase your app’s visibility by enabling discounts on your app’s plans. The sale will be promoted across Wix, resulting in high traffic and exposure for participating apps.

New feature: App Market Holiday Sale promotion

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

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

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

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

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

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 [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 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

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

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

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 the Translation Schema API

The Translation Schema API allows you to manage the schema for translating site content. Define the structure and fields of your app's translatable content to ensure consistency and accuracy across different locales. You only need to do this setup once per entity, providing a foundation for all future translations.

You can create schemas for each entity of your app. For example, if you are developing a food delivery app, you may want to create two schemas, one for a menu and another for orders.

With the Translation Schema API, your app can:

+ Create, update, and delete a translation schema. 
+ Get an existing translation schema by ID or key. 
+ Query your app's schemas. 
+ List all schemas associated with a site.

## Validations

You can also set validations for fields in the schema. For example, in the schema below, the title field has a `minLength` of 1, meaning the smallest valid text value for that field must be at least one character long. If validations are defined in the schema, the corresponding content is constrained to those validations. If you add invalid content you'll get a validation error. 

```json
  "schema": {
    "key": {
      "entityType": "Menu",
      "scope": "GLOBAL"
    },
    "fields": {
      "menu-title": {
        "type": "SHORT_TEXT",
        "displayName": "Menu Title",
        "minLength": 1,
        "maxLength": 54,
        "hidden": false,
        "displayOnly": false
      }
    }
  }
```

## Before you begin

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

+ There are no private schemas. All of a site's schemas can be retrieved by calling [`listSiteSchemas()`](fallback::https://dev.wix.com/docs/sdk/backend-modules/multilingual/translation/translation-schema/list-site-schemas).
+ You can only use this API on sites where the Wix user has installed the [Wix Multilingual app](fallback::https://www.wix.com/app-market/wix-multilingual?searchLocation=home).

## Use cases

+ [Update a global schema](fallback::https://dev.wix.com/docs/sdk/backend-modules/multilingual/translation/translation-schema/sample-flows#update-a-global-schema).
+ [Create a site schema based on an existing global schema](fallback::https://dev.wix.com/docs/sdk/backend-modules/multilingual/translation/translation-schema/sample-flows#create-a-site-schema-based-on-an-existing-global-schema).


## Terminology

+ **Scope:**  A schema can have one of two scopes:
  + **Site:** A custom schema for a specific site. 
  + **Global:** A global schema for all sites.
  
  
  You can update both site and global schemas, as well as change a site schema to global or vice versa. However, if you need to create a site-specific schema based on an existing global one, create a new schema with a site scope and manually copy the specifications from the existing global one.

+ **Schema field:** This defines the structure and validation rules for a field within a translation schema. It specifies the type of data (such as text or image) and constraints (such as minimum or maximum length) for each field in the schema. The `SchemaField` ensures that any content added conforms to the defined format.

+ **Fields:** A list of fields for the translation schema. The `fields` property uses a string to map to a `SchemaField` (`Map<string, SchemaField>`). The string serves as a key, which you'll need to access each field in the schema and when adding translation content.

@package_metadata:@wix/multilingual

To use the TranslationSchemas API, install the `@wix/multilingual` package.

#### Install the package

Follow the installation instructions for your development environment.

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

#### Import the package

To import the package in your code:

```js
import { translationSchemas } from '@wix/multilingual'
```

# Sample Use Cases and Flows

This article presents possible use cases and corresponding sample flows that your app can support. It provides a useful starting point as you plan your app's implementation.

## Update a global schema 

Suppose you're developing an app that provides promotional campaigns for stores. Your app integrates with Wix Multilingual to allow Wix users to translate promotions for customers. You've already used the [`createSchema()`](fallback::https://dev.wix.com/docs/sdk/backend-modules/multilingual/translation/translation-schema/create-schema) method to create a `GLOBAL` schema for all sites. Your schema includes a `promotionDetails` field that allows stores to provide the fine details of the promotion to the customer. Initially, this field is limited to 256 characters. Due to a recent update in your app, this field now supports up to 1024 characters. You need to update your app's schema to reflect this change:

1. Call [`updateSchema()`](fallback::https://dev.wix.com/docs/sdk/backend-modules/multilingual/translation/translation-schema/update-schema) with the `promotionDetails` field, allowing up to 1024 characters.

2. Site owners can now provide content for the `promotionDetails` field with up to 1024 characters in length.

<blockquote class="important">
  <strong>Important:</strong>
    
When updating a schema with a `GLOBAL` scope, be aware that this change will apply to all sites using this schema. If you need to update a field for only one specific store, consider creating a schema with a `SITE` scope instead, as explained in the sample flow below.
</blockquote>


## Create a site schema based on an existing global schema

Suppose you're an app developer providing delivery services for restaurants. Your app integrates with Wix Multilingual to allow Wix users to translate delivery information. You've already used the [`createSchema()`](fallback::https://dev.wix.com/docs/sdk/backend-modules/multilingual/translation/translation-schema/create-schema) method to create a `GLOBAL` schema for all sites. 

Here's an example schema object: 

```json
{
  "schema": {
    "id": "12345678-90ab-cdef-1234-567890abcdef",
    "revision": 2,
    "createdDate": "2024-08-19T12\:34\:56.789Z",
    "updatedDate": "2024-08-19T12\:34\:56.789Z",
    "key": {
      "appId": "4ad2dfe1-a943-45a8-94ac-f1dd8b78821b",
      "entityType": "restaurant-delivery-service",
      "scope": "GLOBAL"
    },
    "fields": {
      "delivery_instructions": {
        "id": "delivery_instructions",
        "type": "LONG_TEXT",
        "displayName": "Delivery Instructions",
        "minLength": 0,
        "maxLength": 512,
        "hidden": false,
        "displayOnly": false
      },
      "courier_tip": {
        "id": "courier_tip_currency",
        "type": "SHORT_TEXT",
        "displayName": "Tip for Courier",
        "minLength": null,
        "maxLength": 3,
        "hidden": false,
        "displayOnly": false
      },
      "instructions_to_courier": {
        "id": "instructions_to_courier",
        "type": "LONG_TEXT",
        "displayName": "Instructions to Courier",
        "minLength": 1,
        "maxLength": 256,
        "hidden": false,
        "displayOnly": false
      }
    }
  }
}
```

Now let's say the restaurant owner wants to disable the option for customers to tip couriers, and requests that you remove the `courier_tip` field from the schema. Since the schema has a `GLOBAL` scope, updating it would affect all sites using it. To avoid this, you'll create a site-specific schema based on the existing global one as follows:

1. Call createSchema() with a `SITE` scope to create a custom schema for the restaurant's site. Copy all the fields from the existing schema except for the `courier_tip` field. 

2. After creating the site-specific schema, use the [Translation Content API](fallback::https://dev.wix.com/docs/sdk/backend-modules/multilingual/translation/translation-content/introduction) to add your app's default content to the newly created schema. Then, ask the restaurant owner to add their translated content to ensure that the new delivery instructions are available in all supported locales.

To summarize, updating the schema for a specific site removes the `courier_tip` field only for that site. Other sites using the global schema will still have the option to include tips. This prevents unintended changes for all app users.

# Translation Schema API: Errors

This table outlines errors that might be issued when calling the Translation Schema API. The list includes error codes, messages, and troubleshooting guidance to help you resolve these issues.



| <div style="width:200px">HTTP STATUS</div>  | <div style="width:300px">ERROR NAME</div> | <div style="width:200px">DESCRIPTION & TROUBLESHOOTING</div> | 
| :--- | :---| :---| 
| `BAD_REQUEST (400)` | `SchemaRevisionMissingException` | The `schema` entity in the Create or Update methods violates validation rules, such as missing a `revision` value when calling the Update method. Ensure all properties are valid. |
| `BAD_REQUEST (400)` | `SchemaFieldIdsWithProhibitedCharactersException` | Field IDs contain invalid characters. Field ID must contain only `a-zA-Z0-9_-)()`. Remove the invalid characters.  |
| `BAD_REQUEST (400)` | `SchemaFieldIdsWithInvalidBracketsOrderException`  | Field ID can't contain nested parentheses. Ensure field IDs don't include nested parentheses.  |
| `BAD_REQUEST (400)` | `SchemaFieldWithInvalidFormatException` | Invalid field value format. Update the field value to match the required format.|   
| `BAD_REQUEST (400)` | `SchemaFieldMinLengthGreaterEqualToMaxLengthException`  | The field's minimum length is greater than or equal to its maximum length. `minLength` must be smaller than `maxLength`. Ensure the field's minimum length is smaller than its maximum length.   |
| `BAD_REQUEST (400)` | `SchemaFieldUnknownTypeException` | Unknown or undefined field type. Provide a valid field type.  |
| `BAD_REQUEST (400)` | `SchemaPreviewFieldNonExistentIdException` | The preview field doesn't match any field in the schema. Ensure all preview fields reference existing field IDs in the schema.  |
| `BAD_REQUEST (400)` | `SchemaPreviewFieldTypeMismatchException` | Invalid preview field type. Ensure it matches one of the allowed types for this field. |
| `NOT_FOUND (404)` | `EntityNotFoundRuntimeException`  | Schema not found. Verify that the schema ID is correct, and that the schema exists in the system.                  |
| `PERMISSION_DENIED (403)` | `InsufficientPermissionsException`  | Insufficient permissions to perform the action. Ensure your app has the necessary permissions for the requested operation.    |
| `INTERNAL (500)` | `InvalidIdGeneratedException` | The system failed to generate a unique ID for the new schema. Retry the operation.  |


## General Troubleshooting

If you encounter any of these errors:
1. Check that all required fields are present and correctly formatted in your schema definition.
2. Ensure that field IDs, types, and formats comply with the specified validations.
3. Verify that you have the necessary permissions for the requested operation.
4. If the error persists, [contact support](fallback::https://www.wix.com/contact) with the specific error message and details of your operation.

onSchemaUpdated( )