Search the documentation

Find a page by title or section.

Concepts

Object model

The nouns every other page is written in terms of, and how they relate.

Updated

Cooriroo models delivery work as a small set of objects. Almost every screen, endpoint and permission in the product names one of them, so this page is worth reading before anything else.

Tenants own everything

Tenant is the top-level isolation unit. Every other object belongs to exactly one tenant, and the database enforces that with row-level security rather than trusting the application to filter correctly. You never pass a tenant id to the API: it comes from your credentials.

People

User covers everyone who signs in. A user is one of three types — SuperAdmin, Admin or Driver — and carries roles on top of that. Roles are hierarchical and grant resource:action permissions, so "can edit vehicles" is a permission, not a user type.

Work

A Trip is one journey a driver makes. It holds an ordered list of TripStops, each of which is a pickup, a delivery or a transfer at one location. Work to be done — scan this, photograph that, collect a signature — hangs off a stop as a Task. Tasks can also stand alone, with no trip at all.

OriginDestination
What it isWhere goods come fromWhere goods go
Typical exampleWarehouse, restaurant, hubCustomer address, drop point
GeofenceOptionalOptional, drives arrival detection
ContactsYesYes, and they receive proof of delivery
The two location types, which are not interchangeable.

Fleet

A Vehicle carries features and a status. Its maintenance history is made of WorkOrders and Inspections, and those feed the fleet health score rather than being filed and forgotten.

Terminology

Your organisation can rename these. If your screens say something else, this is what they mean here.

Trip
One journey with an ordered list of stops. Some tenants call these routes, runs or jobs.Rename it in Settings → Terminology
Destination
A place goods are delivered to. Some tenants call these sites, stops or customers.Rename it in Settings → Terminology
Driver
The person carrying out a trip. Some tenants call these operators, couriers or crew.Rename it in Settings → Terminology