Tax Rates
Get Tax Rates
GET https://api.bigcommerce.com/stores/{store_hash}/v3/tax/ratesRequest
Retrieve a list of tax rates.
Authentication
- X-Auth-Token in header
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequiredThe MIME type of the response body.
- id:in in query - arrayFilter by tax rate
id
. Use a comma-separated CSV string of IDs for multiple tax rates. For example,5
or12,34,56
.Type: array[integer] - tax_zone_id:in in query - arrayFilter by tax zone
id
. Use a comma-separated CSV string of IDs for multiple tax zones. For example,5
or12,34,56
.Type: array[integer]
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: {{token}}'
Response
OK
Body
object | application/json
dataarray[object]
Update Tax Rates
PUT https://api.bigcommerce.com/stores/{store_hash}/v3/tax/ratesRequest
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
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequiredThe MIME type of the response body.
- Content-Type in header with default of application/json - stringrequiredThe MIME type of the request body.
Body
array | application/json
class_ratesarray[object]
Tax rates for tax classes. You must assign at least one tax rate for each tax class defined on a store.enabledboolean
Indicates whether a tax rate is enabled. Tax operations are only for enabled zones.Default: true
idinteger
requiredTax Rate ID. Internal identifier to update and delete a specific tax rate.Example: 3namestring
The human-readable name for this tax zone. The name appears in the store control panel and may be visible to shoppers, depending on store tax settings.Example: Sales Taxpriorityinteger
Allows for compounding tax rates, common in certain jurisdictions.Default: 1
tax_zone_idinteger
ID of an associated tax zone. You must associate a tax rate with a tax zone.Example: 2
Example 1
[
{
"id": 3,
"tax_zone_id": 2,
"name": "Sales Tax",
"enabled": true,
"priority": 1,
"class_rates": [
{
"rate": 10,
"tax_class_id": 0
}
]
}
]
Response
OK
Body
object | application/json
dataarray[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 https://api.bigcommerce.com/stores/{store_hash}/v3/tax/ratesRequest
Create one or more tax rates. Tax rates must be associated with a
tax_zone_id
.Authentication
- X-Auth-Token in header
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequiredThe MIME type of the response body.
- Content-Type in header with default of application/json - stringrequiredThe MIME type of the request body.
Body
array | application/json
class_ratesarray[object]
requiredTax rates for tax classes. You must assign at least one tax rate for each tax class defined on a store.enabledboolean
Indicates whether a tax rate is enabled. Tax operations are only for enabled zones.Default: true
namestring
requiredThe human-readable name for this tax zone. The name appears in the store control panel and may be visible to shoppers, depending on store tax settings.Example: Sales Taxpriorityinteger
Allows for compounding tax rates, common in certain jurisdictions.Default: 1
tax_zone_idinteger
requiredID of an associated tax zone. You must associate a tax rate with a tax zone.Example: 2
Example 1
[
{
"tax_zone_id": 2,
"name": "Sales Tax",
"enabled": true,
"priority": 1,
"class_rates": [
{
"rate": 5,
"tax_class_id": 0
}
]
}
]
Response
OK
Body
object | application/json
dataarray[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 https://api.bigcommerce.com/stores/{store_hash}/v3/tax/ratesRequest
Delete one or more tax rates.
You must specify which rate(s) to delete using the id:in
query parameter.
Authentication
- X-Auth-Token in header
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequiredThe MIME type of the response body.
- id:in in query - arrayFilter by tax rate
id
. Use a comma-separated CSV string of IDs for multiple tax rates. For example,5
or12,34,56
.Type: array[integer]
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: {{token}}'
Response
No Content
Did you find what you were looking for?