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 Reports page provides a filtered view of all shipments in the system alongside a set of summary metrics. You can narrow down the shipment list by status, transporter, and date range, then export the filtered results to a CSV file for use in spreadsheets or external reporting tools. Navigate to Admin → Reports to access this page.

Summary metric cards

Four metric cards appear at the top of the page. All four values update dynamically whenever you change the active filters.

Total Shipments

Count of all shipments matching the current filter criteria.

Delivered

Count of matching shipments with a DELIVERED status.

Pending

Count of matching shipments with a CREATED status (not yet assigned).

Cancelled

Count of matching shipments with a CANCELLED status.

Filters

The filter panel below the metric cards provides four controls. Filters are applied client-side and take effect immediately without a page reload.
FilterTypeOptions
StatusDropdownAll, CREATED, ASSIGNED, PICKED_UP, IN_TRANSIT, DELIVERED, CANCELLED
TransporterDropdownAll, plus one entry per registered transporter
From DateDate inputFilters to shipments created on or after this date
To DateDate inputFilters to shipments created on or before this date (inclusive of the full day)
A Clear Filters button appears whenever any filter is set to a non-default value. Clicking it resets all four filters at once.
The date filters apply to the shipment’s createdAt timestamp, not to the pickup date or delivery deadline.

CSV export

The Export CSV button appears above the shipments table and shows the count of rows that will be exported in parentheses (e.g., “Export CSV (42 rows)”). The button is disabled when no shipments match the current filters. Clicking the button generates a CSV file client-side and triggers an automatic browser download. The filename follows the pattern translogix-shipments-report-YYYY-MM-DD.csv using today’s date.

Exported columns

The CSV contains the following columns in this order:
ColumnSource field
Package CodepackageCode
Sourcesource
Destinationdestination
Material TypematerialType
Statusstatus (underscores replaced with spaces, e.g., “IN TRANSIT”)
TransportertransporterName (empty string if unassigned)
VehiclevehicleNumber (empty string if unassigned)
Pickup DatepickupDate (ISO date string)
Delivery DeadlinedeliveryDeadline (ISO date string)
Created AtcreatedAt formatted as YYYY-MM-DD HH:mm:ss
Fields that contain commas, double-quotes, or newlines are automatically escaped per the CSV specification.

Shipments table

Below the export button, the full list of filtered shipments is displayed in a table with columns: Package Code, Source, Destination, Material Type, Status, Transporter, Vehicle, Pickup Date, Deadline, and Created. Status values are shown as color-coded badges matching the same scheme used throughout the admin panel.

Build docs developers (and LLMs) love