The REST Admin API is a legacy API as of October 1, 2024. All apps and integrations should be built with the GraphQL Admin API. For details and migration steps, visit our migration guide.
Important
The REST Province API is deprecated as of version 2024-07.
Please refer to the documentation for each individual endpoint and the developer changelog for more information.
The Province resource represents the sales tax that's applied to orders based the sub-regions of a country. Sub-regions might include counties, emirates, governorates, prefectures, provinces, regions, states, and territories.
You can use the Province resource to retrieve and update available sub-regions 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) | Mexico (32 states) |
Australia (8 states/territories) | New Zealand (16 regions) |
Brazil (27 states) | Nigeria (37 states) |
Canada (13 provinces/territories) | Panama (13 regions) |
Chile (16 regions) | Peru (26 regions) |
China (31 provinces) | Philippines (82 provinces) |
Colombia (33 provinces) | Portugal (20 regions) |
Egypt (29 governorates) | Romania (42 counties) |
Guatemala (22 regions) | Russia (82 regions) |
Hong Kong (3 regions) | South Africa (9 provinces) |
India (36 states) | South Korea (17 provinces) |
Indonesia (34 provinces) | Spain (52 provinces) |
Ireland (26 counties) | Thailand (78 provinces) |
Italy (110 provinces) | United Arab Emirates (7 emirates) |
Japan (47 prefectures) | United Kingdom (5 constituent countries/provinces) |
Malaysia (16 states/territories) | United States (62 states/territories) |
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
).
Important
This endpoint is deprecated as of 2024-07.
Retrieves a list of provinces.
Important
This endpoint is deprecated as of version 2024-07.
Retrieves a single province for a country
Important
This endpoint is deprecated as of version 2024-07.
Retrieves a count of provinces for a country
shipping
access scope.
Important
This endpoint is deprecated as of version 2024-07.