Update Tax Zones

PUT

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

PUT

/stores/:store_hash/v3/tax/zones

curl -X PUT 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 '[
  {
    "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
      ]
    }
  }
]'

200Example 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": {}
}

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-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.

idintegerRequired

Tax Zone ID. Internal identifier used to get, update, or delete a specific tax zone.

namestringOptional

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. 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.

Response

datalist of objectsOptional

metaobjectOptional

Response metadata.