Shipments

This section describes how to use the Shipment Tracking solution to create shipments (individually or in bulk), search and filter shipment data, preview and monitor shipment status and sensor events, manage shipment details, and export shipment reports.

Shipments are the focal point of the Platform and provide ways to gain insight into historical trends or active transportation of your goods. This topic provides all the necessary steps to start creating, tracking, and gaining visibility into your shipments.

Shipments Menu

This section is designed to manage and monitor shipment activities. It provides various options for searching, filtering, viewing, creating, and exporting shipment(s) data.

Create Shipment

The Shipment module in the Platform allows you to create new shipments. You can create shipments in two ways:

  • Individual — Create a single shipment at a time using a guided, multi-level template.
  • Bulk — Create multiple shipments at once by uploading shipment data.

Create Shipment - Individual

Create Individual Shipments

To create an individual shipment:

  1. From the main navigation, select Shipment.
  2. Click + Create Shipment.
  3. In the dropdown menu, select Individual to start creating a shipment.

Basic Details

The first step is to provide essential shipment details.

Create Shipment - Basic Details

Template Details

  • Template: Select the required shipment template.

    Note: This choice is permanent and cannot be changed after you proceed to next step.

Tip: To learn how to create custom templates, see Create Template section in the Templates section.

Shipment Details

  1. Shipment ID — Enter a unique identifier to distinguish this shipment.
  2. Tracker — Select the tracker device that will monitor the shipment’s progress.

    Note: For more information about tracker devices, see the Devices section.

Finalizing the Basic Details

After completing all required fields in the Basic Details form:

  • Select Save & Continue to move to the next step (Shipment Details).
  • Select Cancel to stop creating the shipment.

Important: Ensure all required fields are filled in correctly to avoid validation errors when proceeding.

Shipment Details

In the Address window, specify both the source and destination addresses for the shipment.

Create Individual Shipment - Basic Details

Users can either:

  • Enter Manual:
    • Manually enter the address in the provided fields.
    • Drag and drop the Select Location Pin on the map to the required location.
  • Choose Existing Site: Select an address from the pre-created address list.

Source Address

Select the source site from the Select Source Site dropdown.

Note: To create a new site or to modify an existing site, refer to Create Site section in Sites topic.

Source Address Entry: Choose Existing Site

Select a pre-created site by clicking on the dropdown under Source Site.

Choose Existing Source Site

Source Address Entry: Enter Manual

If the required source site is not listed in the dropdown menu, you can create a site using the Create Site feature in the Sites Menu, or you can choose Enter Manual to provide the address details manually.

Source Addres - Manual Enterty

How to Use the Manual Entry Option
  1. Start Typing the Address: In the Location field, begin typing the site address. The system will suggest matches using auto-complete. Select the appropriate address from the list to auto-populate the related fields.

  2. Complete Mandatory Fields: Ensure that you complete all fields marked with a red asterisk (*), including:

    • Line One – The street address (Example: 1600 Pennsylvania Avenue Northwest).

    • City

    • State

    • Country

    • Zip/Postal Code (Optional – if not applicable, select the Not Applicable checkbox).

      Important: Double-check all manually entered data for accuracy to prevent issues during shipping or data validation.

  3. Use the Map Widget to Pinpoint Location

    • You can also manually select a location using the interactive Map Widget.
    • Drag and drop the Select Location pin to the exact site on the map. This action auto-fills the address fields based on the selected coordinates (latitude and longitude).
    • Use the Zoom Controls (+ and icons) to zoom in or out on the map for greater precision.
    • Select the Full-Screen icon (square box on top right of the widget) to expand the map.
    • Select the Full-Screen icon (diamond square) to expand the map and access directional controls for better navigation.
Best Practices
  • When possible, use the suggested addresses to maintain consistency.
  • If entering the address manually, verify that the map location corresponds accurately to the address.
  • Always confirm that the “Zip/Postal Code” is correct or marked as Not Applicable if necessary.

Destination Address

To complete the Destination Address, follow the same steps you used when filling out the Source Address.

Note: Ensure that the destination address is complete and accurate to prevent delivery delays or processing errors. When possible, use the auto-suggested address to ensure formatting consistency.

Finalizing the Address Entry

After you have filled out all the required fields for the addresses:

  • Click Save & Continue to proceed to the next step in the shipment process (Manifest).
  • If you need to review or update any information entered in the previous step, click the Previous button to return to the Basic Details section.

Important: Make sure all required fields are correctly filled out to avoid validation errors when continuing.

Manifest

The Manifest tab allows you to create orders and assign specific assets to those orders, which will be included in the shipment.

How It Works

  • The fields displayed in the Manifest form depend on the template selected in the Basic Details step.
  • Multi-level templates require you to fill out the manifest details, such as creating orders and assigning associated assets.
  • Single-level templates do not require any information in the manifest section, and the form may be skipped automatically.

Note: For more details about the different template types and their structure, refer to the Templates topic.

Create Shipment - Manifest

Adding an Order ID (For Multi-Level Templates)

When you choose a multi-level template, you must add at least one Order ID to proceed with the shipment.

Adding an Order ID

To add an Order ID:

  1. Click the Add Order ID button.
  2. In the Enter Order ID field, type the required Order ID.
  3. Click the + Add button to successfully add the Order ID to the manifest.

Note: Each Order ID should be unique and relevant to the assets being shipped. You can add multiple Order IDs as needed.

Modify or Delete an Order ID

Modify or Delete Order ID

To make changes to an existing Order ID:

  • Click the pencil icon to edit the Order ID.
  • Click the trash icon to delete the Order ID from the manifest.

Tip: Make sure any changes are saved and validated before moving to the next step in the shipment process.

Add Pallet(s)

After adding an order ID, its time to assign pallets to the order id in the shipment. Click + Add Pallet to add assets to this order.

Add Pallet(s)

Assigning Assets to an Order

Users can assign assets to an order in two ways:

  • By selecting existing asset(s) using the Add Existing Asset button.
  • By creating new asset(s) using the Create New Asset form.
Existing Assets

Adding Existing Assets

To assign existing assets to the shipment:

  1. Click the Add Existing Assets button under the Existing Asset section.
  2. Use the Asset ID search field to find the asset(s) you want to assign.
  3. Click Reset to clear the current search and enter a new Asset ID if needed.
  4. Select one or more assets from the search results by checking the checkbox(s).
  5. Click Add to assign them to the current shipment.

Tip: You can assign multiple assets at once. Ensure the assets are valid and match the order requirements.

Create New Asset

If the required asset is not listed under Existing Assets, you can create a new asset and add it to the shipment.

To create a new asset, click the Create Asset button. This opens the Create New Asset form, as shown below.

Creating New Assets

Create New Asset Form Overview

This form includes the following fields and options:

  • Asset ID (Required Field): Manually enter a unique identifier for the asset. Alternatively, select the Auto Generate Asset ID checkbox to let the system automatically generate an ID.

  • Asset Type (Required Field): Select the appropriate asset type from the dropdown list. This is a mandatory classification used for tracking and inventory.

  • Device ID (Optional Field): Optionally assign a device to the asset by selecting from the available device list.

  • Custom Metadata (Optional Field): You can add key-value pairs as metadata to store custom information related to the asset.

    • Enter a Key and its corresponding Value in the fields provided.
    • Click + Add Metadata to add additional metadata rows.
    • Use the trash icon to delete a metadata entry if needed.
  • Create and Add Button: After populating the required fields, click Create and Add to create the asset and assign it to the current order within the shipment.

Tip: Ensure that the asset ID and type are accurate and meaningful. This information helps in tracking and auditing assets efficiently.

Note: If you choose auto-generation for the Asset ID, the system will create a unique ID based on predefined logic, which ensures consistency and avoids duplication.

Finalizing the Manifest Entry

After completing all required fields for the Manifest:

  • Click Save & Continue to move to the next step in the shipment process (Preview & Submit).
  • If you need to review or modify details from the previous step, click the Previous button to return to the Shipment Details or the Basic Details section.

Important: Ensure that all required fields are correctly completed to avoid validation errors and interruptions in the workflow.

Preview & Submit

The Preview & Submit tab is the final step in the shipment creation process. It allows you to review all details entered in the previous steps before finalizing the shipment.

Preview & Submit

Review Shipment Details

The summary includes:

  • Source Address: Displays the sender's full address as entered or selected.
  • Destination Address: Shows the receiver’s full address.
  • Carrier: Displays the selected carrier (if applicable).
  • Template Type: Indicates the shipment structure.
  • Metadata: Any additional data associated with the shipment (if provided).
  • Manifest: Displays the order(s) and assigned asset(s). Expand the manifest to view individual asset IDs.

A map view on the right displays the shipment route and related geographical information, providing visual confirmation of origin and destination points. You can switch between Map view (with optional Terrain) and Satellite view (with optional Labels) to suit your analysis needs.

Finalizing the Shipment

  1. Carefully review all shipment details displayed in the Preview & Submit tab.
  2. To make changes, click the Previous button to return to earlier steps and update any information.
  3. If everything is accurate, click Create Shipment to finalize and submit the shipment.
  4. Once the shipment is created, you will redirected to the shipment details page. For more information, refer to section Shipment Details Page.

Important: Ensure that all critical fields (addresses, asset assignments, and order information) are complete and correct before submitting. This prevents errors or delays in the shipment process.

New Shipment in the Shipments List

Create Bulk Shipments

Use the Bulk option in the Shipments Menu to create multiple shipments at once by uploading a CSV file. This method is best suited for large batches of standardized shipment data.

Bulk Shipment Limitations

The Bulk Shipment feature supports only one-level standardized shipments.

If your bulk shipment list requires multi-level templates, use the Individual Shipment feature instead (see the previous section).

Bulk Shipment Creation

Sample Shipment Details File

To simplify the bulk shipment process, the platform provides a sample CSV file. You can download this file, enter your standardized shipment details, and then upload it to create bulk shipments quickly.

Details in the Sample File

Mandatory Columns in the Bulk Shipment Sample File

The sample CSV file includes predefined mandatory columns. Complete each column to ensure successful validation and shipment creation.

  • shipment_identifier: Enter a unique identifier for each shipment.

    Note: Do not duplicate Shipment IDs.

  • device_identifier: Select the tracker device that will monitor the shipment’s progress.

    For more information, see the Devices section.

  • template_name: Select the required 1-Level shipment template.

    • This template must already exist in the platform before use.
    • To learn how to create custom templates, see Create Template in the Templates section.
  • source_site_name: Enter the name of the source site.

    • The site must already exist in the platform for the CSV file to be validated.
    • If it does not exist, create it before uploading the bulk shipment file.
  • destination_address_line_one: Enter the first line of the destination address.

  • destination_address_line_two: Enter the second line of the destination address.

  • destination_address_city: Enter the city of the destination site.

  • destination_address_state: Enter the state or province of the destination site.

  • destination_address_country: Enter the country of the destination site.

  • destination_address_zipcode: Enter the postal or ZIP code of the destination site.

Creating Bulk Shipments

  1. In the main navigation, select Shipment.
  2. Click + Create Shipment.
  3. From the dropdown menu, select Bulk.
  4. In the pop-up window:
    • Download the Sample Shipment Details File.
    • Fill in all required shipment details.
    • Verify the data for accuracy.
    • Upload the completed CSV file to the platform.
  5. The platform will:
    • Validate the file.
    • Create the shipments.
    • Send an email summary with:
      • Successfully created shipments.
      • Failed shipments.
      • Reasons for failures.

Bulk Shipments Confirmation Email

If the email indicates errors:

  1. Remove successfully created shipments and empty rows from the CSV file.
  2. Correct the failed shipment entries based on the error details provided in the email.
  3. Re-upload the corrected CSV file.
  4. Repeat the process until all shipments are successfully created.

Best Practices

  • Viewing options: The search results can be viewed in either the Table View or the Map View. Toggle between the viewing options to switch between two modes.
  • For customers who frequently use the same shipping lanes, it is recommended to use shipment templates when creating shipments.
  • Verify all details before submission to avoid errors.
  • Use Auto Generate for Asset Identifiers for consistency.
  • Metadata is optional; proceed without it if not needed.
  • Use Individual creation for single or complex shipments requiring detailed customization.
  • Use Bulk creation for large batches of shipments with standardized details.
  • Verify the devices are active and online while assigning to a shipment.

Search and Filter Options

The Shipment menu includes a search and filter panel that enables you to efficiently locate and refine shipments using various search fields. Once a shipment is successfully created, it is listed in the Shipments List.

You can scroll through the list to locate a specific shipment or use the search and filter options to quickly find it.

Shipment Search and Filter Options

Use the following options to search for a shipment:

Search By FieldDescription
Shipment IdentifierEnter a shipment identifier to locate a specific shipment.
TemplateSelect a shipment template from the dropdown list to filter results based on the template used during shipment creation.
StatusFilter shipments by status, such as Missing, Resolved, Ready, Preparing, or Delivered.
Source SiteSelect the originating site of the shipment from the dropdown list.
ExcursionFilter shipments based on excursions or deviations from expected routes or rule events.
Created At Date RangeSpecify a start and end date to filter shipments by their creation date.
Updated At Date RangeSpecify a start and end date to filter shipments by their last updated date.
SearchSelect this button to apply all selected filters and display the results.
ClearSelect this button to reset all fields and filters to their default values.

Shipments List

Below the search and filter panel in the Shipment menu, the shipment results are displayed in a list format.

Shipments List

The following details are displayed in the Shipments List:

ColumnDescription
Shipment IdentifierA unique identifier for each shipment. Select the identifier to view detailed shipment information.
TemplateDisplays the shipment template type used for the shipment.
TrackerShows the tracker device associated with the shipment.
Source AddressIndicates the origin site or address of the shipment.
Destination AddressIndicates the destination site or address of the shipment.
StatusDisplays the current shipment status. Statuses include preparing, missing, resolved, and delivered. Statuses are color-coded for quick identification.
Shipment DurationRepresents the total time from shipment preparation to delivery or resolution, indicating the full shipment lifecycle.
Excursion EventsDisplays any deviations or irregularities that occurred during the shipment's transition.
Created AtThe timestamp indicating when the shipment was created.
Last Updated AtThe timestamp indicates the most recent update made to the shipment.
ActionsProvides management options, such as editing the shipment (using a pencil icon). Editing is available only when the shipment is in the preparing status.
Viewing OptionsAllows users to switch between List View and Map View using a toggle button. To customize view preferences, go to User Settings under the Organization tab in the Manage module.

Pagination Interface

This interface is a common component used in the platform to navigate large datasets (e.g., tables or lists).

Pagination Interface

Pagination Controls

  • < and > arrows: Navigate to the previous or next page.
  • Page numbers:
    • 1, 2, ..., 32 – Indicates individual pages.
    • Page 1 is currently active, shown with a highlighted border.
  • ... 32- Indicates skipped pages in between and hows the last page of the list.

Items Per Page Selector

A dropdown that lets users control how many entries appear per page:

  • 15 / page (default): Displays 10 entries per page.
  • 30 / page: Displays 25 entries per page.
  • 50 / page: Displays 50 entries per page.
  • 100 / page: Displays 100 entries per page.

Shipments List View Modes

The platform provides two viewing modes to explore shipment data effectively:

  • List View
  • Map View

List View

The List View displays shipment data in a structured list format, allowing for easy reference and detailed analysis.

To view the template associated with a shipment, select the Show Template checkbox. This adds an additional column next to the Shipment Identifier in the list, displaying its corresponding template name.

Shipments List - List View

Map View

The Map View offers a geographical map display to visualize shipment routes and locations, providing spatial insights.

Hover on the location icon (blue pin) and click on the BOL ID, or click on the BOL ID in the list to view more information about the shipment.

Shipments List - Map View

Map View Options

The map widget uses an interactive map to display the geographic distribution shipments. Users can switch between multiple map display modes to enhance visibility based on their analysis needs.

Map View: Terrain On/Off

  • Terrain View (Enabled): Displays physical land features such as elevation changes, mountains, and valleys. This view helps users correlate excursion locations with terrain-related challenges.
  • Terrain View (Disabled): Presents a simplified, flat map without terrain overlays, providing a cleaner visual when elevation is not a factor.

Satellite View: Labels On/Off

  • Labels On: Shows geographic and political labels such as state names, country boundaries, and major cities on top of the satellite imagery. This helps users orient themselves while maintaining the satellite detail.
  • Labels Off: Removes all overlaid text from the satellite view, offering an unobstructed image of the landscape, ideal for visual analysis of rural or natural areas.

Map Controls

  • Zoom In (+) / Zoom Out (–): Located in the bottom-right corner, these buttons allow users to zoom in and out of the map to examine excursions at different levels of detail.
  • Pegman (👤): The yellow figure (also called the Pegman) activates Google Street View. Drag and drop Pegman onto a street or road segment to access a ground-level panoramic view of that location, enabling detailed inspection of excursion zones.

Shipment Preview

Use the Shipment Preview to quickly locate shipments, review shipment status and sensor data, and access detailed shipment or template information. This view provides a summarized display of each shipment with key metrics and navigation options.

List View

Use this view to locate a shipment quickly, understand its high-level health, and jump to deeper details or related resources with a single click.

Layout Overview

The list view includes the following key interface elements:

ElementDescription
Shipment entryDisplays a compact summary of shipment details, including device metrics and location.
Action iconsProvide quick access to shipment-related actions and information.
Template linkOpens the shipment’s associated template in the Template module in a new tab.

Understanding Shipment Entries

Each shipment entry is composed of the following sections:

SectionDescription
HeaderDisplays the shipment ID and current status (for example, Delivered or missing). Select the shipment ID to open the shipment details page.
Sensor summaryDisplays the most recent sensor readings from the assigned device, including temperature, humidity, pressure, battery, and light (lux). Out-of-range values are shown in red.
LocationDisplays the most recent location update or associated address.

Action Icons

The right side of each shipment entry includes the following icons:

IconDescription
Indicates the total number of shock events.
🔓Indicates the total number of door open events.
🎟Indicates the total number of tilt events.
🕓Indicates the number of dwell time events.
📋Copies the link to the shipment details page to the clipboard for internal sharing. Users with the appropriate permissions can view the shipment details by selecting the link.
Opens a pop-up that displays extended shipment metadata, including the origin, destination, and total shipment duration from the time it left the origin hub to when it reached the destination hub.

Note: Icons are displayed based on the available sensor data and the triggered events.

Common Tasks

Use the following examples as guidance for common workflows:

TaskSteps
View the associated templateSelect the Template link (for example, Default-3-Level-LP) to open the template in a new tab to view more information.
Share shipment detailsSelect the 📋 Copy Link icon, then paste the URL into your internal communication channel.
View full shipment detailsSelect the blue Shipment ID to open the shipment details page.

Map View

You can preview a shipment to view essential status, events, and sensor data either through the Map View. This topic explains both methods and how to navigate the preview and detailed view using the UI icons provided.

Drawer Preview Window

In the Map View, shipments are shown with location markers.

  1. Click on a shipment from the Shipments List.
  2. Click the shipment icon on the map. A pop-up will appear with basic information.
  3. To open the detailed view:
    • Click the Shipment ID link (e.g., SH-1746600472), or
    • Click the 👁️ Eye icon to open the full detail view.

Note: Clicking the shipment on the map always opens a pop-up first before enabling further interactions.

Editing a Shipment

You can edit a shipment depending on its status:

  • In Preparing stage: All details except the template can be modified.
  • In In Transit or any other stage: Only the destination address can be edited.

To edit the shipment:

  1. Click the Pencil icon from the drawer view.
  2. Modify the allowed fields accordingly.

Overview Tab

The Overview tab displays:

  • Device sensor data
  • Source and destination addresses
  • All the reported excursion details.
  • Last reported location with coordinates
    • Example:
      • Source Address: CEVA Logistics, Mt. Juliet, TN
      • Destination Address: Amazon CMH3, Monroe, OH

Events Tab

Click the Events tab to view the shipment timeline, including:

  • Shipments movements details during the transit.
  • Excursion events
  • Rule Events

Each event is timestamped and listed in reverse chronological order.

Sensors Tab

Click the Sensors tab to analyze real-time device readings such as:

  • Temperature (°C): Minimum, maximum, and current readings with a trend line
  • Battery (%): Battery life trend over time
  • Additional sensor metrics (e.g., humidity, lux)

This data assists in auditing the condition during transit.

Reports

The platform is enabled with an option to export the search results to CSV format. To export the data, click the Report button located next to + Create Shipment, and choose your preferred method to export search results.

Export Shipment Data

Clicking on the Reports button opens a dropdown with the following options:

  • Export All
  • Export Current View

Export Current View

Selecting this option exports the currently visible shipment data from the Shipments List, based on the active search and filter criteria.

Export All

Selecting this option exports all shipment data available on the platform, regardless of any active search or filter criteria. This action triggers a system-generated email containing a CSV file with the complete shipments dataset.

Practical Tips

  • Switch Between Views: Start with Compact View for a quick summary. Switch to Detail View for an in-depth analysis of shipment information.
  • Confirm Source and Destination: Double-check the source and destination addresses for accuracy before proceeding with any shipment-related queries.
  • Leverage Tracker Device Information: Use the tracker device name to cross-reference with internal systems or contact support if needed.
  • Stay Informed with Status Updates: Familiarize yourself with the meaning of each status (Preparing, Ready, etc.) to quickly interpret the shipment's stage in the logistics process.
  • Use the Map for Real-Time Insights: Use the map's zoom and pan features to explore more about the shipment's current region and route.

Shipment Details Page

The Shipment Details Page allows you to track and manage individual shipments.

It offers two display modes: List View and Map View.

List View

  • Displays all shipments in a list format.
  • This is the default view.
Change the Default View
  1. Click your profile photo or the profile options on the top right corner of the platform.
  2. Select Manage Account.
  3. Go to Preferences.
  4. Update the view settings as needed.

Map View

  • Displays shipments on a geographical map for location-based tracking.

Related Topics