Create Shipping Zone | BigCommerce Developer Center

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.

### 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](/developer/docs/overview/api-accounts#api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

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

idinteger

Zone ID.

namestring

Zone name.

typeenum

Allowed values:

locationslist of objects

Array of zone locations.

free_shippingobject

handling_feesobject

enabledboolean

Whether this shipping zone is enabled.

1	import requests
2
3	url = "https://api.bigcommerce.com/stores/store_hash/v2/shipping/zones"
4
5	payload = {
6	"name": "Mexico",
7	"type": "country",
8	"locations": [{ "country_iso2": "MX" }]
9	}
10	headers = {
11	"X-Auth-Token": "<apiKey>",
12	"Content-Type": "application/json"
13	}
14
15	response = requests.post(url, json=payload, headers=headers)
16
17	print(response.json())

1	{
2	"id": 1,
3	"name": "United States",
4	"type": "zip",
5	"locations": [
6	{
7	"id": 3,
8	"zip": "12345",
9	"country_iso2": "US",
10	"state_iso2": "TX"
11	}
12	],
13	"free_shipping": {
14	"enabled": true,
15	"minimum_sub_total": "0.0000",
16	"exclude_fixed_shipping_products": true
17	},
18	"handling_fees": {
19	"fixed_surcharge": "0",
20	"display_separately": true
21	},
22	"enabled": true
23	}