The places a typed address most likely means, best first.

GET

/v1/places

curl --request GET \
  --url 'https://courierapi.itdlogisoft.co.uk/v1/places?limit=5' \
  --header 'Authorization: Basic <credentials>'

Authorizations

• merchantKey

Parameters

Query Parameters

q

string

nearLatitude

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

nearLongitude

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

limit

integer | string format: int32

default: 5 /^-?(?:0|[1-9]\d*)$/

Responses

200

OK

Media typeapplication/json

Array<object>

Somewhere a person typed, resolved to a point on the map.

From GET /v1/places?q=…, which exists for forms rather than for integrations: an ordering system already holds its customers’ coordinates, and a person at a portal does not. What comes back is a suggestion to pick from, never something to book against unseen.

object

name

required

string

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+)?$/

postcode

required

null | string

Example ^generated

[
  {
    "name": "example",
    "latitude": 1,
    "longitude": 1,
    "postcode": "example"
  }
]

503

Service Unavailable

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"
}