Shopify API – Province

top

Receive a list of all Provinces

Get all provinces

Available URL Query parameters:

  • country_id — The id of the country the province belongs to
GET /admin/countries/#{id}/provinces.xml

Get all provinces for a country

Response

           
HTTP/1.1 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<provinces type="array">
  <province>
    <code>AB</code>
    <id type="integer">1279176016</id>
    <name>Alberta</name>
    <tax type="float">0.08</tax>
  </province>
  <province>
    <code>BC</code>
    <id type="integer">170405626</id>
    <name>British Columbia</name>
    <tax type="float">0.07</tax>
  </province>
  <province>
    <code>MB</code>
    <id type="integer">342345109</id>
    <name>Manitoba</name>
    <tax type="float">0.07</tax>
  </province>
  <province>
    <code>NB</code>
    <id type="integer">92264567</id>
    <name>New Brunswick</name>
    <tax type="float">0.15</tax>
  </province>
  <province>
    <code>NF</code>
    <id type="integer">1317025994</id>
    <name>Newfoundland</name>
    <tax type="float">0.15</tax>
  </province>
  <province>
    <code>NT</code>
    <id type="integer">1513340152</id>
    <name>Northwest Territories</name>
    <tax type="float">0.0</tax>
  </province>
  <province>
    <code>NS</code>
    <id type="integer">448070558</id>
    <name>Nova Scotia</name>
    <tax type="float">0.15</tax>
  </province>
  <province>
    <code>NU</code>
    <id type="integer">670206421</id>
    <name>Nunavut</name>
    <tax type="float">0.0</tax>
  </province>
  <province>
    <code>ON</code>
    <id type="integer">702530424</id>
    <name>Ontario</name>
    <tax type="float">0.08</tax>
  </province>
  <province>
    <code>PE</code>
    <id type="integer">1644633545</id>
    <name>Prince Edward Island</name>
    <tax type="float">0.1</tax>
  </province>
  <province>
    <code>QC</code>
    <id type="integer">1298035446</id>
    <name>Quebec</name>
    <tax type="float">0.09</tax>
  </province>
  <province>
    <code>YT</code>
    <id type="integer">2079006508</id>
    <name>Yukon</name>
    <tax type="float">0.0</tax>
  </province>
</provinces>
top

Receive a list of all Provinces

Get a count of all provinces

Available URL Query parameters:

  • country_id — The id of the country the province belongs to
GET /admin/countries/#{id}/provinces/count.xml

Count all provinces for a country

Response

           
HTTP/1.1 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<count type="integer">12</count>
top

Receive a single Province

Get a single province for a country

Available URL Query parameters:

  • country_id — The id of the country the province belongs to
GET /admin/countries/#{id}/provinces/#{id}.xml

Show province

Response

           
HTTP/1.1 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<province>
  <code>QC</code>
  <id type="integer">1298035446</id>
  <name>Quebec</name>
  <tax type="float">0.09</tax>
</province>
top

Modify an existing Province

PUT /admin/countries/#{id}/provinces/#{id}.xml

Update a province's tax rate

Request

           
<?xml version="1.0" encoding="UTF-8"?>
<province>
  <tax type="float">0.15</tax>
  <id type="integer">1298035446</id>
</province>

Response

           
HTTP/1.1 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<province>
  <code>QC</code>
  <id type="integer">1298035446</id>
  <name>Quebec</name>
  <tax type="float">0.15</tax>
</province>
Last updated at Oct 2009 Oct:10 AM.