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 headerrequired
Parameters
- store_hash in path - string
example
Response
OK
Body
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 headerrequired
Parameters
- store_hash in path - string
Body
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
Response
OK
Body
dataarray[object]
Example 1
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 headerrequired
Parameters
- store_hash in path - string
Body
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
Response
OK
Body
dataarray[object]
Example 1
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 headerrequired
Parameters
- store_hash in path - string
example
Response
No Content