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.

Anchor to section titled 'undefined'

ShippingZone

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.
Was this section helpful?
#Endpoints
Anchor to section titled 'The ShippingZone resource'

The ShippingZone resource

Properties
id
read-only
->id
The unique numeric identifier for the shipping zone.
name
read-only
->name
The name of the shipping zone, specified by the user.
profile_id
string
read-only
->id
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
read-only
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
read-only
->countries

A list of countries that belong to the shipping zone.

provinces
read-only
->provinces

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

carrier_shipping_rate_providers
read-only
->rateProvider
Information about carrier shipping providers and the rates used.
price_based_shipping_rates
array
read-only
->methodConditions

Information about a price-based shipping rate.

weight_based_shipping_rates
array
read-only
->methodConditions

Information about a weight-based shipping rate.

Was this section helpful?
{}The ShippingZone resource
{
  "id": 132,
  "name": "North America",
  "profile_id": "gid://shopify/DeliveryProfile/1234",
  "location_group_id": "gid://shopify/DeliveryLocationGroup/32873",
  "countries": {
    "id": 189,
    "shipping_zone_id": 132,
    "name": "Canada",
    "tax": 0.5,
    "code": "CA",
    "tax_name": "GST",
    "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
  },
  "carrier_shipping_rate_providers": [],
  "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
      }
    ]
  },
  "weight_based_shipping_rates": {
    "weight_based_shipping_rates": [
      {
        "id": 882078078,
        "name": "Canada Air Shipping",
        "price": "25.00",
        "shipping_zone_id": 881877113,
        "weight_low": 0,
        "weight_high": 11.02
      }
    ]
  }
}
Anchor to section titled 'GET request, Receive a list of all ShippingZones'

get
Receive a list of all ShippingZones

deliveryProfiles
Get a list of all shipping zones
Anchor to section titled 'Parameters of Receive a list of all ShippingZones'

Parameters

api_version
string
required
fields
Show only specific fields by providing a comma-separated list of field names.
Was this section helpful?
Anchor to section titled 'Examples of Receive a list of all ShippingZones'

Examples

Was this section helpful?
get
/admin/api/2024-10/shipping_zones.json
Copy
curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/shipping_zones.json" \
-H "X-Shopify-Access-Token: {access_token}"
{}Response
JSON
HTTP/1.1 200 OK
{
  "shipping_zones": [
    {
      "id": 44570466,
      "name": "Downtown Ottawa",
      "profile_id": "gid://shopify/DeliveryProfile/690933842",
      "location_group_id": "gid://shopify/DeliveryLocationGroup/694323328",
      "admin_graphql_api_id": "gid://shopify/DeliveryZone/44570466",
      "countries": [
        {
          "id": 359115488,
          "name": "Colombia",
          "tax": 0.15,
          "code": "CO",
          "tax_name": "VAT",
          "shipping_zone_id": 44570466,
          "provinces": []
        },
        {
          "id": 879921427,
          "name": "Canada",
          "tax": 0.05,
          "code": "CA",
          "tax_name": "GST",
          "shipping_zone_id": 44570466,
          "provinces": [
            {
              "id": 224293623,
              "country_id": 879921427,
              "name": "Quebec",
              "code": "QC",
              "tax": 0.09,
              "tax_name": "HST",
              "tax_type": "compounded",
              "tax_percentage": 9,
              "shipping_zone_id": 44570466
            },
            {
              "id": 702530425,
              "country_id": 879921427,
              "name": "Ontario",
              "code": "ON",
              "tax": 0.08,
              "tax_name": null,
              "tax_type": null,
              "tax_percentage": 8,
              "shipping_zone_id": 44570466
            }
          ]
        },
        {
          "id": 817138619,
          "name": "United States",
          "tax": 0,
          "code": "US",
          "tax_name": "Federal Tax",
          "shipping_zone_id": 44570466,
          "provinces": [
            {
              "id": 9350860,
              "country_id": 817138619,
              "name": "Massachusetts",
              "code": "MA",
              "tax": 0.065,
              "tax_name": null,
              "tax_type": null,
              "tax_percentage": 6.5,
              "shipping_zone_id": 44570466
            },
            {
              "id": 1013111685,
              "country_id": 817138619,
              "name": "New York",
              "code": "NY",
              "tax": 0.04,
              "tax_name": null,
              "tax_type": null,
              "tax_percentage": 4,
              "shipping_zone_id": 44570466
            }
          ]
        }
      ],
      "weight_based_shipping_rates": [
        {
          "id": 522512552,
          "name": "Free Under 5kg",
          "price": "0.00",
          "shipping_zone_id": 44570466,
          "weight_low": 0,
          "weight_high": 5
        }
      ],
      "price_based_shipping_rates": [
        {
          "id": 64051,
          "name": "Free Shipping",
          "price": "0.00",
          "shipping_zone_id": 44570466,
          "min_order_subtotal": null,
          "max_order_subtotal": "450"
        }
      ],
      "carrier_shipping_rate_providers": [
        {
          "id": 615128020,
          "carrier_service_id": 260046840,
          "flat_modifier": "",
          "percent_modifier": null,
          "service_filter": {
            "*": "+"
          },
          "shipping_zone_id": 44570466
        }
      ]
    }
  ]
}