The Shipments section of the admin panel lets you manage the full lifecycle of every shipment in the system. From this page you can search existing shipments, create new ones, update their details, and advance them through the status workflow — all without leaving the browser.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.
Shipments list view
Navigate to Admin → Shipments to see all shipments in a paginated table. The table columns are: Package Code, Source, Destination, Material, Gross Wt (kg), Qty, Status, Transporter, Vehicle, and Actions.Searching shipments
A search bar at the top of the list filters shipments as you type (with a 300 ms debounce). The search matches against three fields:- Package code
- Source location
- Destination location
Creating a shipment
Click Add Shipment (top-right of the list) to open the new shipment form at/admin/shipments/new.
Fill in required fields
All of the following fields must be provided before the form can be submitted:
| Field | Description |
|---|---|
packageCode | Unique identifier for the shipment. Must not already exist in the system. |
source | Plain-text origin location (e.g., city name or warehouse address). |
destination | Plain-text delivery destination. |
materialType | Description of the cargo (e.g., “Steel Coils”, “Electronics”). |
grossWeightKg | Total gross weight in kilograms. Must be a positive number. |
quantity | Number of units in the shipment. Must be a positive whole number. |
pickupDate | Scheduled pickup date. |
deliveryDeadline | Deadline by which the shipment must be delivered. Must be on or after the pickup date. |
Fill in optional fields
The following fields are optional and can be left blank:
| Field | Description |
|---|---|
tareWeightKg | Tare (empty container) weight in kilograms. |
transporterId | Pre-assign a transporter from the dropdown. |
vehicleId | Pre-assign a vehicle. Assigning a vehicle immediately sets that vehicle’s status to BUSY. |
routeId | Link a pre-configured route to the shipment for distance and estimated time data. |
Assigning a vehicle at creation time automatically sets that vehicle’s status to
BUSY in the database. This prevents double-booking the same vehicle.Viewing a shipment
Click the edit icon on any row, or navigate directly to/admin/shipments/{id}, to open the shipment detail page. The detail page shows all fields, the assigned transporter and vehicle, route information (origin, destination, distance, estimated time), and a full tracking history timeline ordered from newest to oldest.
Updating a shipment
Click the pencil icon on any row to open the edit form at/admin/shipments/{id}/edit. All fields from the create form are available for editing.
Status transitions
Status can also be changed directly from the list view using the inline dropdown in the Status column. The system enforces a strict one-way transition graph — you can only move a shipment forward (or cancel it). Terminal statuses (DELIVERED, CANCELLED) show a read-only badge instead of a dropdown.| Current status | Allowed next statuses |
|---|---|
| CREATED | ASSIGNED, CANCELLED |
| ASSIGNED | PICKED_UP, CANCELLED |
| PICKED_UP | IN_TRANSIT, CANCELLED |
| IN_TRANSIT | DELIVERED, CANCELLED |
| DELIVERED | (terminal — no further transitions) |
| CANCELLED | (terminal — no further transitions) |
Status badge colors
Each status is rendered with a consistent color throughout the admin panel:| Status | Badge color |
|---|---|
| CREATED | Gray |
| ASSIGNED | Blue |
| PICKED_UP | Yellow |
| IN_TRANSIT | Orange |
| DELIVERED | Green |
| CANCELLED | Red |