Shipping Zones
This is used to view, create, update and delete shipping zones.
Shipping Zone Properties
| country | Country Object |
| vat | Whether VAT should be charged |
When creating a shipping zone, the country property should be specified as the country ID.
| country | Country ID |
What you can do with Shipping Zones
GET /v1/shipping-zones
Receive a list of all shipping zones
GET /v1/shipping-zones/count
Count the number of shipping zones
GET /v1/shipping-zones/country-id
Receive a single shipping zone
POST /v1/shipping-zones
Create a new shipping zone
PUT /v1/shipping-zones/country-id
Update a shipping zone
DELETE /v1/shipping-zones/country-id
Delete a shipping zone
GET /v1/shipping-zones
Returns a list of all shipping zones.
| embed | country |
| fields | Comma separated list of properties to include |
GET /v1/shipping-zones
HTTP/1.1 200 OK
[
{
"country": {
"id": 253
},
"vat": false
}
]
GET /v1/shipping-zones/count
Returns a count of the shipping zones
GET /v1/shipping-zones/count
HTTP/1.1 200 OK
{
"count": 99
}
GET /v1/shipping-zones/country-id
Returns a single shipping zone.
| embed | country |
| fields | Comma separated list of properties to include |
GET /v1/shipping-zones/country-id
HTTP/1.1 200 OK
{
"country": {
"id": 222
},
"vat": true
}
POST /v1/shipping-zones
Creates a new shipping zone.
| country |
{ "country" : 222 }
The unique ID for the country |
| vat |
{ "vat" : true }
Whether VAT should be charged to customers selecting the shipping zone, either true or false. |
POST /v1/shipping-zones
POST /v1/shipping-zones
{
"country": 222,
"vat": true
}
POST /v1/shipping-zones
HTTP/1.1 201 Created
{
"country": {
"id": 222
},
"vat": true
}
PUT /v1/shipping-zones/country-id
Updates an existing shipping zone.
| vat |
{ "vat" : true }
Whether VAT should be charged to customers selecting the shipping zone, either true or false. |
PUT /v1/shipping-zones/country-id
PUT /v1/shipping-zones/222
{
"vat": false
}
PUT /v1/shipping-zones/country-id
HTTP/1.1 200 OK
{
"country": {
"id": 222
},
"vat": false
}
DELETE /v1/shipping-zones/country-id
Deletes an existing shipping zone.
Returns 204 No Content on success.