Shipping Zone

This is used to view shipping zones, their countries, provinces, and shipping rates.

What can you do with Shipping Zone?

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

Shipping Zone Properties

id
{ "id" : 132 }

The unique numeric identifier for the shipping zone.

name
{ "name" : "North America" }

The name of the shipping zone, specified by the user.

countries
{ "id" : 189 }
{ "shipping_zone_id" : 132 }
{ "name" : "Canada" }
{ "tax" : 0.5 }
{ "code" : "CA" }
{ "tax_name" : "GST" }
{ "provinces" : [] }

A list of countries that belong to the shipping zone.

  • id: The unique numeric identifier for the country.
  • code: The ISO 3166-1 alpha-2 two-letter country code for the country. The code for a given country will be the same as the code for the same country in another shop.
  • shipping_zone_id: The unique numeric identifier for the shipping zone.
  • name: The full name of the country, in English.
  • tax: The tax value in decimal format.
  • tax_name: The name of the tax as it is referred to in the applicable province/state. For example, in Ontario, Canada the tax is referred to as HST.

provinces
{ "code" : "AB" }
{ "country_id" : 879921427 }
{ "shipping_zone_is" : 132 }
{ "id" : 205434194 }
{ "name" : "Alberta" }
{ "tax" : 0.08 }
{ "tax_name" : null }
{ "tax_type" : null }
{ "tax_percentage" : 8.0 }

The sub-regions of a country. The term provinces also encompasses states.

  • code: The two letter province or state code.
  • country_id: The unique numeric identifier for the country.
  • shipping_zone_id: The unique numeric identifier for the shipping zone.
  • id: The unique numeric identifier for the particular province or state.
  • name: The name of the province or state.
  • tax: The tax value in decimal format.
  • tax_name: The name of the tax as it is referred to in the applicable province/state. For example, in Ontario, Canada the tax is referred to as HST.
  • tax_type: A tax_type is applied for a compounded sales tax. For example, the Canadian HST is a compounded sales tax of both PST and GST.
  • tax_percentage: The tax value in percent format.

carrier_shipping_rate_providers
{ "carrier_shipping_rate_providers" : [] }

Information about carrier shipping providers and the rates used.

price_based_shipping_rates
{ "price_based_shipping_rates" : [] }

Information about price based shipping rates used.

weight_based_shipping_rates
{ "weight_based_shipping_rates" : [] }

Information about weight based shipping rates used.

Endpoints

GET/admin/shipping_zones.json

Get a list of all shipping zones

fields

comma-separated list of fields to include in the response

Show list of shipping zones

GET /admin/shipping_zones.json
View Response
HTTP/1.1 200 OK
{
  "shipping_zones": [
    {
      "id": 1039932365,
      "name": "Some zone",
      "countries": [
        {
          "id": 817138619,
          "name": "United States",
          "tax": 0.0,
          "code": "US",
          "tax_name": "Federal Tax",
          "provinces": [
            {
              "id": 1013111685,
              "country_id": 817138619,
              "name": "New York",
              "code": "NY",
              "tax": 0.04,
              "tax_name": "Tax",
              "tax_type": null,
              "shipping_zone_id": 1039932365,
              "tax_percentage": 4.0
            },
            {
              "id": 1069646655,
              "country_id": 817138619,
              "name": "Ohio",
              "code": "OH",
              "tax": 0.0,
              "tax_name": "State Tax",
              "tax_type": null,
              "shipping_zone_id": 1039932365,
              "tax_percentage": 0.0
            }
          ]
        },
        {
          "id": 879921427,
          "name": "Canada",
          "tax": 0.05,
          "code": "CA",
          "tax_name": "GST",
          "provinces": [
            {
              "id": 702530425,
              "country_id": 879921427,
              "name": "Ontario",
              "code": "ON",
              "tax": 0.08,
              "tax_name": "Tax",
              "tax_type": null,
              "shipping_zone_id": 1039932365,
              "tax_percentage": 8.0
            },
            {
              "id": 224293623,
              "country_id": 879921427,
              "name": "Quebec",
              "code": "QC",
              "tax": 0.09,
              "tax_name": "HST",
              "tax_type": "compounded",
              "shipping_zone_id": 1039932365,
              "tax_percentage": 9.0
            }
          ]
        },
        {
          "id": 988409125,
          "name": "Yemen",
          "tax": 0.0,
          "code": "YE",
          "tax_name": "GST",
          "provinces": [
          ]
        }
      ],
      "weight_based_shipping_rates": [
        {
          "id": 155327050,
          "weight_low": 0.0,
          "weight_high": 5.0,
          "name": "Canada Air Shipping",
          "price": "25.00",
          "shipping_zone_id": 1039932365
        }
      ],
      "price_based_shipping_rates": [
        {
          "id": 10665840,
          "name": "Standard Shipping",
          "min_order_subtotal": "0.00",
          "price": "10.99",
          "max_order_subtotal": "2000.00",
          "shipping_zone_id": 1039932365
        },
        {
          "id": 78195293,
          "name": "Expensive Shipping",
          "min_order_subtotal": "0.00",
          "price": "99.99",
          "max_order_subtotal": "2000.00",
          "shipping_zone_id": 1039932365
        }
      ],
      "carrier_shipping_rate_providers": [
        {
          "id": 434512862,
          "carrier_service_id": 61629186,
          "flat_modifier": "0.00",
          "percent_modifier": 0,
          "service_filter": {
            "*": "+"
          },
          "shipping_zone_id": 1039932365
        }
      ]
    }
  ]
}