About the Data Extension Schema API

A data extension schema is the JSON schema within a schema plugin extension that defines extendedFields that are added to a Wix API's service entity. For example, a data extension schema might add custom shipping data to the Wix eCommerce Checkout return.

The Data Extension Schema API enables you to:

• Retrieve all the data extension schemas that you have permission to access on a site.
• Create and update user-defined schemas for a 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 creates their own extended fields. For example, Wix users can add their own fields to the checkout flow in the site's dashboard under Settings > Checkout > Checkout form and editing the checkout form:

Before you begin

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

• This API supports retrieving data extension schemas from multiple namespaces in a single call.
• Data extension schemas are supported by select Wix API service entities. Always check that the service object you would like to extend supports this functionality.
• 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.
• When developing an app, note that:
  • An app's schema plugin extensions, including their JSON schemas, are created and maintained in the app dashboard. This API only supports creating and updating user-defined schemas.
  • You can only retrieve schemas associated with extensions installed on the specific site authenticated in the API call.

Use cases

• Retrieve a list of all data extension schemas for the Wix eCommerce Checkout object.
• Add fields to a user-defined data extension schema.

Terminology

• Data extension schema: A JSON schema defining the fields to be added to a Wix service object.
• FQDN: Fully qualified domain name, a unique identifier for a Wix service object.
• 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 service object with custom fields, nested within the object called extendedFields.
• User-defined schema: The schema created when a Wix user creates extended fields. This schema is created with the namespace: _user_fields.