Create Tax Zones | BigCommerce Developer Center

Create one or more tax zones.

Note

You cannot create a default tax zone.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Information & Settings	modify	`store_v2_information`
Information & Settings	read-only	`store_v2_information_read_only`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

### OAuth scopes | UI Name | Permission | Parameter | |:--------|:-----------|:----------| | Information & Settings | modify | `store_v2_information` | | Information & Settings | read-only | `store_v2_information_read_only` | ### Authentication header | Header | Argument | Description | |:-------|:---------|:------------| | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-accounts#api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

Request

This endpoint expects a list of objects.

namestringRequired

The human-readable name for this tax zone. The name appears in the store control panel.

enabledbooleanOptionalDefaults to true

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

price_display_settingsobjectOptional

Settings that describe how a store displays prices to shoppers matched with this tax zone.

shopper_target_settingsobjectOptional

Settings that describe which shoppers match this tax zone and help determine the most appropriate target for a shopper.

Response

datalist of objects

metaobject

Response metadata.

1	import requests
2
3	url = "https://api.bigcommerce.com/stores/store_hash/v3/tax/zones"
4
5	payload = [
6	{
7	"name": "example zone",
8	"enabled": True,
9	"price_display_settings": {
10	"show_inclusive": True,
11	"show_both_on_detail_view": True,
12	"show_both_on_list_view": True
13	},
14	"shopper_target_settings": {
15	"locations": [
16	{
17	"country_code": "AR",
18	"subdivision_codes": ["T", "V"]
19	},
20	{
21	"country_code": "AU",
22	"subdivision_codes": ["WA", "VIC"]
23	}
24	],
25	"customer_groups": [0]
26	}
27	}
28	]
29	headers = {
30	"X-Auth-Token": "<apiKey>",
31	"Content-Type": "application/json"
32	}
33
34	response = requests.post(url, json=payload, headers=headers)
35
36	print(response.json())

1	{
2	"data": [
3	{
4	"id": 2,
5	"name": "example zone",
6	"enabled": true,
7	"price_display_settings": {
8	"show_inclusive": true,
9	"show_both_on_detail_view": true,
10	"show_both_on_list_view": true
11	},
12	"shopper_target_settings": {
13	"locations": [
14	{
15	"country_code": "AR",
16	"subdivision_codes": [
17	"T",
18	"V"
19	],
20	"postal_codes": []
21	},
22	{
23	"country_code": "AU",
24	"subdivision_codes": [
25	"WA",
26	"VIC"
27	],
28	"postal_codes": []
29	}
30	],
31	"customer_groups": [
32	0
33	]
34	}
35	}
36	],
37	"meta": {}
38	}