List shipping zones
const url = 'https://apibase.ecomweb.app/api/v1/stores/example/shipping-zones?sort_order=asc';const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The store’s ref, as returned by GET /stores.
Query Parameters
Section titled “Query Parameters”Maximum number of zones to return.
Number of zones to skip.
Field to sort by: name, code, updated_at or created_at.
Sort direction.
Return only the zone with this ID.
Return only the zone with this code, ignoring case.
Return zones whose name contains this text, ignoring case.
Return zones that cover this province code.
Return zones that cover this ward code.
Include deleted zones.
Return zones whose name or code contains this text, ignoring case.
Responses
Section titled “Responses”object
object
Zone ID.
Short code of the zone, unique among the store’s zones. The code ALL is reserved for the catch-all zone.
Zone name.
Province codes the zone covers.
Ward codes the zone covers. A ward match wins over a province match.
True for the store’s automatic catch-all zone, which covers every address no other zone covers.
When the zone was created, as an ISO 8601 timestamp.
When the zone was last updated, as an ISO 8601 timestamp.
When the zone was deleted. Present only when deleted zones are included.
object
Total number of items matching the request.
Maximum number of items in this page.
Number of items skipped before this page.
Current page number, starting at 1.
Total number of pages.
Whether a next page exists.
Whether a previous page exists.
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.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The key is missing, invalid, revoked or expired.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
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.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}