Transporters and vehicles are the two foundational resources in TranslogiX. Every shipment is fulfilled by a transporter and, optionally, carried by a specific vehicle. This page explains the data model for each resource, how to manage them from the admin panel, and how transporter user accounts are linked to transporter records.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.
Transporters
Navigate to Admin → Transporters to see all registered transport companies. The list supports search by name, contact person, or phone number.Fields
| Field | Required | Description |
|---|---|---|
name | Yes | The company or individual name of the transporter. |
gstNumber | No | GST registration number. Optional but recommended for billing. |
contactPerson | Yes | Name of the primary contact at the transporter. |
phone | Yes | Contact phone number. |
email | No | Contact email address. Must be a valid email format if provided. |
status | Yes | Either active or inactive. Defaults to active on creation. |
Enabling and disabling transporters
Each transporter row in the list has a toggle button. Clicking it opens a confirmation dialog before applying the status change. Active transporters show a green toggle icon; inactive transporters show a gray toggle.Deactivating a transporter does not automatically unassign them from existing shipments. Any in-progress shipments remain linked to the transporter record.
Vehicles
Navigate to Admin → Vehicles to see all vehicles across all transporters. The list supports search by vehicle number, transporter name, or vehicle type. Admins see a Transporter column in the table; transporter-role users see only their own vehicles.Fields
| Field | Required | Description |
|---|---|---|
vehicleNumber | Yes | The registration or identification number of the vehicle. |
transporterId | Yes | The transporter company this vehicle belongs to. |
vehicleType | Yes | One of TRUCK, DUMPER, VAN, or OTHER. |
capacityKg | Yes | Maximum load capacity in kilograms. Must be a positive number. |
currentLocation | No | Free-text current location of the vehicle. |
status | Yes | One of AVAILABLE, BUSY, or MAINTENANCE. Defaults to AVAILABLE. |
lastMaintenanceDate | No | Date of the most recent maintenance service. |
Vehicle type badge colors
| Type | Badge color |
|---|---|
| TRUCK | Blue |
| DUMPER | Orange |
| VAN | Purple |
| OTHER | Gray |
Vehicle status
Vehicle status can be changed at any time from the inline dropdown in the list view.| Status | Meaning | Badge color |
|---|---|---|
| AVAILABLE | Ready to be assigned to a shipment. | Green |
| BUSY | Currently assigned to an active shipment. | Yellow |
| MAINTENANCE | Out of service for maintenance. | Red |
When a vehicle is assigned to a shipment — either at shipment creation or during an edit — the system automatically sets that vehicle’s status to
BUSY. When the shipment is marked DELIVERED, the vehicle is automatically reset to AVAILABLE. If a shipment is cancelled, the vehicle status is not automatically changed and may need to be manually reset.Linking user accounts to transporters
Users with theTRANSPORTER role are linked to a specific transporter record via the transporterId column on the users table. This foreign key relationship means:
- A TRANSPORTER user can only see and manage shipments assigned to their transporter.
- A TRANSPORTER user can only see vehicles that belong to their transporter.
- When a TRANSPORTER user creates a shipment, the shipment is automatically associated with their transporter — they cannot assign the shipment to a different transporter.