Skip to content

List shipping zones

GET
/stores/{storeRef}/shipping-zones
curl --request GET \
--url 'https://apibase.ecomweb.app/api/v1/stores/example/shipping-zones?sort_order=asc' \
--header 'x-api-key: <x-api-key>'

Returns a page of the store’s shipping zones, newest first by default, excluding deleted zones. Filter by code, name, a province or ward code it contains, or search over name and code. Sort with sort_by (name, code, updated_at or created_at) and sort_order.

Required scopes: read:shippings

storeRef
required
string

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

limit
number

Maximum number of zones to return.

offset
number

Number of zones to skip.

sort_by
string

Field to sort by: name, code, updated_at or created_at.

sort_order
string
Allowed values: asc desc

Sort direction.

id
number

Return only the zone with this ID.

code
string

Return only the zone with this code, ignoring case.

name
string

Return zones whose name contains this text, ignoring case.

province
string

Return zones that cover this province code.

ward
string

Return zones that cover this ward code.

include_deleted
boolean

Include deleted zones.

search
string

Return zones whose name or code contains this text, ignoring case.

Media typeapplication/json
object
data
required
Array<object>
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
meta
required
object
total
required

Total number of items matching the request.

number
limit
required

Maximum number of items in this page.

number
offset
required

Number of items skipped before this page.

number
page
required

Current page number, starting at 1.

number
totalPages
required

Total number of pages.

number
hasNext
required

Whether a next page exists.

boolean
hasPrev
required

Whether a previous page exists.

boolean

Example generated

{
"data": [
{
"id": 1,
"code": "example",
"name": "example",
"provinces": [
"example"
],
"wards": [
"example"
],
"is_catch_all": true,
"created_at": "example",
"updated_at": "example",
"deleted_at": "example"
}
],
"meta": {
"total": 1,
"limit": 1,
"offset": 1,
"page": 1,
"totalPages": 1,
"hasNext": true,
"hasPrev": true
}
}

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"
}