Create a shipping zone
const url = 'https://apibase.ecomweb.app/api/v1/stores/example/shipping-zones';const options = { method: 'POST', headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'}, body: '{"code":"example","name":"example","provinces":["example"],"wards":["example"]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The store’s ref, as returned by GET /stores.
Request Bodyrequired
Section titled “Request Bodyrequired”object
Short code, unique among the store’s zones. ALL is reserved.
Zone name.
Province codes the zone covers.
Ward codes the zone covers. A ward match wins over a province match.
Example generated
{ "code": "example", "name": "example", "provinces": [ "example" ], "wards": [ "example" ]}Responses
Section titled “Responses”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.
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.
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"}