Skip to content
Bottle

List bases

GET
/locations
curl --request GET \
  --url https://example.com/locations \
  --cookie bottle.session_token=<bottle.session_token>

The depots, and any home a driver takes the vehicle home. Removed ones are left out unless asked for.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
includeArchived

Include removed bases.

string

Include removed bases.

Responses

Section titled “Responses”

200

Section titled “200”

Locations

Media typeapplication/json
object
items
required
Array<object>
object
id
required

UUID v7

string format: uuid
kind
required
string
Allowed values: depot home
name
required
string
>= 1 characters <= 120 characters
line1
required
string
>= 1 characters <= 200 characters
city
required
string | null
<= 120 characters
postcode
required
string
>= 5 characters <= 8 characters
archivedAt
required
string | null format: date-time
latitude
required
number | null
longitude
required
number | null
geocodedAt
required
string | null format: date-time
postcodeDistrict
required
string | null
adminDistrict
required
string | null
adminCounty
required
string | null
region
required
string | null
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
Example
{
  "items": [
    {
      "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "kind": "depot",
      "name": "Yard",
      "postcode": "KT3 4BP",
      "postcodeDistrict": "KT3",
      "adminDistrict": "Kingston upon Thames",
      "adminCounty": "Surrey",
      "region": "London"
    }
  ]
}

401

Section titled “401”

Not signed in

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

403

Section titled “403”

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

422

Section titled “422”

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string
Example
{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}