Skip to content
Bottle

Get today's overview

GET
/overview
curl --request GET \
  --url 'https://example.com/overview?range=day' \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token>

Today’s rounds, short-period order and money totals, and everything waiting on a decision, in one call. An owner or admin gets the yard, including exact MOT, service, driving-licence and low-stock checks. A driver gets their own round and nothing else, because the state of somebody else’s vehicle 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.

range

Order and money range. Live attention, safety checks and payment-provider balances are always current.

string
Allowed values: day workingWeek sevenDays

Order and money range. Live attention, safety checks and payment-provider balances are always current.

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
roundDate
string format: date
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 shopOrdersHeld roundsUnsent dropsFailed ordersPartlyDelivered refundsDue vehiclesDue driverLicencesDue stockLow duplicateCustomers timeOffWaiting cashToCollect cashCarriedTooLong deliveredUnpaid paymentProviderPaused paymentProviderNeeds stripePaused stripeNeeds transfersToday transfersToCollect transfersOnTheirWay transfersUnplanned transfersOverdue transfersNotDelivered suppliesDueToday suppliesLate tradeApplications
count
required
integer
href
required
string
priority
required
string
Allowed values: today soon
detail
object
driverName
required
string | null
what
required
string
toName
required
string
carrierName
string | null
day
required
string | null format: date
activity
required
object
range
required
string
Allowed values: day workingWeek sevenDays
from
required
string format: date
to
required
string format: date
otherOrders
required
integer
shopOrders
required
integer
shopEnabled
required
boolean
checks
required
object
vehicles
required
Array<object>
object
name
required
string
dueOn
required
string format: date
state
required
string
Allowed values: soon overdue
kind
required
string
Allowed values: mot service
licences
required
Array<object>
object
name
required
string
dueOn
required
string format: date
state
required
string
Allowed values: soon overdue
lowStock
required
Array<object>
object
productName
required
string
locationName
required
string | null
full
required
integer
minimumFull
required
integer
drops
required
object
total
required
integer
done
required
integer
failed
required
integer
ordersTaken
required
integer
cashOwedPence
required
integer
money
required
object
range
required
string
Allowed values: day workingWeek sevenDays
from
required
string format: date
to
required
string format: date
orders
required
integer
orderedPence
required
integer
cashPence
required
integer
invoices
required
integer
invoicedPence
required
integer

Example 

{
  "view": "yard",
  "rounds": [
    {
      "status": "planned",
      "departsAt": "07:30",
      "backAt": "07:30"
    }
  ],
  "attention": [
    {
      "kind": "ordersWaiting",
      "priority": "today"
    }
  ],
  "activity": {
    "range": "day"
  },
  "checks": {
    "vehicles": [
      {
        "state": "soon",
        "kind": "mot"
      }
    ],
    "licences": [
      {
        "state": "soon"
      }
    ]
  },
  "money": {
    "range": "day"
  }
}

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