From 9130eaeed318b4262f12cc30f7d37ba56d0a4128 Mon Sep 17 00:00:00 2001 From: Jeremy Paul Date: Mon, 3 Nov 2025 11:17:12 +1100 Subject: [PATCH] Modified section about configuring tax provider settings to streamline it for integrators --- docs/integrations/tax.mdx | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/docs/integrations/tax.mdx b/docs/integrations/tax.mdx index 9f7bd97b3..da79168bb 100644 --- a/docs/integrations/tax.mdx +++ b/docs/integrations/tax.mdx @@ -78,6 +78,10 @@ You must build a BigCommerce [single-click app](/docs/integrations/apps/guide/ty Review our [introduction to building apps](/docs/integrations/apps) guide and use the sidebar to explore topics including: types of apps, managing apps in the dev portal, implementing OAuth, and designing the UI. +We recommend that you provide a login flow within your app iFrame so that you can choose your own authentication method. You can also provide an account registration flow in your iFrame to help merchants create a new tax provider account. Learn more about [designing the app UI](/docs/integrations/apps/guide/ui). An account login flow lets you capture basic authentication credentials from merchants. + +We also recommend that you [establish a connection](#establishing-a-connection) immediately after the merchant installs your app, and you authenticate the merchant's account credentials. Otherwise, your tax provider will not be displayed when merchants navigate to the **Settings > Setup > Tax** page in the control panel. + Make sure to also review our [app development best practices](/docs/integrations/apps/guide/best-practices) for some tips. @@ -98,7 +102,7 @@ When handling the OAuth flow, make sure your app requests read and write permiss ## Establishing a connection -You will be ready to set up a connection with the Tax Provider API when all of the following are true: +You will be ready to set up a connection with the Tax Provider API when all the following are true: * You have [shared your tax provider details](#sharing-provider-details-with-bigcommerce) with BigCommerce through email, and we've replied confirming the tax provider configuration is now ready on all supplied merchant and/or partner test stores. * BigCommerce has shared the `provider_id` of the tax provider configuration with you through email after you [shared your tax provider details](#sharing-provider-details-with-bigcommerce). @@ -106,17 +110,19 @@ You will be ready to set up a connection with the Tax Provider API when all of t * During the [OAuth flow](#installing-the-app), the app requests that the merchant authorize read and write permissions on the Information and Settings API scopes. * During the [OAuth flow](#installing-the-app), you received and stored the `client_id` and `access_token`. -For context, the [Tax Provider API Connection endpoints](/docs/rest-contracts/tax-app-connection) add a layer of security for your app. You can use these basic credentials to authenticate API requests that you receive from stores so that you can reject unauthorized requests. - -An account login flow lets you capture basic authentication credentials from merchants. We recommend that you provide a login flow within your app iFrame so that you can choose your own authentication method. You can also provide an account registration flow in your iFrame to help merchants create a new tax provider account. Learn more about [designing the app UI](/docs/integrations/apps/guide/ui). +To establish a connection, you **must** call the [Update Connection](/docs/rest-contracts/tax-app-connection#update-a-connection) Tax Connection endpoint to establish a connection. -We recommend calling the [Update Connection](/docs/rest-contracts/tax-app-connection#update-a-connection) endpoint immediately after the merchant installs your app and you authenticate the merchant's account credentials. Otherwise, your tax provider will not be displayed when merchants navigate to the **Settings > Setup > Tax** page in the control panel. You will need to include `store_hash`, `provider_id`, and `X-Auth-Token`(`access_token`) values. +The [Tax Provider API Connection endpoints](/docs/rest-contracts/tax-app-connection) add a layer of security for your app. You can use these basic credentials to authenticate API requests that you receive from stores so that you can reject unauthorized requests. ## Configure tax provider settings in the control panel -After you install your app and send basic authentication credentials through the [Update Connection](/docs/rest-contracts/tax-app-connection#update-a-connection) request, merchants can adjust their tax provider settings to activate supported functions on their store. +After you've established a connection, merchants can adjust their tax provider settings to activate supported functions on their store. -Merchants can adjust these settings by navigating to **Settings > Setup > Tax > _TaxProviderName_** in the control panel. +Merchants can adjust these settings by navigating to **Settings > Setup > Tax > _TaxProviderName_** in the control panel. + + + Is your tax provider not visible in the control panel? Ensure that you have sent the update connection request as described in the [establishing a connection](#establishing-a-connection) section. + Before you can provide tax estimates, the merchant must choose which regions they want you to service. The control panel displays a list of countries and subdivisions that you support.