Province

The Province resource represents the sales tax that’s applied to orders from the sub-regions of a country. It represents any type of sub-region, such as states, provinces, territories, and counties.

Province - 图1

You can use the Province resource to retrieve and update available provinces for only the countries that a shop owner has added to a shipping zone. Merchants add countries to a shipping zone from the Shipping page of their Shopify admin.

For information on accessing the tax information for an entire country, including its provinces, see the Country resource.

Caution

As of version 2020-10, you can no longer update custom tax values for the Province resource.

Countries that have provinces in Shopify

Shopify provides provincial tax rates for the following countries:

A-J M-Z
Argentina (24 provinces) Malaysia (16 states/territories)
Australia (8 states/territories) Mexico (32 states)
Brazil (27 states) New Zealand (16 regions)
Canada (13 provinces/territories) Nigeria (37 states)
China (31 provinces) Panama (13 regions)
Colombia (33 provinces) Portugal (20 regions)
Egypt (29 governorates) Romania (42 counties)
Guatemala (22 regions) Russia (82 regions)
India (36 states) South Africa (9 provinces)
Indonesia (34 provinces) South Korea (17 provinces)
Ireland (26 counties) Spain (52 provinces)
Italy (110 provinces) United Arab Emirates (7 emirates)
Japan (47 prefectures) United States (62 states/territories)

What you can do with Province

The Shopify API lets you do the following with the Province resource. More detailed versions of these general actions may be available:

Province properties

code plain "code": "AB" The standard abbreviation for the province.
country_id plain "country_id": 879921427 The ID for the country that the province belongs to.
id plain "id": 205434194 The ID for the province.
name plain "name": "Alberta" The full name of the province.
shipping_zone_id plain "shipping_zone_id": 2038345 The ID for the shipping zone that the province belongs to.
tax plain "tax": 0.08 The sales tax rate to be applied to orders made by customers from this province.
tax_name plain "tax_name": "PST" The name of the tax for this province.
tax_type plain "tax_type": "normal" The tax type. Valid values: null, normal, harmonized, or compounded.
A harmonized tax is a combination of provincial and federal sales taxes.
Normal and harmonized tax rates are applied to the pre-tax value of an order, but a compounded tax rate is applied on top of other tax rates. For example, if a $100 order receives a 5% normal tax rate and a 2% compound tax rate, then the post-tax total is $107.10 ((100 x 1.05) x 1.02 = 107.1).
tax_percentage plain "tax_percentage": 8.0 The province’s tax in percent format.

Endpoints

GET/admin/api/2021-01/countries/{country_id}/provinces.json Retrieves a list of provinces
since_id Restrict results to after the specified ID.
fields Show only certain fields, specified by a comma-separated list of fields names.

Retrieve all provinces for a country

GET /admin/api/2021-01/countries/879921427/provinces.json

View Response

Retrieve all provinces for a country after the specified ID

GET /admin/api/2021-01/countries/879921427/provinces.json?since_id=536137098

View Response

GET/admin/api/2021-01/countries/{country_id}/provinces/count.json Retrieves a count of provinces for a country

Count all provinces

GET /admin/api/2021-01/countries/879921427/provinces/count.json

View Response

GET/admin/api/2021-01/countries/{country_id}/provinces/{province_id}.json Retrieves a single province for a country
fields Show only certain fields, specified by a comma-separated list of field names.

Retrieve a single province

GET /admin/api/2021-01/countries/879921427/provinces/224293623.json

View Response

PUT/admin/api/2021-01/countries/{country_id}/provinces/{province_id}.json

Caution

As of version 2020-10, the tax field is deprecated.

Updates an existing province for a country.

Update a province’s tax rate

PUT /admin/api/2021-01/countries/879921427/provinces/224293623.json

{

“province”: {

  1. "id": 224293623,
  3. "tax": 0.09

}

}

View Response