ShippingZone

Version 2019-04

You can use the ShippingZone resource to view shipping zones and their countries, provinces, and shipping rates. A shipping zone belongs to a delivery profile, which provides shops with the ability to create shipping rates per product variant and per location. For example, the merchant might want to use a shipping rate that applies only to fragile products. When querying the ShippingZone resource, each shipping zone is returned with its corresponding profile ID, location group ID, and countries. Its possible for the same country to exist in multiple shipping zones, if the shipping zones with overlapping countries have different delivery profiles.

What you can do with ShippingZone

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

ShippingZone 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.

profile_id
"profile_id": 163945

The ID of the shipping zone's delivery profile. Shipping profiles allow merchants to create product-based or location-based shipping rates.

location_group_id
"location_group_id": 32873

The ID of the shipping zone's location group. Location groups allow merchants to create shipping rates that apply only to the specific locations in the group.

countries
"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
"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": {
  "id": 882078077,
  "name": "$5 Shipping",
  "price": "5.00",
  "shipping_zone_id": 881877113,
  "min_order_subtotal": "40.0",
  "max_order_subtotal": null
}

Information about a price-based shipping rate.

  • id: The unique numeric identifier for the shipping rate.
  • name: The name of the shipping rate.
  • price: The price of the shipping rate.
  • shipping_zone_id: The unique numeric identifier for the associated shipping zone.
  • min_order_subtotal: The minimum price of an order for it to be eligible for the shipping rate.
  • max_order_subtotal: The maximum price of an order for it to be eligible for the shipping rate.
weight_based_shipping_rates
"weight_based_shipping_rates": {
  "id": 882078078,
  "name": "Canada Air Shipping",
  "price": "25.00",
  "shipping_zone_id": 881877113,
  "weight_low": 0.0,
  "weight_high": 11.02
}

Information about a weight-based shipping rate.

  • id: The unique numeric identifier for the shipping rate.
  • name: The name of the shipping rate.
  • price: The price of the shipping rate.
  • shipping_zone_id: The unique numeric identifier for the associated shipping zone.
  • weight_low: The minimum weight of an order for it to be eligible for the shipping rate.
  • weight_high: The maximum weight of an order for it to be eligible for the shipping rate.

Endpoints

GET /admin/api/2019-04/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/api/2019-04/shipping_zones.json
View Response
HTTP/1.1 200 OK
{
  "shipping_zones": [
    {
      "id": 1039932365,
      "name": "Some zone",
      "profile_id": "gid://shopify/DeliveryProfile/593363171",
      "location_group_id": "gid://shopify/DeliveryLocationGroup/955592433",
      "admin_graphql_api_id": "gid://shopify/DeliveryZone/881877112",
      "countries": [
        {
          "id": 817138619,
          "name": "United States",
          "tax": 0.0,
          "code": "US",
          "tax_name": "Federal Tax",
          "shipping_zone_id": 881877112,
          "provinces": [
            {
              "id": 1069646656,
              "country_id": 817138619,
              "name": "New York",
              "code": "NY",
              "tax": 0.0,
              "tax_name": "State Tax",
              "tax_type": null,
              "tax_percentage": 0.0,
              "shipping_zone_id": 881877112
            },
            {
              "id": 1069646657,
              "country_id": 817138619,
              "name": "Ohio",
              "code": "OH",
              "tax": 0.0,
              "tax_name": "State Tax",
              "tax_type": null,
              "tax_percentage": 0.0,
              "shipping_zone_id": 881877112
            }
          ]
        },
        {
          "id": 879921427,
          "name": "Canada",
          "tax": 0.05,
          "code": "CA",
          "tax_name": "GST",
          "shipping_zone_id": 881877112,
          "provinces": [
            {
              "id": 1069646654,
              "country_id": 879921427,
              "name": "Ontario",
              "code": "ON",
              "tax": 0.13,
              "tax_name": "HST",
              "tax_type": "harmonized",
              "tax_percentage": 13.0,
              "shipping_zone_id": 881877112
            },
            {
              "id": 1069646655,
              "country_id": 879921427,
              "name": "Quebec",
              "code": "QC",
              "tax": 0.09975,
              "tax_name": "QST",
              "tax_type": null,
              "tax_percentage": 9.975,
              "shipping_zone_id": 881877112
            }
          ]
        },
        {
          "id": 1070231512,
          "name": "Yemen",
          "tax": 0.0,
          "code": "YE",
          "tax_name": "GST",
          "shipping_zone_id": 881877112,
          "provinces": []
        }
      ],
      "weight_based_shipping_rates": [
        {
          "id": 882078075,
          "name": "Canada Air Shipping",
          "price": "25.00",
          "shipping_zone_id": 881877112,
          "weight_low": 0.0,
          "weight_high": 11.0231
        }
      ],
      "price_based_shipping_rates": [
        {
          "id": 882078074,
          "name": "$5 Shipping",
          "price": "5.05",
          "shipping_zone_id": 881877112,
          "min_order_subtotal": "40.0",
          "max_order_subtotal": null
        }
      ],
      "carrier_shipping_rate_providers": [
        {
          "id": 882078076,
          "carrier_service_id": 770241334,
          "flat_modifier": "0.0",
          "percent_modifier": 0,
          "service_filter": {
            "*": "+"
          },
          "shipping_zone_id": 881877112
        }
      ]
    }
  ]
}
Version 2019-07 (Latest)

You can use the ShippingZone resource to view shipping zones and their countries, provinces, and shipping rates. A shipping zone belongs to a delivery profile, which provides shops with the ability to create shipping rates per product variant and per location. For example, the merchant might want to use a shipping rate that applies only to fragile products. When querying the ShippingZone resource, each shipping zone is returned with its corresponding profile ID, location group ID, and countries. Its possible for the same country to exist in multiple shipping zones, if the shipping zones with overlapping countries have different delivery profiles.

What you can do with ShippingZone

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

ShippingZone 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.

profile_id
"profile_id": 163945

The ID of the shipping zone's delivery profile. Shipping profiles allow merchants to create product-based or location-based shipping rates.

location_group_id
"location_group_id": 32873

The ID of the shipping zone's location group. Location groups allow merchants to create shipping rates that apply only to the specific locations in the group.

countries
"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
"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": {
  "id": 882078077,
  "name": "$5 Shipping",
  "price": "5.00",
  "shipping_zone_id": 881877113,
  "min_order_subtotal": "40.0",
  "max_order_subtotal": null
}

Information about a price-based shipping rate.

  • id: The unique numeric identifier for the shipping rate.
  • name: The name of the shipping rate.
  • price: The price of the shipping rate.
  • shipping_zone_id: The unique numeric identifier for the associated shipping zone.
  • min_order_subtotal: The minimum price of an order for it to be eligible for the shipping rate.
  • max_order_subtotal: The maximum price of an order for it to be eligible for the shipping rate.
weight_based_shipping_rates
"weight_based_shipping_rates": {
  "id": 882078078,
  "name": "Canada Air Shipping",
  "price": "25.00",
  "shipping_zone_id": 881877113,
  "weight_low": 0.0,
  "weight_high": 11.02
}

Information about a weight-based shipping rate.

  • id: The unique numeric identifier for the shipping rate.
  • name: The name of the shipping rate.
  • price: The price of the shipping rate.
  • shipping_zone_id: The unique numeric identifier for the associated shipping zone.
  • weight_low: The minimum weight of an order for it to be eligible for the shipping rate.
  • weight_high: The maximum weight of an order for it to be eligible for the shipping rate.

Endpoints

GET /admin/api/2019-07/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/api/2019-07/shipping_zones.json
View Response
HTTP/1.1 200 OK
{
  "shipping_zones": [
    {
      "id": 1039932365,
      "name": "Some zone",
      "profile_id": "gid://shopify/DeliveryProfile/593363171",
      "location_group_id": "gid://shopify/DeliveryLocationGroup/955592433",
      "admin_graphql_api_id": "gid://shopify/DeliveryZone/881877112",
      "countries": [
        {
          "id": 817138619,
          "name": "United States",
          "tax": 0.0,
          "code": "US",
          "tax_name": "Federal Tax",
          "shipping_zone_id": 881877112,
          "provinces": [
            {
              "id": 1069646656,
              "country_id": 817138619,
              "name": "New York",
              "code": "NY",
              "tax": 0.0,
              "tax_name": "State Tax",
              "tax_type": null,
              "tax_percentage": 0.0,
              "shipping_zone_id": 881877112
            },
            {
              "id": 1069646657,
              "country_id": 817138619,
              "name": "Ohio",
              "code": "OH",
              "tax": 0.0,
              "tax_name": "State Tax",
              "tax_type": null,
              "tax_percentage": 0.0,
              "shipping_zone_id": 881877112
            }
          ]
        },
        {
          "id": 879921427,
          "name": "Canada",
          "tax": 0.05,
          "code": "CA",
          "tax_name": "GST",
          "shipping_zone_id": 881877112,
          "provinces": [
            {
              "id": 1069646654,
              "country_id": 879921427,
              "name": "Ontario",
              "code": "ON",
              "tax": 0.13,
              "tax_name": "HST",
              "tax_type": "harmonized",
              "tax_percentage": 13.0,
              "shipping_zone_id": 881877112
            },
            {
              "id": 1069646655,
              "country_id": 879921427,
              "name": "Quebec",
              "code": "QC",
              "tax": 0.09975,
              "tax_name": "QST",
              "tax_type": null,
              "tax_percentage": 9.975,
              "shipping_zone_id": 881877112
            }
          ]
        },
        {
          "id": 1070231512,
          "name": "Yemen",
          "tax": 0.0,
          "code": "YE",
          "tax_name": "GST",
          "shipping_zone_id": 881877112,
          "provinces": []
        }
      ],
      "weight_based_shipping_rates": [
        {
          "id": 882078075,
          "name": "Canada Air Shipping",
          "price": "25.00",
          "shipping_zone_id": 881877112,
          "weight_low": 0.0,
          "weight_high": 11.0231
        }
      ],
      "price_based_shipping_rates": [
        {
          "id": 882078074,
          "name": "$5 Shipping",
          "price": "5.05",
          "shipping_zone_id": 881877112,
          "min_order_subtotal": "40.0",
          "max_order_subtotal": null
        }
      ],
      "carrier_shipping_rate_providers": [
        {
          "id": 882078076,
          "carrier_service_id": 770241334,
          "flat_modifier": "0.0",
          "percent_modifier": 0,
          "service_filter": {
            "*": "+"
          },
          "shipping_zone_id": 881877112
        }
      ]
    }
  ]
}
Version 2019-10 (Release candidate)

You can use the ShippingZone resource to view shipping zones and their countries, provinces, and shipping rates. A shipping zone belongs to a delivery profile, which provides shops with the ability to create shipping rates per product variant and per location. For example, the merchant might want to use a shipping rate that applies only to fragile products. When querying the ShippingZone resource, each shipping zone is returned with its corresponding profile ID, location group ID, and countries. Its possible for the same country to exist in multiple shipping zones, if the shipping zones with overlapping countries have different delivery profiles.

What you can do with ShippingZone

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

ShippingZone 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.

profile_id
"profile_id": 163945

The ID of the shipping zone's delivery profile. Shipping profiles allow merchants to create product-based or location-based shipping rates.

location_group_id
"location_group_id": 32873

The ID of the shipping zone's location group. Location groups allow merchants to create shipping rates that apply only to the specific locations in the group.

countries
"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
"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": {
  "id": 882078077,
  "name": "$5 Shipping",
  "price": "5.00",
  "shipping_zone_id": 881877113,
  "min_order_subtotal": "40.0",
  "max_order_subtotal": null
}

Information about a price-based shipping rate.

  • id: The unique numeric identifier for the shipping rate.
  • name: The name of the shipping rate.
  • price: The price of the shipping rate.
  • shipping_zone_id: The unique numeric identifier for the associated shipping zone.
  • min_order_subtotal: The minimum price of an order for it to be eligible for the shipping rate.
  • max_order_subtotal: The maximum price of an order for it to be eligible for the shipping rate.
weight_based_shipping_rates
"weight_based_shipping_rates": {
  "id": 882078078,
  "name": "Canada Air Shipping",
  "price": "25.00",
  "shipping_zone_id": 881877113,
  "weight_low": 0.0,
  "weight_high": 11.02
}

Information about a weight-based shipping rate.

  • id: The unique numeric identifier for the shipping rate.
  • name: The name of the shipping rate.
  • price: The price of the shipping rate.
  • shipping_zone_id: The unique numeric identifier for the associated shipping zone.
  • weight_low: The minimum weight of an order for it to be eligible for the shipping rate.
  • weight_high: The maximum weight of an order for it to be eligible for the shipping rate.

Endpoints

GET /admin/api/2019-10/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/api/2019-10/shipping_zones.json
View Response
HTTP/1.1 200 OK
{
  "shipping_zones": [
    {
      "id": 1039932365,
      "name": "Some zone",
      "profile_id": "gid://shopify/DeliveryProfile/593363171",
      "location_group_id": "gid://shopify/DeliveryLocationGroup/955592433",
      "admin_graphql_api_id": "gid://shopify/DeliveryZone/881877112",
      "countries": [
        {
          "id": 817138619,
          "name": "United States",
          "tax": 0.0,
          "code": "US",
          "tax_name": "Federal Tax",
          "shipping_zone_id": 881877112,
          "provinces": [
            {
              "id": 1069646656,
              "country_id": 817138619,
              "name": "New York",
              "code": "NY",
              "tax": 0.0,
              "tax_name": "State Tax",
              "tax_type": null,
              "tax_percentage": 0.0,
              "shipping_zone_id": 881877112
            },
            {
              "id": 1069646657,
              "country_id": 817138619,
              "name": "Ohio",
              "code": "OH",
              "tax": 0.0,
              "tax_name": "State Tax",
              "tax_type": null,
              "tax_percentage": 0.0,
              "shipping_zone_id": 881877112
            }
          ]
        },
        {
          "id": 879921427,
          "name": "Canada",
          "tax": 0.05,
          "code": "CA",
          "tax_name": "GST",
          "shipping_zone_id": 881877112,
          "provinces": [
            {
              "id": 1069646654,
              "country_id": 879921427,
              "name": "Ontario",
              "code": "ON",
              "tax": 0.13,
              "tax_name": "HST",
              "tax_type": "harmonized",
              "tax_percentage": 13.0,
              "shipping_zone_id": 881877112
            },
            {
              "id": 1069646655,
              "country_id": 879921427,
              "name": "Quebec",
              "code": "QC",
              "tax": 0.09975,
              "tax_name": "QST",
              "tax_type": null,
              "tax_percentage": 9.975,
              "shipping_zone_id": 881877112
            }
          ]
        },
        {
          "id": 1070231512,
          "name": "Yemen",
          "tax": 0.0,
          "code": "YE",
          "tax_name": "GST",
          "shipping_zone_id": 881877112,
          "provinces": []
        }
      ],
      "weight_based_shipping_rates": [
        {
          "id": 882078075,
          "name": "Canada Air Shipping",
          "price": "25.00",
          "shipping_zone_id": 881877112,
          "weight_low": 0.0,
          "weight_high": 11.0231
        }
      ],
      "price_based_shipping_rates": [
        {
          "id": 882078074,
          "name": "$5 Shipping",
          "price": "5.05",
          "shipping_zone_id": 881877112,
          "min_order_subtotal": "40.0",
          "max_order_subtotal": null
        }
      ],
      "carrier_shipping_rate_providers": [
        {
          "id": 882078076,
          "carrier_service_id": 770241334,
          "flat_modifier": "0.0",
          "percent_modifier": 0,
          "service_filter": {
            "*": "+"
          },
          "shipping_zone_id": 881877112
        }
      ]
    }
  ]
}

Sign up for a Partner account to get started.

Sign up