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