Skip to content

Create a shipping zone

POST
/stores/{storeRef}/shipping-zones
curl --request POST \
--url https://apibase.ecomweb.app/api/v1/stores/example/shipping-zones \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--data '{ "code": "example", "name": "example", "provinces": [ "example" ], "wards": [ "example" ] }'

Creates a zone from a code, a name and the provinces and wards it covers. The code must be unique among the store’s zones and cannot be ALL, which is reserved for the catch-all zone every store gets automatically; a clash is refused with 400.

Required scopes: write:shippings

storeRef
required
string

The store’s ref, as returned by GET /stores.

Media typeapplication/json
object
code
required

Short code, unique among the store’s zones. ALL is reserved.

string
name
required

Zone name.

string
provinces

Province codes the zone covers.

Array<string>
wards

Ward codes the zone covers. A ward match wins over a province match.

Array<string>

Example generated

{
"code": "example",
"name": "example",
"provinces": [
"example"
],
"wards": [
"example"
]
}
Media typeapplication/json
object
id
required

Zone ID.

number
code
required

Short code of the zone, unique among the store’s zones. The code ALL is reserved for the catch-all zone.

string
name
required

Zone name.

string
provinces
required

Province codes the zone covers.

Array<string>
wards
required

Ward codes the zone covers. A ward match wins over a province match.

Array<string>
is_catch_all
required

True for the store’s automatic catch-all zone, which covers every address no other zone covers.

boolean
created_at

When the zone was created, as an ISO 8601 timestamp.

string
nullable
updated_at

When the zone was last updated, as an ISO 8601 timestamp.

string
nullable
deleted_at

When the zone was deleted. Present only when deleted zones are included.

string
nullable

Example generated

{
"id": 1,
"code": "example",
"name": "example",
"provinces": [
"example"
],
"wards": [
"example"
],
"is_catch_all": true,
"created_at": "example",
"updated_at": "example",
"deleted_at": "example"
}

The request is malformed or failed validation.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key is missing, invalid, revoked or expired.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}