Skip to main content

Overview

The Shipments module is the core of the Transport Logistics platform, enabling you to create and track shipments from origin to destination. It integrates with transporters, vehicles, routes, packages, and materials to provide comprehensive shipment management. Shipments List

Key Capabilities

Complete Shipment Creation

Create shipments with all necessary details including weights, routes, and materials

Weight Calculations

Automatic net weight calculation from gross and tare weights

Route Integration

Link shipments to predefined routes with automatic pricing

Package Assignment

Assign shipments to packages for organized tracking

Viewing Shipments

Shipments Table

The main shipments table displays all relevant information:
ColumnDescription
PackageAssociated package name or “None”
SourceOrigin location
DestinationDestination location
TransporterTransport company handling the shipment
VehicleVehicle registration number
Gross WeightTotal weight including vehicle (tons)
Tare WeightEmpty vehicle weight (tons)
QuantityNet cargo weight (tons)
MaterialType of material being transported
DepartureDeparture date and time
ActionsEdit and delete buttons (admin only)
Standard users can only view shipments assigned to their packages. Administrators can view all shipments across the system.

Search and Filter

Quickly find shipments using the search functionality:
  • Search by: Source, Destination, Transporter, Package, or Material
  • Real-time filtering as you type
  • Case-insensitive search
  • Searches across multiple columns simultaneously
Use specific search terms for faster results. For example, search “Mumbai” to find all shipments originating from or destined to Mumbai.

Creating a New Shipment (Admin Only)

1

Open the Add Shipment Dialog

Click the + Add Shipment button in the top-right corner of the Shipments page.Add Shipment Button
2

Assign Package (Optional)

Select a package to assign this shipment to:
  • Choose from active packages only
  • Select “None” if no package assignment needed
  • Package selection affects available routes
When you select a package, only routes assigned to that package will be available in the route dropdown.
3

Select Material (Optional)

Choose the material being transported:
  • Only “available” status materials are shown
  • Displays material name and unit
  • Select “None” if not applicable
4

Choose a Route

Select a predefined route:
  • Shows routes in “Source to Destination” format
  • Filtered by selected package (if any)
  • Auto-fills source and destination fields
Source and destination fields are read-only after route selection. To change them, select a different route.
5

Select Transporter and Vehicle

Choose the transport company and vehicle:Transporter:
  • Select from active transporters
  • Required field
Vehicle:
  • Shows only vehicles belonging to selected transporter
  • Displays vehicle number and type
  • Must be active status
6

Set Departure Time

Enter the shipment departure date and time:
  • Use the datetime picker
  • Required field
  • Format: YYYY-MM-DD HH:MM
7

Enter Weight Information

Input the weight measurements:Gross Weight (tons):
  • Total weight including vehicle and cargo
  • Must be positive number
  • Supports up to 5 decimal places
Tare Weight (tons):
  • Empty vehicle weight
  • Must be positive number
  • Cannot exceed gross weight
Quantity (Net Weight):
  • Automatically calculated: Gross - Tare
  • Read-only field
  • Updates in real-time as you enter weights
The system validates that tare weight doesn’t exceed gross weight and shows error messages if validation fails.
8

Add Remarks (Optional)

Enter any additional notes or special instructions:
  • Freeform text area
  • Up to 3 rows visible
  • Useful for special handling instructions or notes
9

Submit the Shipment

Click Add Shipment to create the record:
  • All validations are checked
  • Success message appears
  • New shipment appears in the table
  • Dialog closes automatically

Weight Calculation System

The platform includes intelligent weight validation and calculation:

Automatic Net Weight Calculation

Net Weight (Quantity) = Gross Weight - Tare Weight

Real-Time Validation

As you enter weights, the system checks:
  • Must be a positive number
  • Cannot be negative
  • Error shown immediately if invalid
  • Must be a positive number
  • Cannot exceed gross weight
  • Error: “Tare Weight cannot exceed Gross Weight”
  • Automatically updates as you type
  • Displayed to 5 decimal places
  • Cannot be manually edited
The Submit button is disabled if any weight validation errors exist. Fix all errors before submitting.

Route Integration

How Route Selection Works

1

Package Filtering

If you select a package, only routes assigned to that package are shown. If no package is selected, all routes are available.
2

Auto-Population

When you select a route:
  • Source field auto-fills from route
  • Destination field auto-fills from route
  • Both fields become read-only
3

Pricing Connection

The selected route’s billing and vendor rates are linked to the shipment for revenue calculations.
Route integration ensures consistency and reduces manual data entry errors. Always use predefined routes when available.

Editing Shipments (Admin Only)

1

Locate the Shipment

Find the shipment you want to edit using the search feature or by scrolling through the table.
2

Click the Edit Button

Click the pencil icon in the Actions column for that shipment.Edit Shipment
3

Modify Fields

The edit dialog opens with all current values pre-filled:
  • Update any field as needed
  • Weight calculations adjust automatically
  • Validations still apply
4

Save Changes

Click Update Shipment to save your changes:
  • Changes are validated before saving
  • Success message confirms update
  • Table refreshes with new data

Deleting Shipments (Admin Only)

Deleting a shipment is permanent and cannot be undone. This action removes all associated records and data.
1

Find the Shipment

Locate the shipment you want to delete in the table.
2

Click Delete Button

Click the red trash icon in the Actions column.
3

Confirm Deletion

A confirmation dialog appears showing:
  • “Are you sure you want to delete the shipment from [Source] to [Destination]?”
Click OK to proceed or Cancel to abort.
4

Deletion Confirmed

  • Success message appears
  • Shipment is removed from the table
  • Analytics update automatically

Shipment Status Indicators

Each shipment has a status that can be set during creation or editing:
StatusMeaningUse Case
PendingNot yet startedScheduled future shipments
In TransitCurrently en routeActive shipments
DeliveredReached destinationCompleted shipments
CancelledShipment cancelledCancelled orders
Use status filters to focus on specific shipment states, such as viewing only “In Transit” shipments to track active deliveries.

Package Assignment Benefits

Assigning shipments to packages provides:
  • Organized Tracking: Group related shipments together
  • Access Control: Standard users only see their assigned packages
  • Route Filtering: Simplifies route selection by showing relevant routes
  • Reporting: Generate package-specific reports and analytics

Material Tracking

Associating materials with shipments enables:
  • Inventory Management: Track material movements
  • Compliance: Maintain records for regulated materials
  • Analytics: Understand which materials are transported most
  • Documentation: Complete shipment records for auditing

Mobile Responsiveness

The Shipments interface adapts to different screen sizes:

Desktop

  • All columns visible
  • Full form layout in dialogs
  • Side-by-side field arrangement

Mobile

  • Essential columns only (Package, Source, Destination, Actions)
  • Single-column form layout
  • Touch-optimized buttons
  • Scrollable table for all data

Common Workflows

Quick Shipment Creation

1

Use Templates

If you frequently create similar shipments, start by selecting the same package and route to auto-fill common fields.
2

Tab Through Fields

Use keyboard Tab key to move quickly between fields without using the mouse.
3

Save Frequently Used Values

Keep a note of commonly used transporter IDs and vehicle numbers for quick reference.

Tracking Active Shipments

1

Filter by Status

Search for status indicators or use the dashboard to see active shipments.
2

Check Departure Times

Sort by departure time to see the oldest active shipments first.
3

Update Status

As shipments reach destinations, edit them to update status to “Delivered”.

Best Practices

Create routes first, then reference them in shipments. This ensures consistent pricing and reduces errors.
Double-check weight entries, as they affect revenue calculations and reporting. Use weighbridge tickets as reference.
Use the remarks field for important information like special handling requirements, delivery instructions, or reference numbers.
Keep shipment statuses up-to-date for accurate tracking and analytics.
Organize shipments into packages for better tracking and access control.

Troubleshooting

Can’t Submit Shipment?

  • Check for red error messages under weight fields
  • Ensure all required fields are filled (marked with *)
  • Verify gross weight is greater than tare weight
  • Confirm a valid route is selected

No Routes Available?

  • Ensure routes are created in the Routes module
  • Check if package selection is filtering routes
  • Select “None” for package to see all routes
  • Verify routes are assigned to the correct package

No Vehicles Showing?

  • First select a transporter
  • Ensure the transporter has active vehicles
  • Check that vehicles are marked as “active” in the Vehicles module

Next Steps

Build docs developers (and LLMs) love