Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/fatelessdev/translogiX/llms.txt

Use this file to discover all available pages before exploring further.

The driver dashboard is the operational interface for drivers working within a transporter company. Drivers see only the shipments that belong to their linked transporter — not shipments from any other company. This page covers the dashboard overview stats, the shipments view, status update capabilities, and how to post location updates.
A driver account must be linked to a transporter company via the transporterId field. If no transporter is linked, the dashboard displays a message asking the driver to contact their administrator. Without this link, no shipment data is accessible.

Dashboard overview

When a driver signs in, the dashboard (/driver) displays a personalised welcome and a summary of their transporter company’s shipment activity.

Total Shipments

The total number of shipments ever assigned to the driver’s transporter company.

In Transit

Shipments currently in the IN_TRANSIT status.

Picked Up

Shipments with the PICKED_UP status — collected but not yet in transit.

Delivered

Shipments that have been marked DELIVERED.
A card beneath the stats provides a direct link to View Shipments at /driver/shipments.

Shipments view

The shipments page (/driver/shipments) shows all shipments assigned to the driver’s transporter company. Drivers cannot create new shipments — this view is read and update only.

Table columns

ColumnDescription
Package CodeUnique shipment identifier (e.g. PKG-001).
SourcePickup origin of the shipment.
DestinationDelivery destination.
StatusCurrent shipment status with a colour-coded badge and interactive dropdown for allowed transitions.
VehicleVehicle number assigned to the shipment, or “Not assigned” if none.
ActionsButtons to add a location update or mark the shipment as delivered.

Searching shipments

A search bar above the table filters shipments in real time by package code, source location, or destination.

Updating shipment status

Drivers can advance a shipment through its lifecycle using the status dropdown in the table. The allowed transitions are the same as for transporter users:
CREATED → ASSIGNED, CANCELLED
ASSIGNED → PICKED_UP, CANCELLED
PICKED_UP → IN_TRANSIT, CANCELLED
IN_TRANSIT → DELIVERED, CANCELLED
DELIVERED and CANCELLED are terminal states — once a shipment reaches either status, no further changes are possible.

Marking a shipment as delivered

When a shipment is IN_TRANSIT, a Mark Delivered button appears in the Actions column. Clicking it opens a confirmation dialog. To confirm, type DELIVER in the text field, then click Mark as Delivered.
Marking a shipment as delivered is irreversible. The status cannot be changed after it reaches DELIVERED.
When a shipment is marked delivered, its assigned vehicle is automatically set back to AVAILABLE.

Adding location updates

For any shipment that is not yet delivered or cancelled, a Location button appears in the Actions column. Clicking it opens the Add Location Update dialog.
1

Click Location on a shipment row

Find the shipment in the table and click the Location button in the Actions column. This opens the location update form.
2

Enter a location description

In the Location field, type a human-readable description of the shipment’s current position — for example, Arrived at Dallas distribution center. This field is required.
3

Optionally add coordinates

You can optionally provide Latitude (−90 to 90) and Longitude (−180 to 180) values for precise geographic tracking. Both fields accept decimal values and are not required.
4

Submit the update

Click Submit Update. The location entry is saved with a timestamp and immediately becomes visible on the public tracking page for this shipment.
Location updates are visible to anyone tracking the shipment at /track/[packageCode] — no login is required to view them. Add updates whenever the shipment reaches a notable checkpoint to give recipients accurate visibility.

Data isolation

Drivers are always scoped to their linked transporter. The API at GET /api/driver/shipments enforces this server-side: it reads transporterId from the authenticated session and applies it as a mandatory filter. It is not possible to view or modify shipments belonging to another transporter company. Status updates (PATCH /api/driver/shipments/[id]/status) and tracking posts (POST /api/driver/shipments/[id]/tracking) perform the same check — if the shipment’s transporterId does not match the driver’s, the request is rejected with a 403 Forbidden response.

Build docs developers (and LLMs) love