Zones

List, read, create, update and delete zones, the named groups of countries that shipping rules apply to.

A zone is a named group of countries. Shipping rules name zones in their configuration. These endpoints list, read, create, update and delete zones. This area has 5 endpoints, each available in all seven SDKs.

At a glance

Endpoint	Method	Path	What it does
List zones	GET	/settings/zones	Returns a page of zones.
Create a zone	POST	/settings/zones	Creates a zone from a name and a list of countries, and returns it.
Retrieve a zone	GET	/settings/zones/{zone_id}	Returns one zone by its id.
Delete a zone	DELETE	/settings/zones/{zone_id}	Deletes a zone. A successful call returns 204 with no body.
Update a zone	PATCH	/settings/zones/{zone_id}	Sends changes to a zone and returns the zone.

Before you call

Register your API credentials once when your app starts, as shown in Authentication. Every SDK sample on these pages then gets its client in one line. With cURL, send the access token in an Authorization header: Authorization: Bearer $ACCESS_TOKEN.

Things to know

• A zone needs at least one country. country_list takes country id values, the country_ ids that GET /settings/countries returns.
• Writes are wrapped in zone, and one zone comes back under zone. A new zone’s display_name is set from its name.
• Zone ids are prefixed with zn_. A shipping rule configuration names a zone by its UUID with dashes instead, built from the 32 hex digits after zn_; see Set a shipping rule’s configuration.
• The listing pages by cursor. Pass limit, then send the next_cursor from pagination as cursor until has_more is false.