Skip to content

Suggest postcodes

GET
/geocode/postcodes
curl --request GET \
--url 'https://example.com/geocode/postcodes?q=example' \
--cookie bottle.session_token=<bottle.session_token>

Postcodes that begin the way somebody has typed so far, up to eight, for a form to offer as they type. Empty for fewer than two characters, and empty when the postcode service is off or down.

q
required
string
<= 10 characters

Suggestions

Media typeapplication/json
object
items
required
Array<string>
Examplegenerated
{
"items": [
"example"
]
}

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
"error": "not_found",
"message": "Customer not found"
}

Not a member, or without the permission this needs

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
"error": "not_found",
"message": "Customer not found"
}