Skip to content
Courier docs

The streets a delivery follows between two points, as a line to draw.

GET
/v1/routes
curl --request GET \
  --url 'https://courierapi.itdlogisoft.co.uk/v1/routes?fromLatitude=1&fromLongitude=1&toLatitude=1&toLongitude=1' \
  --header 'Authorization: Basic <credentials>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
fromLatitude
required
number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/
fromLongitude
required
number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/
toLatitude
required
number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/
toLongitude
required
number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/
vehicle
string

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json

The line a delivery follows between two points, for a map to draw.

From GET /v1/routes. The distance and time are the same road network the price came from, so the line and the quote agree; the shape is every bend, in order, ready to be drawn.

object
distance_metres
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
duration_seconds
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
shape
required
Array<object>

One bend in a route.

object
latitude
required
number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/
longitude
required
number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

Example generated

{
  "distance_metres": 1,
  "duration_seconds": 1,
  "shape": [
    {
      "latitude": 1,
      "longitude": 1
    }
  ]
}

422

Section titled “422”

Unprocessable Entity

Media typeapplication/json

The shape of every refusal from this API.

string ApiError.Code is stable and machine-readable; string ApiError.Message is for a human reading a log and may change without notice. Integrators are told to branch on the code.

object
code
required
string
message
required
string

Example generated

{
  "code": "example",
  "message": "example"
}