Routes define pre-configured origin-to-destination lanes used across your logistics network. Each route stores distance and estimated transit time, and carries two separate pricing rates — one for what you charge the customer and one for what you pay the transporter. Routes can be linked to individual shipments to populate these values automatically.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.
Route fields
| Field | Required | Description |
|---|---|---|
origin | Yes | Plain-text starting location of the route (e.g., “Mumbai”). |
destination | Yes | Plain-text ending location of the route (e.g., “Pune”). |
distanceKm | Yes | Route distance in kilometers. Must be a positive number. Displayed with locale formatting (e.g., 1,200 km). |
estimatedTime | Yes | Free-text estimated transit time (e.g., “6 hours”, “2 days”). |
billingRate | Yes | The rate charged to the customer in Indian Rupees (₹). Must be a positive number. |
vendorRate | Yes | The rate paid to the transporter in Indian Rupees (₹). Must be a positive number. |
Billing rate vs vendor rate
These two fields represent opposite sides of the same transaction:- Billing rate — the amount you invoice the customer for this route. This is your revenue per shipment on this lane.
- Vendor rate — the amount you pay the transporter for completing this route. This is your cost.
en-IN locale grouping (e.g., ₹12,500).
Routes list
Navigate to Admin → Routes to see all configured routes in a table. The table columns are: Origin, Destination, Distance, Est. Time, Billing Rate, Vendor Rate, and Actions. A search bar filters routes by origin or destination name as you type.Creating a route
Open the new route form
Click Add Route in the top-right corner of the Routes list. This navigates to
/admin/routes/new.Fill in all fields
All six fields are required. Enter the origin and destination as plain text, the distance in kilometers as a number, the estimated time as a free-text string, and both billing and vendor rates as numbers in Indian Rupees.
Editing a route
Click the pencil icon on any route row to open the edit form at/admin/routes/{id}/edit. All fields can be updated. Changes affect only future shipment assignments — existing shipments that reference this route retain the route’s origin, destination, distance, and estimated time at the time of their detail page render, but do not store a snapshot of the rates.
Using routes in shipments
When creating or editing a shipment, therouteId optional field lets you select a route from a dropdown. Once a route is linked, the shipment detail page displays:
- The route’s origin and destination (as a formatted “Origin → Destination” string)
- The route’s distance in kilometers
- The route’s estimated transit time
Attaching a route to a shipment does not automatically set the shipment’s source or destination fields. Those remain independent free-text values on the shipment itself. The route link provides reference data only.