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

Get Tax Rates

GET /tax/rates

Request

Retrieve a list of tax rates.

Authentication

  • X-Auth-Token in header - required

Parameters

  • store_hash in path - string
  • in

    Filter by tax rate id. Use a comma-separated CSV string of IDs for multiple tax rates. For example, 5 or 12,34,56.

  • tax_zone_id:in in query - array

    Filter by tax zone id. Use a comma-separated CSV string of IDs for multiple tax zones. For example, 5 or 12,34,56.

example

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

Response

OK

Body

object | application/json

  • data    array[object]

  • meta    object

Update Tax Rates

PUT /tax/rates

Request

Update one or more tax rates. Only the tax rate id field is required. Fields unspecified by the request will retain their current state.

Authentication

  • X-Auth-Token in header - required

Parameters

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

    The MIME type of the request body.

Body

array | application/json

  • class_rates    array[object]

    Tax rates for tax classes. You must assign at least one tax rate for each tax class defined on a store.

  • enabled    boolean

    Indicates whether a tax rate is enabled. Tax operations are only for enabled zones.

    Default: true

  • id    integer

    Tax Rate ID. Internal identifier to update and delete a specific tax rate.

    Example: 3

  • name    string

    The human-readable name for this tax zone. The name displays on the merchant control panel and to shoppers, depending on store tax settings.

    Example: Sales Tax

  • priority    integer

    Allows for compounding tax rates, common in certain jurisdictions.

    Default: 1

  • tax_zone_id    integer

    ID of an associated tax zone. You must associate a tax rate with a tax zone.

    Example: 2

Response

OK

Body

object | application/json

  • data    array[object]

  • meta    object

Example 1

{
  "data": [
    {
      "id": 3,
      "tax_zone_id": 2,
      "name": "Sales Tax",
      "enabled": true,
      "priority": 1,
      "class_rates": [
        {
          "rate": 10,
          "tax_class_id": 0
        }
      ]
    }
  ],
  "meta": {}
}

Create Tax Rates

POST /tax/rates

Request

Create one or more tax rates. Tax rates must be associated with a tax_zone_id.

Authentication

  • X-Auth-Token in header - required

Parameters

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

    The MIME type of the request body.

Body

array | application/json

  • class_rates    array[object]

    Tax rates for tax classes. You must assign at least one tax rate for each tax class defined on a store.

  • enabled    boolean

    Indicates whether a tax rate is enabled. Tax operations are only for enabled zones.

    Default: true

  • name    string

    The human-readable name for this tax zone. The name displays on the merchant control panel and to shoppers, depending on store tax settings.

    Example: Sales Tax

  • priority    integer

    Allows for compounding tax rates, common in certain jurisdictions.

    Default: 1

  • tax_zone_id    integer

    ID of an associated tax zone. You must associate a tax rate with a tax zone.

    Example: 2

Response

OK

Body

object | application/json

  • data    array[object]

  • meta    object

Example 1

{
  "data": [
    {
      "id": 3,
      "tax_zone_id": 2,
      "name": "Sales Tax",
      "enabled": true,
      "priority": 1,
      "class_rates": [
        {
          "rate": 5,
          "tax_class_id": 0
        }
      ]
    }
  ],
  "meta": {}
}

Delete Tax Rates

DELETE /tax/rates

Request

Delete one or more tax rates.

<!-- theme:info -->

You must specify which rate(s) to delete using the id:in query parameter.

Authentication

  • X-Auth-Token in header - required

Parameters

  • store_hash in path - string
  • in

    Filter by tax rate id. Use a comma-separated CSV string of IDs for multiple tax rates. For example, 5 or 12,34,56.

example

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

Response

No Content