Create shipping zone (V2)

Creates a v2 shipping zone for the site from the given name, locations, subzones, and pickup locations, plus an optional Easyship automated shipping flag. An empty locations list makes the zone the account's international catch-all; postal code scoping and shipping methods live in each subzone rather than on the zone itself, so a zone with no postal scoping states that as a single subzone with no patterns. Returns the created zone.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The site's unique name (its ID), returned when the site is created.

Body Params

The whole content of a v2 shipping zone. Unlike Snipcart.Api.Web.External.Dtos.Requests.Shipping.ExternalCreateShippingZoneRequestDto, postal
code scoping and shipping methods live in subzones rather than on the zone itself, so a zone that does not
scope by postal code states that as a single subzone with no patterns.

string
required
length between 1 and 400

Merchant-facing internal name of the shipping zone.

locations
array of objects
required

Locations where the shipping zone applies. Required: an explicitly empty list makes the zone the account's
international catch-all, of which an account can hold only one, so omitting the property is rejected
rather than read as that.

locations*
subzones
array of objects
required
length between 1 and 50

Subzones scoping postal code patterns and the shipping methods they own. At least one is required.

subzones*

A subzone of a v2 shipping zone: the postal code patterns it scopes, and the shipping methods offered inside
them. Patterns may not overlap across the subzones of a zone.

postal_codes_patterns
array of strings, unique
required
length ≤ 50000

Postal codes, and partial postal code patterns ending with '*', scoped to this subzone. Empty means the
subzone applies to every postal code its zone covers.

postal_codes_patterns*
shipping_methods
array of objects
required

Shipping methods offered by this subzone. A subzone with no method offers no way to ship, which is how a
merchant excludes the postal codes it scopes.

shipping_methods*
boolean

Enables live rates by Easyship for this shipping zone if the store is already configured with Easyship.

pickup_locations
array of objects
required
length ≤ 50

Pickup locations this shipping zone offers at checkout.

pickup_locations*
Responses

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json