Check Zone for Address

POST

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

POST

/stores/:store_hash/v3/tax/zonecheck

curl -X POST https://api.bigcommerce.com/stores/store_hash/v3/tax/zonecheck \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '[
  {
    "country_code": "AU"
  }
]'

{
  "data": [
    {
      "id": 1,
      "name": "Australia",
      "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": "AU",
            "subdivision_codes": [
              "NSW",
              "QLD"
            ],
            "postal_codes": [
              "2234",
              "2170"
            ]
          }
        ],
        "customer_groups": [
          1
        ]
      }
    }
  ]
}

Check the applicable tax zone for a given address and customer group.

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.

country_codestringRequired

Two-letter ISO 3166-1 country code.

subdivision_codestringOptional

ISO 3166-2 subdivision code, up to three alphanumeric characters.

postal_codestringOptional

Postal code.

customer_group_idintegerOptional

Customer Group ID to which the customer is belongs.

Response

datalist of objectsOptional

Errors

422

Unprocessable Entity Error