Skip to content
Bottle

Get today's overview

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

Today’s rounds and everything waiting on a decision, in one call. An owner or admin gets the yard: every round, orders with nobody carrying them, drops that failed, refunds owed, vehicles due at the garage. A driver gets their own round and nothing else, because the state of somebody else’s van is not their business.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
date

The day. Defaults to today.

string format: date

The day. Defaults to today.

Responses

Section titled “Responses”

200

Section titled “200”

The day

Media typeapplication/json
object
date
required
string format: date
view
required
string
Allowed values: yard cab
rounds
required
Array<object>
object
id
required
string
vehicleName
required
string | null
driverName
required
string | null
status
required
string
Allowed values: planned out done
issuedAt
required
string | null format: date-time
stops
required
integer
done
required
integer
failed
required
integer
departsAt
required
string | null
/^([01]\d|2[0-3]):[0-5]\d$/
backAt
required
string | null
/^([01]\d|2[0-3]):[0-5]\d$/
over
required
Array<string>
attention
required
Array<object>
object
kind
required
string
Allowed values: ordersWaiting ordersToCollect ordersUnplaced roundsUnsent dropsFailed ordersPartlyDelivered refundsDue vehiclesDue duplicateCustomers timeOffWaiting cashToCollect cashCarriedTooLong deliveredUnpaid stripePaused stripeNeeds
count
required
integer
href
required
string
drops
required
object
total
required
integer
done
required
integer
failed
required
integer
ordersTaken
required
integer
cashOwedPence
required
integer
money
required
object
cashTodayPence
required
integer
cashMonthPence
required
integer
invoicesToday
required
integer
invoicedTodayPence
required
integer
invoicesMonth
required
integer
invoicedMonthPence
required
integer
Example
{
  "view": "yard",
  "rounds": [
    {
      "status": "planned",
      "departsAt": "07:30",
      "backAt": "07:30"
    }
  ],
  "attention": [
    {
      "kind": "ordersWaiting"
    }
  ]
}

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