Create Shipping Zone

POST

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

POST

/stores/:store_hash/v2/shipping/zones

curl -X POST https://api.bigcommerce.com/stores/store_hash/v2/shipping/zones \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "United States",
  "type": "zip",
  "locations": [
    {
      "zip": "11103",
      "country_iso2": "US"
    }
  ]
}'

201Type: ZIP

{
  "id": 1,
  "name": "United States",
  "type": "zip",
  "locations": [
    {
      "id": 3,
      "zip": "12345",
      "country_iso2": "US",
      "state_iso2": "TX"
    }
  ],
  "free_shipping": {
    "enabled": true,
    "minimum_sub_total": "0.0000",
    "exclude_fixed_shipping_products": true
  },
  "handling_fees": {
    "display_separately": true,
    "fixed_surcharge": "0"
  },
  "enabled": true
}

Creates a Shipping Zone.

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.

Request

This endpoint expects an object.

namestringRequired

Zone name. Required for PUT requests.

typeenumRequired

Allowed values:

locationslist of objectsOptional

Array of zone locations. BigCommerce has a platform limit of 40000 zip type locations.

free_shippingobjectOptional

handling_feesobjectOptional

enabledbooleanOptional

Whether this shipping zone is enabled.

Response

Created

idintegerOptional

Zone ID.

namestringOptional

Zone name.

typeenumOptional