Skip to content
Bottle

Delivery areas to offer drivers

GET
/rounds/learned/area-suggestions
curl --request GET \
  --url https://example.com/rounds/learned/area-suggestions \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token>

Postcode districts and areas drivers really deliver to that their delivery areas leave out, with stop counts from the last 8 weeks. Nothing changes until the owner adds one.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

The suggestions, busiest first

Media typeapplication/json
object
items
required
Array<object>
object
driverUserId
required
string
driverName
required
string
term
required
string
kind
required
string
Allowed values: district area
stops
required
integer
> 0
districts
required
Array<string>

Example 

{
  "items": [
    {
      "kind": "district"
    }
  ]
}

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 the owner in the office app, or on a plan without rounds

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

404

Section titled “404”

Not found

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

409

Section titled “409”

The words can’t be kept, with the reason

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