Shipping Rates
This is used to view, create, update and delete shipping rates within a particular shipping zone.
Shipping Rate Properties
| id |
{ "id" : 255 }
The unique ID of the shipping rate |
| country |
{ "country" : { "id": 222 } }
The Country object |
| state |
{ "state" : { "id": 255 } }
The State object |
| postcodes |
{ "postcodes" : [ "B", "M", "W", "B91", "W1U" ] }
An array of postcodes, only applicable for the UK country object and if the postcodes extension is installed |
| name |
{ "name" : "First Class" }
The name of the shipping rate |
| critera |
{ "criteria" : "price" }
Either price or weight, the default is price. |
| from |
{ "from" : 0.00 }
The from value for the rate |
| to |
{ "to" : 99.99 }
The to value for the rate, set as 0 for unlimited |
| cost |
{ "cost" : 4.95 }
The cost of the delivery rate |
| vatExclusive |
{ "vatExclusive" : true }
Either true or false (set to false if VAT is charged on the cost of shipping). |
What you can do with Shipping Rates
GET /v1/shipping-rates
Receive a list of all shipping rates
GET /v1/shipping-rates/count
Count the number of shipping rates
GET /v1/shipping-rates/ID
Receive a single shipping rate
POST /v1/shipping-rates
Create a new shipping rate
PUT /v1/shipping-rates/ID
Update a shipping rate
DELETE /v1/shipping-rates/ID
Delete a shipping rate
GET /v1/shipping-rates
Returns all shipping rates.
| embed | country, state, postcodes |
| fields | Comma separated list of properties to include |
GET /v1/shipping-rates
HTTP/1.1 200 OK
[
{
"id": 17,
"country": {
"id": 222
},
"name": "Free",
"criteria": "price",
"from": 0,
"to": 0,
"cost": 0,
"vatExclusive": false
}
]
GET /v1/shipping-rates/count
Returns a count of the shipping rates.
GET /v1/shipping-rates/count
HTTP/1.1 200 OK
{
"count": 99
}
GET /v1/shipping-rates/ID
Returns a single shipping rate.
| embed | country, state, postcodes |
| fields | Comma separated list of properties to include |
GET /v1/shipping-rates/1
HTTP/1.1 200 OK
{
"id": 17,
"country": {
"id": 222
},
"name": "API",
"criteria": "price",
"from": 100,
"to": 0,
"cost": 10,
"vatExclusive": false
}
POST /v1/shipping-rates
Creates a new shipping rate.
POST /v1/shipping-rates
POST /v1/shipping-rates
{
"country": 223,
"state": 37,
"name": "API",
"criteria": "weight",
"from": 10,
"to": 0,
"cost": 75,
"vatExclusive": true
}
POST /v1/shipping-rates
HTTP/1.1 201 Created
{
"id": 462,
"country": {
"id": 223
},
"state": {
"id": 37
},
"name": "API",
"criteria": "weight",
"from": 10,
"to": 0,
"cost": 75,
"vatExclusive": true
}
PUT /v1/shipping-rates/ID
Update a shipping rate. All object properties are allowed except the country property.
PUT /v1/shipping-rates/ID
PUT /v1/shipping-rates/462
{
"vatExclusive": false
}
PUT /v1/shipping-rates/ID
HTTP/1.1 200 OK
{
"id": 462,
"country": {
"id": 223
},
"state": {
"id": 37
},
"name": "API",
"criteria": "weight",
"from": 10,
"to": 0,
"cost": 75,
"vatExclusive": false
}
DELETE /v1/shipping-rates/ID
Deletes an existing shipping rate.
Returns 204 No Content on success.