About the Data Extension Schema API

A data extension schema is a powerful tool that allows you to define and validate the structure of additional custom fields that can be dynamically added to Wix API objects. This schema acts as a blueprint, describing the properties, data types, and constraints for these custom extendedFields fields, based on a JSON schema as part of the schema plugin extension. For example, a data extension schema can describe custom shipping data added to the Wix eCommerce Checkout object.

The Data Extension Schema API enables you to:

• Retrieve all the data extension schemas that are installed on a specific site.
• Create and update user-defined schemas for a specific site.

Learn more about reading and writing schema plugin fields

User-defined data extension schemas

A user-defined data extension schema is created when a Wix user (site owner or collaborator) creates their own extended fields. This schema is saved under a dedicated _user_fields namespace. For example, Wix users can add their own fields to the checkout flow in the site's dashboard under Settings > Checkout > Checkout form when they edit the checkout form:

The resulting user-defined data extension is saved within the _user_fields namespace.

Before you begin

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

• App schema plugin extensions, including their JSON schemas, are created and maintained in your app dashboard. This API only supports creating and updating user-defined schemas.
• Schema plugin extensions are supported by select Wix API objects. Always check that the object you would like to extend includes a property named extendedFields.
• This API supports retrieving data extension schemas from multiple namespaces in a single call.
• You can only retrieve schemas associated with extensions installed on the specific site authenticated in the API call.
• Namespace name limitations:
  • Can't include "Wix".
  • Only lowercase letters, numbers, hyphens and underscores are supported.
  • Max length: 164 characters.
  • Once set, namespace names can't be changed.

Use cases

• Retrieve a list of all data extension schemas, for the Wix eCommerce Checkout object
• 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 that can be added to a Wix object.
• FQDN: Fully qualified domain name, a unique identifier for a Wix service object. Learn more about FQDNs.
• Namespace: A unique identifier for your app or project. Expected format is @myCompany/myAppName. See limitations in the Before you begin section above.
• Schema plugin extension: Specific functionality that extends a Wix object with custom fields, nested within the object called extendedFields.
• User-defined schema: The schema created when a Wix user creates their own extended fields. This schema is created with the namespace: _user_fields. This namespace is predefined and consistent for all sites.