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 transporter dashboard is the central workspace for logistics companies using TranslogiX. It gives transporter users a scoped view of their own company’s shipments and fleet — no other company’s data is ever accessible. This page explains the dashboard overview, the shipments list, and the vehicles section.
All data shown in the transporter dashboard is filtered server-side by the authenticated user’s transporterId. It is not possible to access another company’s shipments or vehicles by modifying requests.

Dashboard overview

When a transporter user signs in, the dashboard (/transporter) greets them by name and displays a summary of their company’s shipment activity across four stat cards.

Total Shipments

The total count of all shipments ever assigned to your transporter, regardless of status.

In Transit

Shipments currently in the IN_TRANSIT status — actively moving to their destination.

Picked Up

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

Delivered

Shipments that have reached their destination and been marked DELIVERED.
A quick-link card at the bottom of the overview navigates directly to the full shipments list at /transporter/shipments.

Shipments

The shipments section (/transporter/shipments) lists every shipment assigned to your transporter. Transporter users can also create new shipments from this view — newly created shipments are automatically scoped to the authenticated user’s company.

Table columns

ColumnDescription
Package CodeThe unique identifier for the shipment (e.g. PKG-001).
SourceThe pickup origin of the shipment.
DestinationThe delivery destination.
MaterialThe type of material being transported.
Gross Wt (kg)Gross weight of the shipment in kilograms.
QtyNumber of units in the shipment.
StatusCurrent shipment status with a colour-coded badge (see below).
TransporterThe name of your transporter company.
VehicleThe vehicle number assigned to the shipment, if any.
ActionsAn edit button to open the shipment details form.

Searching shipments

A search bar above the table lets you filter shipments in real time. The search matches against:
  • Package code
  • Source location
  • Destination location
Results update automatically as you type (with a short debounce delay).

Shipment statuses

Shipments move through a fixed sequence of statuses. The status column is an interactive dropdown for non-terminal states, allowing you to advance a shipment to its next valid state.
StatusMeaningBadge colour
CREATEDShipment record created, not yet assigned.Grey
ASSIGNEDVehicle assigned, ready for pickup.Blue
PICKED_UPShipment collected from source.Yellow
IN_TRANSITShipment actively moving to destination.Orange
DELIVEREDShipment delivered. Terminal — cannot be changed.Green
CANCELLEDShipment cancelled. Terminal — cannot be changed.Red
Valid transitions are:
CREATED → ASSIGNED, CANCELLED
ASSIGNED → PICKED_UP, CANCELLED
PICKED_UP → IN_TRANSIT, CANCELLED
IN_TRANSIT → DELIVERED, CANCELLED
When a vehicle is assigned to a shipment, its status is automatically set to BUSY. When the shipment is marked DELIVERED, the vehicle reverts to AVAILABLE.

Vehicles

The vehicles section (/transporter/vehicles) lists all vehicles registered under your transporter company. The Transporter column shown in the admin view is hidden here, since all vehicles belong to the same company.

Table columns

ColumnDescription
Vehicle NumberThe registration or identifier for the vehicle.
TypeVehicle category: TRUCK, DUMPER, VAN, or OTHER.
Capacity (kg)Maximum load capacity in kilograms.
StatusCurrent operational status (see below).
LocationLast recorded location of the vehicle, if set.
ActionsAn edit button to open the vehicle details form.

Vehicle statuses

The status column is an interactive dropdown. You can change a vehicle’s status at any time from this view.
StatusMeaningBadge colour
AVAILABLEVehicle is free and can be assigned to a shipment.Green
BUSYVehicle is currently assigned to an active shipment.Yellow
MAINTENANCEVehicle is undergoing maintenance and unavailable.Red

Searching vehicles

A search bar above the vehicle table lets you filter by vehicle number, transporter name, or vehicle type.

Adding vehicles

Use the Add Vehicle button in the top-right of the vehicles page to register a new vehicle. New vehicles are automatically associated with your transporter company.
Transporters can only view and manage vehicles that belong to their own company. Vehicles registered under other transporters are never returned by the API.

Build docs developers (and LLMs) love