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

It's recommended to use the Wix CLI or self-hosted to create new apps to ensure full compatibility and long-term support.

Blocks apps aren't supported in the new Wix Harmony editor

Get to know our frameworks

Select an app template built on your preferred framework.

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

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

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

App templates

Wix Blocks templates

Wix CLI templates

Self-hosted templates

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

Wix App Templates for Developers

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

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

Browse by:

How to build it step by step:

This template is built with:

Read how this template was built, step by step.

How we built this template

Deployment instructions:

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

2. Copy command

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

1. Complete prerequisites

Get started with Wix CLI

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

Select your hosting service

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

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

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

Add the base URL and give your app a name.

App details

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

Define your environment

Terminal

Related templates

Note

Warning

Your app name will be used as the namespace suffix.

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

# About the Data Extension Schema API

A data extension schema allows you to define and validate the structure of custom fields that can be added to Wix objects. A data extension schema acts as a blueprint, describing the properties, data types, and constraints of custom fields. For example, a data extension schema can describe custom shipping data added to the [Wix eCommerce Checkout object](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::38074d2d-0934-4f0e-a442-db544d43e9cbslug::checkout-object*fallback::https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/checkout-object).

The Data Extension Schema API enables you to: 
- [Retrieve all the data extension schemas](fallback::https://dev.wix.com/docs/rest/business-management/data-extension-schema/list-data-extension-schemas) installed on a specific site.
- [Create](fallback::https://dev.wix.com/docs/rest/business-management/data-extension-schema/create-data-extension-schema) and [update](fallback::https://dev.wix.com/docs/rest/business-management/data-extension-schema/update-data-extension-schema) user-defined schemas for a specific site.  
- [Delete fields](fallback::https://dev.wix.com/docs/api-reference/business-management/data-extension-schema/delete-user-defined-fields) from user-defined schemas.

## Before you begin

- App [schema plugin extensions](fallback::https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions), including their JSON schemas, are created and maintained in the [app dashboard](fallback::https://manage.wix.com/studio/custom-apps). You can use the Data Extension Schema API to retrieve schema plugins. However, the Data Extension Schema API doesn't support creating and updating schema plugins. Learn more about when to use [Schema plugins](fallback::https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/schema-plugin-faq).
- Before creating a data extension schema, check the object to make sure you don’t add fields that already exist. Only use the data extension schema when an object doesn’t have a field to support your data. 

## Supported objects

You can extend the following objects: 

| Object | FQDN | Supports filtering |
|--------|------|-------------------|
| [Products](fallback::https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/products-v3/introduction) | `wix.stores.*.product` | Yes |
| [eCommerce Orders](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::546b2514-6a71-4148-bccf-1fb8d8604792slug::introduction*fallback::https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/introduction) | `wix.ecom.*.order` | No |
| [eCommerce Checkout](fallback::https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/purchase-flow/checkout/checkout/introduction) | `wix.ecom.*.checkout` | No |
| [Bookings](fallback::https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings/bookings-writer-v2/introduction) | `wix.bookings.*.booking` | No |
| [Booking Services](fallback::https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/introduction) | `wix.bookings.services.*.service` | No |

Extended fields behave like native fields. However, not all objects support operations such as filtering. To learn more, see [The JSON Schema](fallback::https://dev.wix.com/docs/api-reference/business-management/data-extension-schema/the-json-schema).

## How extended fields work

Supported objects contain an `extendedFields` property. When you create a data extension schema, you define extended fields that are stored in `extendedFields`. Extended fields can exist at the following levels:

* **Root level:** Extended fields appear directly in the object's `extendedFields` property.
* **Nested in an existing field:** Extended fields appear in the `extendedFields` property of items in an array. For example, each line item in an order has its own `extendedFields` property.

## FQDNs

A [Fully Qualified Domain Name (FQDN)](fallback::https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/platform/about-fqdns) is a unique identifier for a Wix object type. When creating or managing data extension schemas, you use the FQDN to specify which object type to extend.

FQDNs follow this pattern: `wix.<service>.<version>.<object>`

For example:
- `wix.ecom.v1.order` identifies the eCommerce Order object
- `wix.bookings.v2.booking` identifies the Bookings object

Use a wildcard (`*`) in place of the version number:

```
wix.ecom.*.order
```

This ensures your schema remains valid even if Wix releases a new version of the API.


## Namespaces

The `extendedFields` property contains a nested `namespaces` object that keeps extended fields from different sources separate:

- **`_user_fields`**: Contains extended fields from user-defined schemas, created through this API or the site dashboard.
- **App namespaces**: Contains extended fields defined using a [schema plugin extension](fallback::https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions). 

For example, a [Checkout](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::38074d2d-0934-4f0e-a442-db544d43e9cbslug::checkout-object*fallback::https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/checkout-object) object might have extended fields from both sources:

```json
"extendedFields": {
  "namespaces": {
    "_user_fields": {
      "myCustomField": "value"
    },
    "@company/app-name": {
      "appCustomField": "value"
    }
  }
}
```

When reading or writing extended field data, always reference the correct namespace.

## Use cases
- [Retrieve a list of all data extension schemas for the Wix eCommerce Checkout object](fallback::https://dev.wix.com/docs/api-reference/business-management/data-extension-schema/sample-flows#retrieve-a-list-of-all-data-extension-schemas-for-the-wix-ecommerce-checkout-object)
- [Add a field to a user-defined data extension schema](fallback::https://dev.wix.com/docs/api-reference/business-management/data-extension-schema/sample-flows#add-a-field-to-a-user-defined-data-extension-schema-for-the-wix-ecommerce-order-object)
  
## Terminology
- **Data extension schema**: A JSON Schema defining the data structure of the custom fields to add to a Wix object. 
- **Extended fields**: Custom fields defined by a schema added to the `extendedFields` field of an object.
- **User-defined schema**: The schema created when a Wix user creates extended fields for a specific site. This schema uses the `_user_fields` namespace.
- **Schema plugin extension**: Specific functionality that extends a Wix object with custom fields for a specific app. 
- **FQDN**: Fully qualified domain name, a unique identifier for a Wix object. Learn more about [FQDNs](fallback::https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/platform/about-fqdns).
- **Namespace**: A unique identifier for your app or project. Learn more about [namespaces](fallback::https://dev.wix.com/docs/api-reference/business-management/data-extension-schema/introduction). 


@sdk_package_setup

# JSON Schema for the Data Extensions Schema API

When creating or updating a data extension schema, you define the `jsonSchema` property using a subset of [JSON Schema](fallback::https://json-schema.org/). This schema acts as a blueprint, describing the properties, data types, and constraints of the object that appears in the `extendedFields` property of an object.

The JSON Schema has some restrictions and additions specific to Wix, but the general syntax, supported types, and keywords are mostly the same as standard JSON Schema. Wix supports JSON Schema version 2019-09 or higher.

> **Note:** This schema is also used to define [Schema Plugins](fallback::https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions). Certain properties, such as [permissions](fallback::#defining-field-permissions), include app development terminology.

## Example JSON Schema

The following example is a JSON Schema you can provide in the `jsonSchema` field and defines the following custom fields:
*  `firstName`
*  `lastName`
*  `age`

```json
{
  "type": "object",
  "properties":{
    "firstName": {
      "type": "string",
      "description": "The person's first name.",
      "x-wix-permissions": {
        "read": ["apps"],
        "write": ["users"]
      },
      "title":"First Name",
      "maxLength": 20
    },
    "lastName": {
      "type": "string",
      "description": "The person's last name.",
      "x-wix-permissions": {
        "read": ["apps"],
        "write": ["users"]
      },
      "title":"Last Name",
      "maxLength": 20
    },
    "age": {
      "description": "Age in years which must be equal to or greater than zero.",
      "type": "integer",
      "minimum": 0,
      "x-wix-permissions": {
        "read": ["apps"],
        "write": ["users"]
      },
      "title":"Age",
      "maximum": 120,
      "x-wix-filterable": true
    }
  }
}
```

## General restrictions

As with standard JSON Schema, to define your fields, you’ll add them as property keys to the `properties` object. Keep in mind the following restrictions:

* The JSON Schema can't contain more than 256 properties.
* The maximum length of a property key is 64 characters.
* Property keys must start with a letter and can contain only letters, numbers, and underscores.
* The JSON Schema can store a maximum of 10 KB of data per object. This means that each site can store up to 10 KB of data for each extended object.

  For example, if a site extends both the Booking and Checkout objects, it has a total of 20 KB of database storage. It can use up to 10 KB for the Booking object schema and up to 10 KB for the Checkout object schema.

  A schema’s maximum size is calculated based on the field types defined in the schema, including the maximum lengths of all strings and the maximum items of all arrays.

## Schema properties

### Root-level properties

The following table lists the root-level properties.

| Property | Data type | Description |
| ------ |  ------ | ------ |
| `type` | string| _Required_. Top-level key defining the type of `properties`. Must be `"object"`.|
| `properties` | object | _Required_. Top-level object containing the fields defined as key-object pairs. The table below explains the structure of the `properties` object.|

### The `properties` object

The following table lists the keys allowed in each property object.

| Property | Data type | Description |
| ------ |  ------ | ------ |
| `type` | string | _Required_. Second-level key defining a field’s expected data type. Supported values: `"string"`, `"number"`, `"integer"`, `"boolean"`, `"array"`, `"object"`.<br /><br />Defined inside the object value of each property.|
| `x-wix-permissions`| object | _Required_. Defines a field’s read and write permissions. See [Defining field permissions](fallback::#defining-field-permissions) for more information.|
| `x-wix-archived` | boolean | Archives properties. See [Archive schema fields](fallback::#archive-schema-fields) for more information.|
| `x-wix-filterable` | boolean | Allows filtering for properties. See [Filtering schema fields](fallback::#filtering-schema-fields) for more information.|
| `x-wix-pii` | boolean | Allows you to declare a property as [PII](fallback::https://support.wix.com/en/article/about-personally-identifiable-information-pii).|
| `items` | object | Required if type is `"array"`. Omitted for other data types. <br /><br /> Specifies the type of data the array contains. See [array](fallback::#array) for more information.|
| `maxItems`| number | Required if type is `"array"`.<br /><br />Defines the maximum number of items the array can hold. See [array](fallback::#array) for more information.|
| `properties` | object | Required if type is `"object"`. Omitted for other data types. <br /><br />Object containing nested fields. It accepts the same data as the 1st-level `properties` object and may contain strings, numbers, integers, booleans, or nested objects.|
| `format`| string | Applies only to string fields.<br /><br />Defines a specific format for a string field, for example a date or a time. See [string](fallback::#string) for more information.|
| `maxLength` | number | Required if type is `"string"`.<br /><br />Defines the maximum number of characters the field accepts. See [string](fallback::#string) for more information. |
| `minLength` | number | Applies only to string fields.<br /><br />Defines the minimum number of characters the field accepts. See [string](fallback::#string) for more information.|
| `maximum`| number | Applies only to number or integer fields.<br /><br />Defines the maximum value the field accepts. See [number](fallback::#number) and [integer](fallback::#integer) for more information.|
| `minimum`| number | Applies only to number or integer fields.<br /><br />Defines the minimum value the field accepts. See [number](fallback::#number) and [integer](fallback::#integer) for more information.|
| `exclusiveMaximum`| number | Applies only to number or integer fields.<br /><br />Defines the maximum value the field accepts, excluding the defined value. See [number](fallback::#number) and [integer](fallback::#integer) for more information.|
| `exclusiveMinimum`| number | Applies only to number or integer fields.<br /><br />Defines the minimum value the field accepts, excluding the defined value. See [number](fallback::#number) and [integer](fallback::#integer) for more information.|

## Supported types

The `jsonSchema` field supports all the basic [JSON Schema types](fallback::https://json-schema.org/understanding-json-schema/reference/type), with some restrictions. These restrictions (if any) are detailed below for each type.

### `string`

**Size:** Varies. Each character is 1 byte.

**Restrictions:**

* Length: Strings must be between 1 and 10,000 characters long.

**Supported formats:**

The JSON Schema field supports the following format values:

| Format | Maximum length | Description |
| ------ | -------------- | ----------- |
| `color-hex` | 7 | `#` followed by a 6 character code that represents a color. For example, `#1A8CFF`. <br> Learn more about [color hex](fallback::https://www.color-hex.com/). |
| `currency` | 3 | Three-letter currency code in [ISO-4217 alphabetic](fallback::https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. |
| `date-time` | 25 | UTC datetime in `YYYY-MM-DDThh:mm[:ss][.sss]Z` format. |
| `date` | 10 | Date in `YYYY-MM-DD` format. |
| `guid` | 36 | Globally unique identifier. |
| `hostname` | Defined using the `maxLength` keyword. | Host name. For example, `www.example.com`. |
| `language` | 3 | 2-letter language code in [ISO 639-1 alpha-2](fallback::https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. |
| `time` | 14 | Time in `hh:mm[:ss][.sss]` format. |
| `uri` | Defined using the `maxLength` keyword. | Uniform Resource Identifier. For example, `http://foo.bar/?baz=qux#quux`. |
| `email` | 254 | A custom Wix value indicating a valid email address. |
| `phone` | 40 | A custom Wix value indicating a valid phone number. |
| `single-line` | Defined using the `maxLength` keyword. | Indicates a field that can only contain a single line of text. The string must end with a newline character (`\n`). <br> By default, a string field is considered multi-line text. If it is defined as single-line, the format can be removed later. However, if a string is created as multi-line text, the format can't be changed later to single-line, because this is a breaking change.|

### `number`

**Size:** 8 bytes

**Restrictions:**

* Minimum value: -2<sup>53</sup> + 1.
* Maximum value: 2<sup>53</sup> + 1.

### `integer`

**Size:** 4 bytes

**Restrictions:**

* Minimum value: -2<sup>53</sup> + 1.
* Maximum value: 2<sup>53</sup> + 1.

### `object`

**Size:** Varies

**Restrictions:**

* An object must contain a `properties` field that defines its properties.
* The object’s properties must follow the restrictions of the other types listed here.
* There is a maximum of 10 nesting levels for an object.

### `array`

**Size:** An array’s size is determined by the type it contains and its max length. For example, given the following property:

```json
"tags": {
  "items": {
    "type": "integer"
  },
  "maxItems": 20,
  "type": "array",
  "x-wix-permissions": {
    "read": ["users-of-users","users","apps"],
    "write": ["users"]
  }
}
```

The array contains a maximum of 20 integers. Therefore its total size is:

4 bytes/integer × 20 integers = 80 bytes.

Now consider an array of strings:

```json
"hobbies": {
  "items": {
    "type": "string",
    "maxLength": 10
  },
  "maxItems": 10,
  "minItems": 1,
  "type": "array",
  "x-wix-permissions": {
    "read": ["apps"],
    "write": ["apps"]
  }
}
```

The array contains a maximum of 10 strings, each of which can have a maximum length of 10 characters. Since 1 character = 1 byte, we can calculate the array’s total size like this:

(10 characters × 1 byte/character) × 10 = 100 bytes.

**Restrictions:**

* An array must contain an `items` key that defines the type of items in the array.
* The items in the array must follow all the restrictions of the other types listed here.
* An array can contain a maximum of 100 items. The maximum number of items must be defined using the `maxItems` keyword.
* All the items in an array must be the same type.
* Arrays support items of type `string`, `number`, `integer`, `boolean`, and `object`.

### `boolean`

**Size:** 1 byte

**Restrictions:** None

## Supported keywords

The following global JSON Schema keywords are supported:

* [Annotations](fallback::https://json-schema.org/understanding-json-schema/reference/annotations)
* [Enumerated values](fallback::https://json-schema.org/understanding-json-schema/reference/enum)

The following global keywords are not supported:

* `required`
* `$defs`
* `$ref`
* `readOnly`
* `writeOnly`

### Wix-specific keywords

Wix provides a number of keywords that aren't part of standard JSON Schema. You can use these keywords when defining the JSON Schema.

#### `x-wix-pii`

Add this keyword to mark a property as PII. A property marked as PII becomes available in [GDPR](fallback::https://support.wix.com/en/article/preparing-your-wix-site-for-the-gdpr#ensure-your-third-party-apps-are-gdpr-compliant) flows.

Here's an example usage of `x-wix-pii`:

```json
"existingMedicalConditions": {
  "items": {
    "type": "string"
  },
  "maxItems": 50,
  "type": "array",
  "x-wix-pii": {
    "enabled": true
  },
  "x-wix-permissions": {
    "read": ["users"],
    "write": ["users-of-users"]
  }
}
```

The following field types can be marked as PII:

* strings
* numbers/integers
* arrays of strings
* arrays of numbers

The object you're working with must be PII-enabled in order to mark data extension fields as PII. If it's not, setting `x-wix-pii` to `true` will generate an error.

You must mark a field as PII when you create your schema. By default, fields not initially marked as PII are non-PII. You can't change a non-PII field to PII because this is a breaking change. Likewise, you can't change a PII field to non-PII.

If you archive a PII field, any PII data associated with it is deleted.

## Defining field permissions

For each property you add to the JSON Schema, you need to define permissions. These permissions define who can read and write to the field.

The permissions you define in the schema assume that the extended entity allows apps to read and write it. If an entity does not allow apps read and write permission, then no group will be able to read and write to the entity, no matter what permissions are defined.

Supported permission values:

* `owning-app`: The app that defines the extended field.
* `apps`: All apps installed on the same site.
* `users`: Wix users that own the site.
* `users-of-users`: Visitors of sites.

> **Note**: If you enable `users-of-users` permissions for reading or writing an extended field, also enable the `users` permissions. Otherwise, Wix users won't be able to read or write the extended field data created by their site visitors.

To add permissions to a field, include the Wix-specific `x-wix-permissions` keyword in the field object. In the value, include two arrays: one specifying the read permissions, and the second specifying the write permissions.

For example:

```json
"equipmentType": {
  "type": "string",
  "maxLength": 128,
  "x-wix-permissions": {
    "read": ["apps", "users", "users-of-users"],
    "write": ["users", "users-of-users"]
  }
}
```

## Editing the schema

Once you’ve saved the schema, there are limits on how you can edit it. You can only make non-breaking changes to the schema. Examples of non-breaking changes include:

* Adding a new field.
* Adding or removing permissions in an existing field.
* Increasing a field’s max limit (for example, the `maxLength` value in a string field).
* Decreasing a field’s min limit (for example, the value of `minimum` in a number or integer field).
* Removing a field’s min or max limit entirely.
* Changing settings like `title`, `description` and `placeholder`.

Examples of breaking changes are:

* Removing a field.
* Decreasing a field’s max limit.
* Increasing a field’s min limit.
* Adding a max or min limit to a field that didn’t have one before.

### Archive schema fields

You can’t delete fields from your schema, but you can archive them using the `x-wix-archived` keyword. As with permissions, add `x-wix-archived` to the field that you want to archive, and set it to `true`.

For example:

```json
"dateOfBirth": {
  "x-wix-archived": true,
  "type": "string",
  "format": "date",
  "maxLength": 100,
  "x-wix-permissions": {
    "read": ["apps"],
    "write": ["users", "users-of-users"]
  }
}
```

The archived property remains in the database, so you can't reuse its key for another property. Wix filters the archived field during read operations and ignores it during write operations. A field that is archived still takes up the same amount of space in memory and therefore counts towards the 10 KB total your JSON Schema can take up.

All the schema types support archiving. If the archived field has nested fields, the nested fields are also archived. To restore an archived extended field, change the value of `x-wix-archived` to `false` or remove it from the schema.

## Filtering schema fields

You can make a JSON Schema field filterable by adding the `x-wix-filterable` keyword to the field, and setting its value to `true`:

```json
"age": {
  "description": "Age in years which must be equal to or greater than zero.",
  "type": "integer",
  "minimum": 0,
  "x-wix-permissions": {
    "read": ["apps"],
    "write": ["users"]
  },
  "title":"Age",
  "maximum": 120,
  "x-wix-filterable": true
}
```

You can then use the field as a filter in the object's standard API query method. For example, a query object might look like this:

```js
"query": {
  "filter": {
    "extended_fields.namespaces._user_fields.age": {
      "$gt": 12
    }
  },
  "paging": null,
  "sort": []
}
```

> **Note**: Not all entities with extended fields support filtering. Setting a field as filterable on a non-filterable entity causes an error. Learn more about [entities that support filtering](fallback::https://dev.wix.com/docs/api-reference/business-management/data-extension-schema/introduction). 

## Supported operations

Extended fields created using the Data Extension Schema API support the following filter, sort, and [aggregation](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::a6026c51-be14-4ea6-a108-dcbc36b074fa#aggregations-search-object-only*fallback::https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#aggregations-search-object-only) operations:

| Data type | Format | Filters | Sortable | Aggregations |
| ------ |  ------ | ------ | ----- | -------- |
| string | ---- | `$eq`, `$ne`, `$in`, `$nin`, `$startsWith`, `$isEmpty` | YES | `VALUE`, `SCALAR` |
| string | date | `$eq`, `$ne`, `$gt`, `$lt`, `$gte`, `$lte`, `$in`, `$nin`, `$isEmpty` | YES | `VALUE`, `SCALAR`, `RANGE` |
| string | url | `$eq`, `$ne`, `$gt`, `$lt`, `$gte`, `$lte`, `$in`, `$nin`, `$gte`, `$isEmpty` | YES | `VALUE`, `SCALAR` |
| string | email | `$eq`, `$ne`, `$in`, `$nin`, `$gte`, `$isEmpty` | YES | |
| string | phone | `$eq`, `$ne`, `$in`, `$nin`, `$gte`, `$isEmpty` | YES | |
| number | ---- | `$eq`, `$ne`, `$gt`, `$lt`, `$gte`, `$lte`, `$in`, `$nin` | YES | `VALUE`, `SCALAR`, `SCALAR` |
| boolean | ---- | `$eq`, `$ne`, `$isEmpty` | YES | `VALUE`, `SCALAR` |

> **Note**: Arrays of the above types are not sortable, except for arrays of booleans.

You can make a maximum of 10 fields filterable. If you archive a filterable field, it can't be used as a filter and no longer counts towards the 10-field maximum. If you unarchive the field, it remains unfilterable by default. You'll need to manually set it as filterable again using the `x-wix-filterable` keyword.

## JSON validation errors

If your JSON Schema doesn't align with the restrictions detailed above, you receive a validation error. Here are a few common errors and what they mean:

| Error | What it means | Example that can cause this error|
| ----- | ------------- | --------------------------------- |
| `MANDATORY_FIELD_MISSING` | A mandatory keyword is missing | A string field is missing the `maxLength` keyword.|
| `UNKNOWN_KEYWORD_AT_THIS_LEVEL` | A keyword is in the wrong place. | For example, `x-wix-permissions` is used inside the `items` object of an array field.|
| `EXCEEDED_STORED_DATA_SIZE` | Your schema exceeds the 10 KB limit. | You try to increase `maxLength` in your string fields, but there's not enough storage remaining to support longer strings.|

# Sample Flows

This article shares some possible use cases you could support, as well as an example flow that could support each use case. 
You're certainly not limited to these use cases, but they can be a helpful jumping off point as you plan your implementation.

## Retrieve a list of all data extension schemas for the Wix eCommerce Checkout object 
If your functionality requires access to fields that have been added to an object, you might want to retrieve all of the schemas at once. For example, displaying the returned fields to site visitors. 

1. Collect the FQDN of the relevant Wix API service object that [supports schema plugin extensions](fallback::https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions#see-also). FQDNs are also returned as `entityFqdn` in most events. The Wix eCommerce Checkout FQDN is `wix.ecom.*.checkout`.
   > **Note:** Use a wildcard (*) in place of the FQDN's version number to ensure your code will continue to work when Wix updates the service object to a newer version.
2. Choose the namespaces you would like to retrieve the data for. You can pass multiple namespaces in one call, or leave it blank to retrieve all available namespaces.
3. Call [List Data Extension Schemas](fallback::https://dev.wix.com/docs/rest/business-management/data-extension-schema/list-data-extension-schemas) with the FQDN, namespace data, and fields set to `"ARCHIVED"`. This ensures that any archived fields are returned and provides a complete schema.
4. Display the returned data as relevant.


## Add a field to a user-defined data extension schema for the Wix eCommerce Order object
Display a site-specific field, such as alcohol by volume (ABV) for whiskey orders, alongside fields from Wix eCommerce Orders, to site visitors.

1.  Collect the FQDN of the relevant Wix API object that [supports schema plugin extensions](fallback::https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions#see-also). FQDNs are also returned as `entityFqdn` in most events. The Wix eCommerce Order FQDN is `wix.ecom.*.order`.   
    > **Note:** Use a wildcard (*) in place of the FQDN's version number to ensure your code will continue to work when Wix updates the service object to a newer version.
2. Call [List Data Extension Schemas](fallback::https://dev.wix.com/docs/rest/business-management/data-extension-schema/list-data-extension-schemas) with the `wix.ecom.v1.order` FQDN and `_user_fields` namespace to check if a user-defined schema exists.
3. Create or update the `_user_fields` namespace, as relevant:
    + If no `_user_fields` namespace schema exists, call [Create Data Extension Schema](fallback::https://dev.wix.com/docs/rest/business-management/data-extension-schema/create-data-extension-schema) with the `wix.ecom.v1.order` FQDN, the `_user_fields` namespace and the new JSON schema.
    + If a `_user_fields` namespace schema already exists, call [Update Data Extension Schema](fallback::https://dev.wix.com/docs/rest/business-management/data-extension-schema/update-data-extension-schema) with the `wix.ecom.v1.order` FQDN, the `_user_fields` namespace and the updated JSON schema.  Make sure to specify the entire schema, as any field not specified will be deleted.
4. Display the user-defined field as relevant.

> **Note**: Once you've added a user-defined field to the site's schema, you should call the relevant GET call for the target API object - in this case, [Get Order](fallback::https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/orders/get-order) - every time a visitor navigates to your UI to collect and display the user fields.