Schema Plugins

Wix business solutions define data objects like Booking, Order, Checkout, and Contact, each with its own set of predefined fields. A schema plugin extends a data object with your own custom fields, without modifying Wix predefined fields.

For example, a schema plugin can add an equipment field to the Bookings Service object. After the plugin is installed, the equipment field is part of the Service object, and your app reads and writes it through the regular Bookings APIs.

How schema plugins work

Wix objects that support schema plugins include an extendedFields property. Schema plugins add their custom fields under namespaces inside extendedFields.

A schema plugin can add fields to a top-level object, like adding a warranty field to an Order. It can also add fields to each item inside an array nested within the object, like adding customization fields to each line item within an Order. Both use the same extendedFields mechanism. Here's what an Order with both kinds of extensions might look like:

The custom fields behave like any other field on the object. You read and write them through the object's regular APIs, subject to the permissions declared in the schema plugin.

Schema plugins vs. data collection extensions

Schema plugins extend existing Wix objects. Data collection extensions create new CMS collections.

Use a schema plugin when you need to track a small amount of additional data tied to an existing Wix entity, like a warranty on an order, an equipment list on a booking, or a loyalty tier on a contact. Use a data collection extension when you need a separate collection you manage on your own, like a Submissions collection for a quiz app's results.

Schema plugins across development paths

The development path determines how you register a schema plugin:

• Sites: Extend objects with site-specific custom fields through the Data Extension Schema API, which adds fields under the user_defined namespace.
• Wix-managed headless projects: Don't currently support schema plugins.
• Self-managed headless projects: Don't currently support schema plugins.
• Wix-managed apps: Configure schema plugins through the App Dashboard, regardless of which development framework they use. There's no Wix CLI generate command for schema plugins. See Extend an Existing Object with a Schema Plugin in Build Apps.
• Self-managed apps: Configure schema plugins through the App Dashboard, regardless of which development framework they use. There's no Wix CLI generate command for schema plugins. See Extend an Existing Object with a Schema Plugin in Build Apps.
• Blocks apps: Configure schema plugins through the App Dashboard, regardless of which development framework they use. There's no Wix CLI generate command for schema plugins. See Extend an Existing Object with a Schema Plugin in Build Apps.