Sample Flows
This article presents use cases your app could support, as well as sample flows that could support each use cases. You aren't limited to these exact flows, but they can be a helpful jumping off point as you plan your app's integration.
Make a default tax group.
You can add a tax group that automatically assigns to all of the products provided by your app. For example, if you are a tips app and want to make a default category for all of the tips your app returns to a site, you can follow these steps:
- Configure the SPI with a
defaultTaxGroup
called"Tips"
- When a site owner installs your app, all of the items your app returns will already be categorized with the
"Tips"
tax group. - To test your app, call List Default Tax Groups on a site that has your app installed.
Add different tax groups.
You can add additional tax groups that can be assigned to only specific products provided by your app, but not to all of them. For example, if your app returns a catalog that includes digital products and you want to offer a tax group to categorize digital products, you can follow these steps:
- Configure the SPI with an object in
additionalTaxGroups
called"Digital"
. - When a site owner installs your app, they will have the option to assign this tax group to specific products provided by your app.
- When a site owner uninstalls your app, the tax group will no longer be available to the site.