Tax Zones
Get Tax Zones
GET https://api.bigcommerce.com/stores/{store_hash}/v3/tax/zonesRequest
Retrieve a selection of tax zones when you provide a list of tax zone IDs. Otherwise, retrieve all tax zones defined on the store.
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 zone
id. Use a comma-separated CSV string of IDs for multiple tax zones. For example,5or12,34,56.Type: array[integer]
example
curl --request GET \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v3/tax/zones' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'
Response
OK
Body
object | application/json
dataarray[object]
Example 1
{
"data": [
{
"id": 2,
"name": "example zone",
"enabled": false,
"price_display_settings": {
"show_inclusive": false,
"show_both_on_detail_view": false,
"show_both_on_list_view": false
},
"shopper_target_settings": {
"locations": [
{
"country_code": "AR",
"subdivision_codes": [
"T",
"V"
],
"postal_codes": []
},
{
"country_code": "AU",
"subdivision_codes": [
"WA",
"VIC"
Update Tax Zones
PUT https://api.bigcommerce.com/stores/{store_hash}/v3/tax/zonesRequest
Update one or more tax zones. Only the tax zone
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
idinteger
requiredTax Zone ID. Internal identifier used to get, update, or delete a specific tax zone.namestring
The human-readable name for this tax zone. The name appears in the store control panel.Example: Australiaenabledboolean
Indicates whether a tax zone is enabled. Tax operations are only for enabled zones.Default: true
price_display_settingsobject
Settings that describe how a store displays prices to shoppers matched with this tax zone.shopper_target_settingsobject
Settings that describe which shoppers match this tax zone and help determine the most appropriate target for a shopper. You cannot define shopper target settings for the default tax zone because it must accommodate all shoppers who donʼt qualify for any other zone.
Example 1
[
{
"id": 3,
"name": "Australia",
"enabled": false,
"price_display_settings": {
"show_inclusive": false,
"show_both_on_detail_view": false,
"show_both_on_list_view": false
},
"shopper_target_settings": {
"locations": [
{
"country_code": "AU",
"postal_codes": [
"2238",
"2173"
]
}
],
"customer_groups": [
2
]
}
}
]
Response
OK
Body
object | application/json
dataarray[object]
Example 1
{
"data": [
{
"id": 23,
"name": "Australia",
"enabled": false,
"price_display_settings": {
"show_inclusive": false,
"show_both_on_detail_view": false,
"show_both_on_list_view": false
},
"shopper_target_settings": {
"locations": [
{
"country_code": "AU",
"subdivision_codes": [],
"postal_codes": [
"2238",
"2173"
]
}
],
"customer_groups": [
2
]
}
}
],
"meta": {}
}
Create Tax Zones
POST https://api.bigcommerce.com/stores/{store_hash}/v3/tax/zonesRequest
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
namestring
requiredThe human-readable name for this tax zone. The name appears in the store control panel.Example: Australiaenabledboolean
Indicates whether a tax zone is enabled. Tax operations are only for enabled zones.Default: true
price_display_settingsobject
Settings that describe how a store displays prices to shoppers matched with this tax zone.shopper_target_settingsobject
Settings that describe which shoppers match this tax zone and help determine the most appropriate target for a shopper.
Example 1
[
{
"name": "example zone",
"enabled": true,
"price_display_settings": {
"show_inclusive": true,
"show_both_on_detail_view": true,
"show_both_on_list_view": true
},
"shopper_target_settings": {
"locations": [
{
"country_code": "AR",
"subdivision_codes": [
"T",
"V"
]
},
{
"country_code": "AU",
"subdivision_codes": [
"WA",
"VIC"
]
}
],
"customer_groups": [
0
]
}
}
Response
OK
Body
object | application/json
dataarray[object]
Example 1
{
"data": [
{
"id": 2,
"name": "example zone",
"enabled": true,
"price_display_settings": {
"show_inclusive": true,
"show_both_on_detail_view": true,
"show_both_on_list_view": true
},
"shopper_target_settings": {
"locations": [
{
"country_code": "AR",
"subdivision_codes": [
"T",
"V"
],
"postal_codes": []
},
{
"country_code": "AU",
"subdivision_codes": [
"WA",
"VIC"
Delete Tax Zones
DELETE https://api.bigcommerce.com/stores/{store_hash}/v3/tax/zonesRequest
Delete one or more tax zones. Deleting a tax zone removes all associated tax rates.
You must specify which zone(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 zone
id. Use a comma-separated CSV string of IDs for multiple tax zones. For example,5or12,34,56.Type: array[integer]
example
curl --request DELETE \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v3/tax/zones' \
--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?