Get Quote
The 'Get quote' service allows for obtaining shipping quotes from carriers integrated with Ship2Anywhere. It provides general information concerning possible shipments.
Request
| Quote | ||
|---|---|---|
| URI | /quote/ | |
| Method |
POST |
|
| Authorization | optional | |
Parameters
| Name | Required | Type | Description |
collection_country |
required | string - two letter country code | Two letter country code eg.: AU, US, CA etc. |
collection_postcode |
required | string | Postcode string: 3000, 2000, 4007 etc. |
collection_city |
required | string | String with city name |
delivery_country |
required | string - two letter country code | Two letter country code eg.: AU, US, CA etc. |
delivery_postcode |
required | string | Postcode string: 3000, 2000, 4007 etc. |
delivery_city |
required | string | String with city name |
packages[] |
required | list | Packages list, minimum size 1. |
packages[].length |
required | decimal number | Package's length |
packages[].width |
required | decimal number | Package's width |
packages[].height |
required | decimal number | Package's height |
packages[].weight |
required | decimal number | Package's weight |
packages[].unit |
required | string - 'cm' or 'in' | Centimetres/Kilograms 'cm' or Inches/Pounds 'in' |
insurance |
optional | decimal number | Insurance amount - optional parameter |
value |
optional | decimal number | Value of goods as decimal number. |
currency |
required | string - 3 letter currency code | Currency code. For now we support only AUD. |
Request body
{ "request": { "collection_country": "AU", "collection_postcode": "3000", "collection_city": "Melbourne", "delivery_country": "US", "delivery_postcode": "90210", "delivery_city": "Beverly Hills", "packages": [ { "length": 10, "width": 20, "height": 30, "weight": 3, "unit": "cm" }, { "length": 23, "width": 34, "height": 44, "weight": 9, "unit": "cm" } ], "currency": "AUD","value": "356", "insurance": "true" }} |
Request - single package
In cases where the quote is performed for a single package, the GET method is permitted for simplification. Parameters are the same as for a POST request, they just describe a single package and are not structured, See examples below.
| Quote | ||
|---|---|---|
| URI | /quote/ | |
| Method | GET | |
| Authorization | optional | |
Examples
-
From Australia Melbourne(3000) to USA Washington (20001)
-
From Australia Melbourne(3000) to Australia Sydney(2000), with custom insurance
Response
{
"message": "OK",
"code": 200,
"result": {
"services": [
{
"price": {
"currency": "AUD",
"amount": 177.48,
"total": 177.48,
"gst": 0,
"insurance": 0
},
"code": "7001",
"name": "Packet",
"global_mail": true,
"carrier": "GlobalMail"
},
{
"price": {
"currency": "AUD",
"amount": 175.43,
"total": 175.43,
"gst": 0,
"insurance": 0
},
"code": "7002",
"name": "Packet Plus",
"global_mail": true,
"carrier": "GlobalMail"
},
{
"price": {
"currency": "AUD",
"amount": 424.89,
"total": 424.89,
"gst": 0,
"insurance": 0
},
"code": "1002",
"name": "EXPRESS WORLDWIDE",
"global_mail": false,
"carrier": "DHL Asia"
}
]
}
}