Thanks for being patient while we implement your feedback to improve the developer experience.

Tax Provider Connection

Manage the connection between a merchantʼs BigCommerce store and a third party tax provider. For more information, see Tax Provider API Overview.

Get Connection Status

GET /tax/providers/{provider_id}/connection

Request

Retrieve the connection status of the specified tax provider in the context of a store.

Note

  • Requires read permissions on the Information and Settings scope.

Authentication

  • X-Auth-Token in header - required

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string - required

    The MIME type of the response body.

  • provider_id in path - string - required

    The Tax Providerʼs provider_id provided by BigCommerce after the provider shares their provider details.

example

curl --request GET \
  --url 'https://api.bigcommerce.com/stores/[store_hash]/v3/tax/providers/[provider_id]/connection' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: xxxxxxxxxxxxxxxxx'

Response

OK

Body

object | application/json

  • data    object

response

{
  "data": {
    "username": "MyConnectedTaxProviderAccount",
    "configured": true
  }
}

Delete a Connection

DELETE /tax/providers/{provider_id}/connection

Request

Remove any previously set basic connection credentials for the specified provider. If the specified provider is the active tax provider on the store, the store's active tax provider will be reset to BigCommerce Manual Tax. It is suggested to call this endpoint during a single-click app uninstall callback.

Note

  • This operation will be logged in Store Logs under Staff Actions.
  • Requires write permissions on the Information and Settings scope.

Authentication

  • X-Auth-Token in header - required

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string - required

    The MIME type of the response body.

  • provider_id in path - string - required

    The Tax Providerʼs provider_id provided by BigCommerce after the provider shares their provider details.

example

curl --request DELETE \
  --url 'https://api.bigcommerce.com/stores/[store_hash]/v3/tax/providers/[provider_id]/connection' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: xxxxxxxxxxxxxxxxx'

Response

OK

Body

object | application/json

  • data    object

response

{
  "data": {
    "username": "MyDisconnectedTaxProviderAccount",
    "configured": false
  }
}

Update a Connection

PUT /tax/providers/{provider_id}/connection

Request

Set authentication information associated with a merchant's account on the tax provider's infrastructure:

  • HTTP Basic Authentication (developer.mozilla.org) credentials
  • (optional) Tax provider profile used in customized endpoint urls for tax provider calls. This is only available for tax providers that support this feature.

The configured username, password, and profile (if available) is used to authenticate each API request to the Tax Provider from the associated store. The tax provider's profile will be included in the url for Tax Provider API endpoints.

Note

  • This operation will be logged in Store Logs under Staff Actions.
  • Requires write permissions on the Information and Settings scope.

Authentication

  • X-Auth-Token in header - required

Parameters

  • store_hash in path - string
  • provider_id in path - string - required

    The Tax Providerʼs provider_id provided by BigCommerce after the provider shares their provider details.

  • Content-Type in header with default of application/json - string - required

    The MIME type of the request body.

Basic authentication information, associated with a merchant account on the third-party tax providerʼs infrastructure.

Body

object | application/json

  • username    string

    Public identifying information representing a unique account on the tax provider's infrastructure. Should not contain any personal identifying information (e.g. a personal email address).

    Example: MyTaxProviderAccount

  • password    string

    Example: h6eSgKLN72q7jYTW

  • profile    string

    Optional field that allows merchants to customize Tax Provider API endpoint URLs. Only available for supporting providers.

    Example: your_app_name

Example

{
  "username": "MyTaxProviderAccount",
  "password": "h6eSgKLN72q7jYTW",
  "profile": "test-profile"
}

Response

OK

Body

object | application/json

  • data    object

response

{
  "data": {
    "username": "MyUpdatedTaxProviderAccount",
    "configured": true
  }
}