List Shipping Zones

GET

https://api.bigcommerce.com/stores/:store_hash/v2/shipping/zones

GET

/stores/:store_hash/v2/shipping/zones

curl https://api.bigcommerce.com/stores/store_hash/v2/shipping/zones \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>"

[
  {
    "id": 1,
    "name": "United States",
    "type": "country",
    "locations": [
      {
        "id": 5,
        "country_iso2": "US"
      }
    ],
    "free_shipping": {
      "enabled": false,
      "minimum_sub_total": "0.0000",
      "exclude_fixed_shipping_products": false
    },
    "enabled": true
  },
  {
    "id": 2,
    "name": "Australia",
    "type": "country",
    "locations": [
      {
        "id": 6,
        "country_iso2": "AU"
      }
    ],
    "free_shipping": {
      "enabled": false,
      "minimum_sub_total": "0.0000",
      "exclude_fixed_shipping_products": false
    },
    "enabled": true
  }
]

Returns a list of all Shipping Zones.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Information & Settings	modify	`store_v2_information`
Information & Settings	read-only	`store_v2_information_read_only`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

Path parameters

store_hashstringRequired

Permanent ID of the BigCommerce store.

Response

idintegerOptional

Zone ID

namestringOptional

Zone name. Required for PUT requests.

typeenumOptional

Allowed values:

locationslist of objectsOptional

Array of zone locations.

free_shippingobjectOptional

handling_feesobjectOptional

enabledbooleanOptional

Whether this shipping zone is enabled.