About the Tax Groups Service Plugin

The Tax Groups service plugin allows you to create and manage default tax groups to categorize products from your app's catalog based on distinct tax treatments. The tax groups you add with this API, by default, will apply to your app's products. Alternatively, you can create and manage tax groups with the Tax Groups API, and manually add tax groups to individual products with Update Product.

With the Tax Groups service plugin integrated into your app, Wix will retrieve the tax group you provide whenever it calls a catalog of products from your app.

The integration is done via an app created in your Wix Studio workspace with the Tax Groups service plugin.

Learn more about implementing a service plugin with Wix.

Use cases

• Make a default tax group for all the products provided by your app.
• Add different tax groups to specific products provided by your app.

Get started

To enable Wix to communicate with your app:

1. Go to Extensions in your app's dashboard.

2. Click + Create Extension in the top right.

3. Find Tax Groups Provider and click + Create.

4. Use the JSON editor to create the extension's configuration file. Configure the parameters by referencing the table below or the Documentation section to the right of the editor. For each parameter, add the parameter name and value in the JSON editor.

   Name	Type	Description
   deploymentUri	string	Base URI of the service plugin implementation. Since no endpoint is calling this path, it may be left blank.
   defaultTaxGroup	string	Name of the default tax group for this app. All products retrieved from this app will be categorized, by default, with this group name. The id for this tax group is the app's ID.
   additionalTaxGroups	object	Additional tax groups to be added to a site's tax settings when the app is installed. Each additionalTaxGroup must include an id and a name.
   componentName	string	A unique name for this component. This is an internal name that will only appear in the app dashboard.

5. Click Test Your App.

Terminology

• Tax group: A group of products that share the same tax treatment. See the Tax Groups API.
• Default tax group: A predefined tax group provided by an app and, by default, automatically assigned to products imported from that app's catalog.
• Additional tax group: A custom tax group provided by an app that can be assigned to specific products in the app's catalog. These tax groups need to be assigned manually to products with Update Product or in the site's dashboard. Once the app is uninstalled, the tax group information will be deleted from the site. An additional tax group can be added as an object with id and name fields.