Create Tax Zones

POST

https://api.bigcommerce.com/stores/:store_hash/v3/tax/zones

POST

/stores/:store_hash/v3/tax/zones

curl -X POST https://api.bigcommerce.com/stores/store_hash/v3/tax/zones \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '[
  {
    "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
      ]
    }
  }
]'

200Example 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"
            ],
            "postal_codes": []
          }
        ],
        "customer_groups": [
          0
        ]
      }
    }
  ],
  "meta": {}
}

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.

Path parameters

store_hashstringRequired

Permanent ID of the BigCommerce store.

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 objectsOptional

metaobjectOptional

Response metadata.