BigCommerce Docs

query ExampleQuery($storeHash: String) {
  taxZoneRates(storeHash: $storeHash) {
    id
    name
    enabled
    shopperTargetSettings {
      locations
      customerGroups
    }
    rates {
      id
      name
      enabled
      priority
      classRates
    }
    priceDisplaySettings {
      showInclusive
      showBothOnDetailView
      showBothOnListView
    }
  }
}

{
  "storeHash": "example"
}

{
  "data": {
    "taxZoneRates": [
      {
        "id": 0,
        "name": "example",
        "enabled": true,
        "shopperTargetSettings": {
          "locations": [
            {
              "countryCode": null,
              "subdivisionCodes": null,
              "postalCodes": null
            }
          ],
          "customerGroups": [
            0
          ]
        },
        "rates": [
          {
            "id": 0,
            "name": "example",
            "enabled": true,
            "priority": 0,
            "classRates": [
              {
                "rate": null,
                "taxClassId": null
              }
            ]
          }
        ],
        "priceDisplaySettings": {
          "showInclusive": true,
          "showBothOnDetailView": true,
          "showBothOnListView": true
        }
      }
    ]
  }
}

query ExampleQuery($storeHash: String) {
  taxZoneRates(storeHash: $storeHash) {
    id
    name
    enabled
    shopperTargetSettings {
      locations
      customerGroups
    }
    rates {
      id
      name
      enabled
      priority
      classRates
    }
    priceDisplaySettings {
      showInclusive
      showBothOnDetailView
      showBothOnListView
    }
  }
}

{
  "storeHash": "example"
}

{
  "data": {
    "taxZoneRates": [
      {
        "id": 0,
        "name": "example",
        "enabled": true,
        "shopperTargetSettings": {
          "locations": [
            {
              "countryCode": null,
              "subdivisionCodes": null,
              "postalCodes": null
            }
          ],
          "customerGroups": [
            0
          ]
        },
        "rates": [
          {
            "id": 0,
            "name": "example",
            "enabled": true,
            "priority": 0,
            "classRates": [
              {
                "rate": null,
                "taxClassId": null
              }
            ]
          }
        ],
        "priceDisplaySettings": {
          "showInclusive": true,
          "showBothOnDetailView": true,
          "showBothOnListView": true
        }
      }
    ]
  }
}

Get the tax zone information. Doesn't require a Token.

Arguments

storeHashStringRequired

Store hash. This field is required.

Returns

an optional list of optional TaxZoneRateType

idInteger

The id of tax zone

nameString

The name of tax zone

enabledBoolean

The enabled of tax zone

shopperTargetSettingsTaxZoneShopperTargetType

The shopper target settings of tax zone

rateslist of optional TaxRateType

priceDisplaySettingsPriceDisplaySettingsType

Store displays prices to shoppers matched with this tax zone.

1	{
2	"data": {
3	"taxZoneRates": [
4	{
5	"id": 0,
6	"name": "example",
7	"enabled": true,
8	"shopperTargetSettings": {
9	"locations": [
10	{
11	"countryCode": null,
12	"subdivisionCodes": null,
13	"postalCodes": null
14	}
15	],
16	"customerGroups": [
17	0
18	]
19	},
20	"rates": [
21	{
22	"id": 0,
23	"name": "example",
24	"enabled": true,
25	"priority": 0,
26	"classRates": [
27	{
28	"rate": null,
29	"taxClassId": null
30	}
31	]
32	}
33	],
34	"priceDisplaySettings": {
35	"showInclusive": true,
36	"showBothOnDetailView": true,
37	"showBothOnListView": true
38	}
39	}
40	]
41	}
42	}

1	{
2	"data": {
3	"taxZoneRates": [
4	{
5	"id": 0,
6	"name": "example",
7	"enabled": true,
8	"shopperTargetSettings": {
9	"locations": [
10	{
11	"countryCode": null,
12	"subdivisionCodes": null,
13	"postalCodes": null
14	}
15	],
16	"customerGroups": [
17	0
18	]
19	},
20	"rates": [
21	{
22	"id": 0,
23	"name": "example",
24	"enabled": true,
25	"priority": 0,
26	"classRates": [
27	{
28	"rate": null,
29	"taxClassId": null
30	}
31	]
32	}
33	],
34	"priceDisplaySettings": {
35	"showInclusive": true,
36	"showBothOnDetailView": true,
37	"showBothOnListView": true
38	}
39	}
40	]
41	}
42	}

1	query ExampleQuery($storeHash: String) {
2	taxZoneRates(storeHash: $storeHash) {
3	id
4	name
5	enabled
6	shopperTargetSettings {
7	locations
8	customerGroups
9	}
10	rates {
11	id
12	name
13	enabled
14	priority
15	classRates
16	}
17	priceDisplaySettings {
18	showInclusive
19	showBothOnDetailView
20	showBothOnListView
21	}
22	}
23	}