Skip to content

List delivery patches

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

The postcode areas and towns each driver covers. A patch is given to drivers, and the van a driver takes adopts their patches when a round is planned.

Patches

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

UUID v7

string format: uuid
name
required
string
colour
required
string | null
/^#[0-9a-fA-F]{6}$/
areas
required
Array<string>
driverUserIds
required
Array<string>
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
Example
{
"items": [
{
"id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
"name": "North London",
"areas": [
"N",
"NW",
"E"
]
}
]
}

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

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