New Features for Release 1.71

Modified on Tue, 15 Apr at 9:41 AM


These features are available on your Test site as of the evening of April 8th  and on your Production site on the evening of April 16th.

Transition to New Map Board
We’re retiring the Legacy Map Board in favor of a faster, more powerful version as part of our ongoing improvements to the Dispatch Science platform. If you haven't yet created a Map Board, one will be created for you automatically when you open an Order in the Back Office using the Navigate to Dispatch Board from the Order list or the Order details.
The new Map Board, included in the Tabular Dispatch Boards, delivers improved performance, usability, and a modernized interface.
What’s New:
- Unified and intuitive user experience across both the Map Board and Grid Board
- Significant performance enhancements
- A redesigned layout to streamline dispatcher workflows

The transition to the updated Map Board is part of our commitment to provide smarter, more efficient tools for managing your operations. Stay tuned as we continue to roll out improvements across the Dispatch Board.

New Features in This Release

Full cutover to new Dispatch Boards

Commencement of new in-app Messaging

Driver app enhancements

User Interface improvements

Improvement on stop-grouping rules

Enhancement on Billing and Driver Settlement options

Improvement for Recurring Orders and Routes

Additional flexibility with Order Rules

TABLE OF CONTENTS

Driver App Version 1.70
- Feature
Messages From Dispatch Science
- Dismiss a message
Back Office
Dispatch Board
Administration
Integration-Tenants API
Integration API
- Schema Documentation
OData
- Orders Table

Definitions

The release notes refer to different sections of the application:

Back Office: Where Customer Service Representatives (CSR) create and edit orders, create accounts, review drivers, etc.

Dispatch Board: Where Dispatchers assign orders to drivers, get notifications for invalid orders, etc.

Auto-Dispatch: This section refers to the automated order assignment setup and its process.

Administration: This section is in the Back Office but refers to sections only an administrator will use like Settings and Pricing.

Customer Portal: Where account users log in to create orders, view their order history, enter a credit card, etc.

Tracking site: Where customers enter a tracking number like the order ID or a reference number to view the status of their order.

OData: Data fields and variables saved in OData

Account API: API provided to your accounts to create, update and get orders. For documentation, please follow this link: https://api.dispatchscience.com/
Tenant API: API provided to you to create orders for your accounts, retrieve invoices and change invoice status. For documentation, please follow this link: https://api.dispatchscience.com/

Scripting: Custom script building abilities and functions within Dispatch Science

Driver App Version 1.70

Feature

Message on Attachment Upload

When an attachment is uploaded in the background for the first time after a pickup or delivery, a message will now be displayed to inform the user about the upload process:

The message will reappear upon the first upload after reinstalling the Driver App.

Lens Selection

A new setting is now available in the Driver App, allowing drivers to select which camera lens to use when scanning barcodes on an iPhone with multiple lenses. If the default lens is not optimal, drivers can easily switch to the correct one through the Settings for improved scanning accuracy. Results may vary based on the exact model of device in use. Select the Back Camera if experiencing difficulties with the other.

1) Open Settings:

2) Scroll down Advanced and tap on Camera Lens:

3) Select your camera lens from the list:

Contact Support

When contacting Support to submit their logs, drivers will now be required to enter a detailed description of the issue. This improvement will help the support team better understand and respond to the problem more efficiently.

1) Open Settings and scroll to the bottom

2) Click on Contact Support

The description is now a required field before the support request can be sent.

Better Offline Detection

To help drivers better understand the cause of connectivity issues within the Driver App, the error message will now indicate whether the issue is due to the cellular network (internet) or the Dispatch Science Server. Additionally, as the app reattempts to connect, it will provide real-time updates on the reconnection process.

Improved Stop Details Visibility Based on Driver Permissions

For orders without items, if a driver’s profile does not have permissions to add, edit, or delete items, the chevron to open the item section will no longer be displayed in Stop Details. This ensures a cleaner interface by only showing relevant options based on access rights.

Hold Reason Templates Available in Offline Mode

Drivers can now access Hold Reason Templates even when in offline mode. Previously, these templates were unavailable without an internet connection.

Key Benefits:

Drivers can select a template to quickly add notes for the dispatcher when placing an order on hold.
Ensures faster and more consistent communication, even when offline.

This enhancement improves efficiency and reliability in managing on-hold orders.

Messages From Dispatch Science

Dispatch Science now supports in-app messaging for important updates directly within your Dispatch Science BackOffice and Customer Portal sites. Messages may include:

New release announcements
Feature updates and modifications
Deprecation of legacy features
Planned or unplanned outages

This enhancement ensures that all users receive timely and relevant information without relying on external communication channels. With in-app messages, you’ll never miss critical updates that impact your use of the platform.

Message Types

There are three types of in-app messages, each displayed with a distinct color for clarity:

Alert (Red): Indicates a critical issue or urgent information. Displayed in a red banner and remains visible until the issue is resolved by Dispatch Science.
Warning (Yellow): Highlights potential issues or important notices. Displayed in a yellow banner and may persist until resolved, or can be dismissed by the user depending on the context.
Message (Blue): Used for general updates or informational messages. Displayed in a blue banner and can be dismissed at any time by the user.

Once a Warning or Message is dismissed, it cannot be viewed again by that user.

Dismiss a message

Warnings or messages can be dismissed once they have been read by the user.

1) On the banner right corner, you will see an X if the message can be dismissed:

2) Click on the X and it will disappear.

Some messages may not have an X. When this is the case, they are time sensitive messages and will disappear automatically once the alert is resolved.

Back Office

Orders

Enhanced Address Search with Additional Order Columns

To enable more precise searches for order addresses, we’ve added new columns while retaining the existing Pickup and Delivery Address fields. Most of these new columns can also be filtered and sorted for improved data management.

Pickup Address:

Pickup Address Line 1 (filterable & sortable)
Pickup Address Line 2 (not filterable or sortable)
Pickup City (filterable & sortable)
Pickup State (filterable & sortable)

Delivery Address:

Delivery Address Line 1 (filterable & sortable)
Delivery Address Line 2 (not filterable or sortable)
Delivery City (filterable & sortable)
Delivery State (filterable & sortable)

These enhancements provide greater flexibility in filtering, sorting, and searching for orders based on specific address details.

Improved Filtering for Weight and Volume

To provide more accurate search results, the Weight and Volume filters have been enhanced. Previously, values saved from an order could include more than two decimal places, leading to inconsistencies when using the equal to (=) operator.

Now, the filter rounds stored values to two decimals, matching what is displayed in the search interface. This ensures that searches using the equal to operator ( = ) return precise and expected results.

This enhancement improves filter accuracy and usability, making it easier to find specific orders based on weight and volume.

Order List Column Filter

To improve the performance of the Order List, column filters that use selectable lists—such as Order Type, Status, Vehicle, and others—will now load on demand.

As a result, you may notice a slight delay the first time you open these filters, as the list is retrieved in real time. This change reduces the initial load time of the Order List and improves overall responsiveness.

Setting Verify Before Invoicing on Orders

On Accounts with billing cycle set to After Delivery or with Pre-authorization, the Verify before Invoicing will not be available in the Order menu.

Recurring Orders and Recurring Routes

When using calendars in Recurring Orders (at both the Recurrence and Order Template levels) or in Recurring Routes (at the Recurrence or Order Template levels), an information icon has been added to remind users that once a calendar expires—meaning all its dates are in the past—it will be automatically removed. This ensures clarity and helps users manage recurring schedules effectively.

In Recurring Orders:

In Recurring Routes:

In both Recurring Orders and Routes, at the Order template level:

Drivers

Information Details

The checkbox text that allows a Driver to view settlements from drivers reporting to them has been updated to better reflect its purpose, ensuring clearer understanding and improved usability:

Driver Audit Enhancement

The Driver Audit feature has been enhanced to provide greater visibility into key driver-related information. It now includes:

Vehicle details
Documentation records
Certifications
Settlement Deductions/Additions
Zones

These additions improve tracking and compliance, ensuring a more comprehensive audit trail for driver management.

Enhanced Settlement Date Configuration

A new option has been added under the Driver Options that provides greater flexibility in how Orders are selected to be settled.
Users can now choose the date used for settlement generation:

Order’s Ready At Date
Order’s Delivery Date

This setting allows businesses to align settlement generation with their preferred operational or accounting workflows.

Only delivered orders will be eligible for settlement, regardless of the selected date option.

How to Configure:

1) Open Drivers, click on a account to edit it then click on Edit in the Driver Options:

2) Select your preferred settlement date basis:
Delivery Date or Ready At Date

3) Click Save.

When generating settlements, you will be reminded that some drivers may be using different generation dates:

This enhancement gives users more control over invoicing logic and supports more accurate financial reporting based on business needs.

The default value for this new option is Delivery Date to keep existing functionality.

Accounts

Order Profile Grouping Options

In previous releases, using the optimized Driver stop list, stops of the same type and same status were grouped disregarding if time windows did not overlap. This would result in stops with different times, if they were optimized one after the other, to be grouped resulting in stops with later windows to be grouped with earlier stops.

A new setting has been added to the Order Profile Grouping Options to enhance control over how stops are grouped.

By default, to keep the current functionality, the option to enable grouping with non-overlapping stops is enabled.

Disabling the option by unchecking its checkbox will prevent grouping stops with non-overlapping time windows for On demand orders. This feature has no effect on the Routed Orders.

This provides more precise grouping behavior, ensuring stops are only combined when their time constraints are compatible, leading to more accurate and realistic route planning when a Driver needs to return to the same location during the day.

In previous releases, when using the optimized Driver Stop List, stops with the same type and status could be grouped together if optimized to be one after each other, especially at the end of the day even if their time windows did not overlap. This behavior could result in stops with later time windows being grouped with earlier ones, potentially affecting the accuracy of route planning.

A new setting in the Order Profile Grouping Options gives more control over how stops are grouped during optimization.

The checkbox “Allow to group consecutive stops with non overlapping window” (enabled by default) maintains the current behavior. When unchecked, stops with non-overlapping time windows for On Demand Orders won’t be grouped. Routed Orders are unaffected.

This allows for more accurate route planning, especially when a driver may need to return to the same location at different times.

1) Open Accounts then click on Profiles. You will see the Order Profile list.

2) Open an existing Order Profile by clicking on its name or create a new Order Profile. Click on Edit button in Grouping Options section:

3) Uncheck the "Allow to group consecutive stops with non overlapping window".

4) Click Save.

Enhanced Invoice Date Configuration

A new option has been added under the Account Billing Options that provides greater flexibility in how Orders are selected to be invoiced.
Users can now choose the date used for invoice generation:

Order’s Ready At Date
Order’s Delivery Date

This setting allows businesses to align invoice generation (billing) with their preferred operational or accounting workflows.

Only delivered orders will be eligible for invoicing, regardless of the selected date option.

How to Configure:

1) Open Accounts, click on an account to edit it then click on Edit in the Billing Options:

2) Select your preferred invoice date basis:
Delivery Date or Ready At Date

3) Click Save.

When generating invoices, you will be reminded that some accounts may be using different generation date:

This enhancement gives users more control over invoicing logic and supports more accurate financial reporting based on business needs.

The default value for this new option is Delivery Date to keep existing functionality.

Transaction List Filter

The Does not contain filter was added to the column filter on the Transaction list:

Dispatch Board

Grid Board Search

The Grid Board Column filter now automatically selects the optimal default operator based on the column's data type and uses a single input for filtering in most of the columns:

Text columns default to Contain operator:
1. Order Id
2. Created By
3. Account Name
4. Account Number
5. Account Caller
6. Account Caller Phone
7. Reference #1
8. Reference #2
9. Reference #3
10. Hold Reason
11. Driver Number
12. Driver Name
13. Pickup Address
14. Pickup Company
15. Pickup Name
16. Pickup Phone
17. Pricing Pickup Zone
18. Address Pickup Zone
19. Pickup Notes
20. Delivery Address
21. Delivery Company
22. Delivery Name
23. Delivery Phone
24. Pricing Delivery Zone
25. Address Delivery Zone
26. Delivery Notes
27. Received From
28. Received By
29. Customer Notes
Numeric columns default to is equal to but also has is not equal to, is greater than, is greater than and equal to, is less than and is less than or equal to:
1. Distance
Drop-down type columns display a list of values as multi-select checkboxes, also showing the total for each selection:
1. Company
2. Status
3. Service Level
4. Vehicle
5. ID Type (Pickup)
Yes/No or True/False columns are displayed as radio buttons, allowing a single selection:
1. Created By Account User
2. Held
3. ID Verified (Pickup)
4. ID Verified (Delivery)
5. Ready to Invoice
6. Ready to Settle
7. Is Late or at Risk
8. Routed

For date and numeric columns, a dual-operator search allows users to define a range for more precise filtering. This same two-operator filter is also available for searching ZIP/Postal codesThe following columns use 2 inputs for filtering:

Date columns uses the is after as default and allows to use is before and is equal:
1. Created At
2. Held Date
3. Ready At
4. Pickup Start
5. Pickup End
6. Pickup ETA
7. Picked Up
8. Delivery Start
9. Delivery End
10. Delivery ETA
11. Delivered
12. Assigned
13. Dispatched
Text columns with two operators use Contain as default:
1. Pickup Zipcode
2. Delivery Zipcode
Numeric columns default to is equal to but also has is not equal to, is greater than, is greater than and equal to, is less than and is less than or equal to:
1. Number of pieces
2. Weight
3. Volume
4. COD (Pickup)
5. COD Collected (Pickup)
6. COD (Delivery)
7. COD Collected (Delivery)

Some columns are for display purposes only and cannot be used for filtering or sorting:

Hold Notes
Signature (Pickup)
Signature (Delivery)
Account Notes
Internal Notes

Map Board Modernization

The legacy Map Board and Drivers have been officially sunset in version 1.71 in favor of the new and improved Dispatch Map Board, now accessible directly from the existing Grid Board interface.

This upgrade introduces a unified and consistent experience across both the grid and map boards, with several key enhancements:

Clear driver status indicators for real-time visibility
Refined driver display for improved readability
Support for multiple Map Boards with customizable filters
A standardized action menu for streamlined operations
A modernized user interface for enhanced usability
Seamless Migration

To ensure a smooth transition:

If no Map Board currently exists, Dispatch Science will automatically create one when you open the Dispatch Board from either the Order List or Order Details within the Back Office.

Flexible Setup

Users can also manually create one or more Map Boards in parallel with their existing Grid Boards, enabling tailored views for different operational needs.

These updates enhance clarity, efficiency, and usability, empowering dispatchers to work smarter and faster than ever before.

Navigate from Back Office Order List or Order Details to Dispatch Board Order Details

1) In the Back Office Order List, on an Order row, click on the Order menu and select Navigate to order on Dispatch Board:

On the Back Office Order Details, click on the Open on Dispatch Board icon ( ):

The Dispatch Board will open:

If no Map Boards were created, a new Map Board will be created automatically. It will open with no filter, showing the Map with the Orders and the Order Details will be opened on the right hand side of the Board:
If one or more Map Boards are created, the first Map Board will be opened. It will open with the existing filter, showing the Map with the Orders as per the filter. The Order will be opened on the right hand side.
The filter will not change and the zoom of the map will remain as it was the last time it was used:

Create a New Map Board

1) Open Dispatch Board

2) If no Boards are created:
In the Board Management, click on Add board button:
If Boards are already created:

Click on +

3) Enter the name of the Board and select the Board Type.

If selecting a Grid Board, you need to select the Layout Type:

Then select if you want to have text wrapping in the cells

4) Click on Create button

The board will be created.

If you were creating a board in the Board management, you will see the board:

You can set the new Board as the default by clicking on its star. The Board will move in first position and when opening the Dispatch Board from the Back Office, you will be directed to the default Board:

Map Board Overview

When opening a Map Board, the system displays—based on your filter configuration—the first 500 orders in the list, along with all matching orders visualized on the map.

Chat

The Chat icon is available on the Map Board when viewing Orders or Drivers.

Switching Views: Orders and Drivers

From within the Map Board, you can toggle between two primary views:

Orders View: Displays a filtered list of orders
Drivers View: Shows the status and location of available drivers

Order List Filter

Quick Filter

Use the Quick Filter to search across supported fields. Simply type your search criteria, and the list will dynamically update based on matching entries within the allowed fields.

View By

The View By option defaults to Open, showing all orders that are neither delivered nor cancelled. You can modify this view by:

Selecting a different status category
Choosing a specific date from the calendar

For detailed behavior of how the View By filter interacts with selected dates, please refer to Date Range Selection in Dispatch Boards.

Advanced Filter Options

The Advanced Filter is divided into two sections:

Orders: Enables deeper filtering based on order-specific properties
Drivers: Allows filtering based on driver-related criteria

Once filters are applied they show below the View All for both Orders and Accounts:

Orders:

Drivers:

Hovering over the filter, shows the selection:

To clear all filters on both Orders and Drivers, click on the Clear All

To clear one filter at a time on either Orders or Drivers, click the x in the filter name.

Filter functionality is consistent between the Map Board and the Grid Board, ensuring a seamless experience across views

Order Interface

The Order interface has not yet been transitioned to the new design in this release; however, updates are planned for an upcoming version.

Updated Driver Interface Breakdown

To maintain a consistent user interface, the driver photo has been removed from the Driver List. It is now displayed within the pop-up Driver Card, which appears when selecting a driver.

Driver Card:

Driver shows with its vehicle and number in the driver color, defined in the driver profile, and now displayed with a gradient tone enhancement, providing a more visually appealing and modern look across the interface.
If auto-dispatch with suggestion is available, a red dot will appear on the Driver when suggestions are available.
- On the Map, a checkbox will show beside Auto Dispatch Suggestions, checking the box will show the suggested Orders with the rainbow road and will show the list of suggested orders on the driver stop list
- In the Driver details, the driver will also show with the red dot and the View Auto-Dispatch checkbox and the Accept All button enabled. To dispatch all suggestions, click on Accept All.
  To only dispatch one or more orders, click on the ... menu beside the order and click on dispatch. The suggested driver will show first.
Driver Status shows as the horizontal bar to the right of the Driver card:
Off Duty or Going Off Duty: OrangeOn Duty: GreenAway: Blue
Driver Name is a link to the Driver profile in Back Office
displays beside the Driver name when Driver position is unknown
Driver Phone Number appears below its name
Next Stop address is displayed along with the ETA
On the right hand side, you have the list of attributes and in a pill, the number of Orders
- Number or Order pill shows:
  - Red when Driver has Late Orders,
  - Orange when Driver has At Risk Orders
  - Blue when Orders are on time

Driver Card:

The Driver Card appears when you hover over a driver in the list, offering quick access to key driver details and actions.

The following information is available on the Driver Card:

Driver Picture, Number and Name - Clearly identifies the driver.
Chat icon - Opens a direct chat with the driver.
Profile icon - Opens the driver’s profile in the Back Office.
Driver Email - A clickable link that opens your default email app and auto-fills the driver's email in the To field.
Vehicle Type - Displays a vehicle icon along with the assigned vehicle type.
Last Position Update - Shows the timestamp of the latest location update received from the Driver App. If no position has been received in a few minutes, N/A will be displayed
Auto-Dispatch - Displays the driver’s Auto-Dispatch setting as configured in their profile
Last Delivery - Indicates the date and time of the driver’s most recent completed delivery.
Current and Peak Capacity information is now displayed here instead than on the driver stop list.
Attributes - Lists all attributes assigned to the driver for easy reference.

This compact view helps dispatchers quickly access essential driver information without navigating away from the main interface.

Driver Details Slide Window

The Driver Details Slide Window allows users to view comprehensive information about a driver along with their associated orders. This feature provides quick access to a driver’s profile and orders, enhancing the user experience and operational efficiency.

Accessing Driver Details:

To view the details of a driver, simply click on the driver’s name in the Driver List. This will open the Driver Details Slide Window on the right side of the screen. The Driver Details has been unified between the Map and Grid Board.
Once the Driver details is opened, the map will filter to show the driver and associated orders.

Use the > to close the sliding panel.

Driver Information:
This is a combination of the Driver information in the Driver List along with information found in the Driver Card.
- Driver menu: The Driver menu let you set the Driver off duy and open the Chat by clicking Message.
- Driver information: Driver color, number and vehicle
  Driver Name is a link that opens the Driver Profile
  Next Stop address
  ETA: next ETA
  If setup on the Driver profile, time driver is going off duty or is away
  The attributes
  The number of orders in a colored pill (see above for color information)
Dispatch Note textbox where dispatcher can leave a note about the driver
If Auto-dispatch with suggestion is available and enabled, dispatcher can see the suggestion and accept them all at the click of a button.
On Overview tab, dispatcher can see the Driver performance at a glance as number of Orders or as commission earned by selecting number of order ( ) or commission ()

Driver Attributes
Order List shows the list of Orders dispatched to the Driver.
- There are 2 views available:
  Switch to expanded view by clicking on and to condensed view by clicking on .
  - Expanded: Shows both pickup and delivery address with time windows
  - Condensed: Shows one stop per order:
  - If order is dispatched or assigned, pickup stop is displayed
  - If order is picked up, delivery stop is displayed
- Order Information:
  - In both views:
    - Dispatch type:
      - : manually dispatched
      - : auto-dispatched
  - Order Number with vehicle type and to open Order details in Back Office
  - If the order is a segment, is displayed
  - Address with time window
    - If user is in a different time zone than the address, the time displays in the time zone of the address
  - If driver is on duty and list is optimized, a colored pill displays
    - If due date is in the future, pill is blue with the number of minutes, hours, days until due date-time
    - If due date is in the future but is at risk of being late, pill is orange with the number of minutes, hours, days until due date-time
    - If due date is in the past, the pill shows red with the number of minutes, hours, days since its due date-time
  - Color-coded order status menu:
    - Order is dispatched and not yet accepted by the driver
    - Order is assigned, it has been accepted by the driver
    - Order has been picked up by the driver
    - is on Hold
    - From the menu, the Order:
      - Can be dispatched to another driver
      - Can be moved to a route
      - Can be set picked up when it is in status of dispatched and assigned
      - Can be set delivered up when it is in status of dispatched, assigned and picked up
      - Can be set at checkpoint
      - Can have attributes added or removed
      - Can be set with Order exception codes
      - Can be cancelled
Stop List shows the optimized list of stops if the Driver is online and on duty, sharing its location:
- Workload icon will open the Driver history with the latest workload displayed
- The total number of miles and driving time (total number of hours to deliver all orders)
- Last optimization date and time. The optimization icon allows user to re-optimize a driver workload.
- List of Orders:
  - Stop sort order with pickup(green arrow up) or delivery icon (red arrow down)
  - Stop address
  - Pickup/Delivery Window in the address time zone
  - Color coded pill with ETA
  - Color coded pill with order status
  - ... menu from which the Order:
    - Can be dispatched to another driver
    - Can be moved to a route
    - Can be set picked up when it is in status of dispatched and assigned
    - Can be set delivered up when it is in status of dispatched, assigned and picked up
    - Can be set at checkpoint
    - Can have attributes added or removed
    - Can be set with Order exception codes
    - Can be cancelled
  - Stops can also be locked here by clicking on the lock and stops can be moved within the locked stops
- The map will display the home location of the driver if setup in its profile
- The map will display the rainbow road if the stop list is optimized.

Driver Chat Icon

The Driver Chat icon is now available in the following areas:

Map Board
Driver Card Popup on Map Board
Map on Grid Board
First open the Map from the Grid Board:
Triple Panel Grid Board
Map Board Driver Details
Grid Board Driver Details

Edit Pencil on Order Details

The pencil is available in the Map and Grid Board's sliding Order details in the following places:

Clicking on the pencil beside Pricing Information or Package Information will open the Summary tab on the Back Office Order Details
Clicking on the pencil beside Reference Numbers will open the Additional Info tab on the Back Office Order Details
Clicking on the pencil beside the Driver Payout, will open the Driver tab on the Back Office Order Details
Once an order is picked up, a pencil will be displayed beside the Proof of Pickup. Clicking on the pencil will open the Edit Proof of Pickup dialog box:

Once an order is delivered, a pencil will be displayed beside the Proof of Delivery. Clicking on the pencil will open the Edit Proof of Delivery dialog box:

Administration

Service Level Schedule

Found under Pricing

Service Level Cutoff Message

The Service Level Cutoff message can now be hidden for internal and self-serve users when creating orders with next-day delivery.

In Order Details, the messages display in these locations:

This enhancement reduces unnecessary alerts, streamlining the order creation process while still maintaining visibility when needed.

Steps to hide the Cutoff Message for a specific Service Level in a Schedule

1) Open Pricing then click on Service Levels

2) Open an existing Service Level Schedule by clicking on its name or create a new schedule

3) Open an existing Service Level or add a new schedule

4) Check the Do not display warning on Order when delivery is after today:

5) Save the change

Fuel Price Sorting by Start Date

Found under Pricing>Fuel Surcharges

You can now sort the Fuel Price list by Start Date, enabling easier access to the most recent entries.

1) Open Pricing, click on Fuel Surcharges then Fuel Prices. Click on a Fuel Price to edit it:

2) By default, the list is sorted in descending order — showing the newest Start Date first.

Clicking on the Start Date header will cycle through the different sorts:

No sort

Ascending sort - oldest start date first

Descending sort - newest start date first

Order Rules

Found under Settings>Configurations>Order

New criteria have been added to Order Rules, making it easier to configure them without relying on script-based order rules. This improvement simplifies the setup process and enhances flexibility when defining subscription conditions

New criteria:

Total Weight: numeric value
Order Id: text field
Order Type: drop-down field
- Uses only is equal to and is not equal to as its operators
- Selection:
  - Standard
  - Multi-Segment
  - Segment
Order Source: drop-down field
- Uses only is equal to and is not equal to as its operators
- Selection:
  - API (Self-Serve)
  - API (CSR)
  - UI (Self-Serve)
  - UI (CSR)
  - Driver App
  - Import (Self-Serve)
  - Import (CSR)
  - Recurring Orders
  - Recurring Routes
Delivery State: text field
Pickup State: text field
Delivery ZIP: text field
Pickup ZIP: text field
Delivery Company: text field
Pickup Company: text field
Delivery Contact Name: text field
Pickup Contact Name: text field
Service Level Id: text field
Vehicle Type Id: text field

New operators have been introduced, varying based on the criteria data type, to provide more flexibility when defining Order Rules. These additional operators enhance filtering capabilities and improve precision when setting up subscription conditions.

Text fields:
- All text fields now have the Start and Ends with.
- The Id fields (Service Level Id and Vehicle Type Id) are used like a text field
- List of available Operators:
  - Is equal to
  - Is no equal to
  - Contains
  - Does not contain
  - Starts with
  - Ends with
  - Is empty
  - Is not empty
Drop-down still have an equal and not equal to.
Numeric fields (Total weight)
- Is equal
- Is not equal to
- Is greater than or equal to
- Is greater than
- Is less than or equal to
- Is less than
- Is null
- Is not null

Scripts

Override Tax Schedule on an Order

The tax schedule can be overridden on an order from the Update Order Script.

Get property

var ts = order.OverriddenTaxScheduleId;

Method to update

await order.OverrideTaxSchedule( taxScheduleId );

If Order's Accounts has a "non-overridable" tax schedule, the tax schedule will not be changed and it will throw an exception in the Application Log.

Transition to Exception Codes
Hold Reasons are being phased out in favor of the more flexible Exception Codes. The transition for customers still on Hold Reasons is seamless, all Hold Reasons were converted to Exception Code and the new Default Exception Code Schedule has been assigned to all your Accounts. 

For more information about the differences between Exception Codes and Hold reasons, please refer to : Understanding Exception Codes vs. Hold Reasons.

To explore how Exception Codes can enhance your operations, please visit: Benefits of Exception Codes.

If you need to add or modify Exception Codes of type Hold or any other type, follow this user guide: Setting Up Exception Codes and Schedules.

Integration-Tenants API

Schema Documentation

In the Integration-Tenants API, some API contain enums that are used in the request body. The schemas will now show the different enums and their descriptions.

Transactions

GET /api/v1/transactions/{transactionId}/posting-entries

A new endpoint has been introduced to return posting entries associated with a Transaction ID, including:

Invoice
Payment
Credit Note
Debit Note
Adjustment

This endpoint is designed for seamless integration with accounting systems, ensuring accurate financial tracking and reconciliation.

Response Body:

{

"items": {

"id": "string",

"companyCode": "string",

"accountingCode": "string",

"totalAmount": 0,

"isAccountsReceivable": true,

"createdDate": "2025-04-03T18:33:13.402Z",

"accountingEntryType": 0

}

Orders

Modification to POST /api/v1/orders/quote

he Quote endpoint has been updated to provide more detailed pricing information. It now returns:

Fuel surcharge amount on each charge for better cost transparency.
Driver commission for each charge, improving visibility into payout calculations.

This enhancement ensures greater clarity and accuracy in pricing and commission breakdowns.

Previous version:

{

"type": "Delivery",

"price": TotalPrice,

"fromZone": "Zone1",

"toZone": "Zone2"

{

Type = "Extra",

Price = TotalPrice,

Quantity = Quantity,

ExtraFeeTypeId = "ExtraFeeTypeId"

}

New Version:

{

"type": "Delivery",

"price": TotalPrice,

"driverPayRate": DriverCommission,

"fuelSurcharge": FuelSurchargeAmount,

"fromZone": "Zone1",

"toZone": "Zone2"

{

"type": "Extra",

"price": TotalPrice,

"driverPayRate": DriverCommission,

"fuelSurcharge": FuelSurchargeAmount,

"quantity": Quantity,

"extraFeeTypeId": "ExtraFeeTypeId"

}

Metadata

Metadata can now be associated with entity types (named context), allowing the storage of additional information to facilitate seamless integration between Dispatch Science and other systems.

Key Details:

Each combination of Application Id, Context and Context Id can be linked to one metadata ID.
Enables custom data storage for improved interoperability.

Supported Contexts:

Order
Driver
Transaction

Each endpoint (Put, Get and Delete) can be called with Metadataid or the ApplicationId-Context-ContextId combination.

Using Metadata Id:
PUT /api/v1/metadata/{metadataId}: this replaces the content of the metadata
DELETE /api/v1/metadata/{metadataId}
GET /api/v1/metadata/{metadataId}
Using ApplicationId-Context-ContextId combination:
PUT /api/v1/metadata/{contexIid}: this replaces the content of the metadata
DELETE /api/v1/metadata/{contextId}
GET /api/v1/metadata/{contextId}

POST /api/v1/metadata

This endpoint is used to create a new metadata entry for a specific entity id.

Body:

{

"applicationId": "string",

"context": 0,

"contextId": "string",

"content": "string"

}

where:

applicationId is the Application GUID and would be provided by Dispatch Science

context can be 0, 1, 2 (0=Transaction, 1=Driver, 2=Order)

contextId: Transaction Id (invoice id, debit note id, credit not id, adjustment id), Driver Id (Driver Guid), Order Id,

content is a string with the metadata information

On success response (Code 200):

{

"id": "metadataid"

}

PUT /api/v1/metadata/{metadataId}

This endpoint replaces the content of a metadata

Body:

{

"content": "string"

}

DELETE /api/v1/metadata/{metadataId}

This endpoint deletes a metadata.

GET /api/v1/metadata/{metadataId}

This endpoint returns the content of a metadata

Response:

{

"applicationId": "string",

"context": 0,

"contextId": "string",

"content": "string"

}

PUT /api/v1/metadata/context/{contextId}

This endpoint replaces the content of a metadata. The content {contextId} will be a combination of the 3 fields:
contextId?applicationId=applicationGUID&context=0

Body:

{

"content": "string"

}

DELETE /api/v1/metadata/context/{contextId}

This endpoint deletes a metadata. The content of {contextId} will be a combination of the 3 fields:
contextId?applicationId=applicationGUID&context=0

GET /api/v1/metadata/context/{contextId}

This endpoint returns the content of a metadata. The content of {contextId} will be a combination of the 3 fields:
contextId?applicationId=applicationGUID&context=0

Response:

{

"applicationId": "string",

"context": 0,

"contextId": "string",

"content": "string"

}

GET /api/v1/metadata/nodata?applicationId=applicationGUID&context=0&fromDate=yyyy-mm-dd

This endpoint returns all the entities with no metadata for a specific combination of application id, context and date from.

Response Body:

{

"items": [

"contextId",

"contextId"

]

}

License Plates

In previous releases, License Plates could only be set through the Driver App. With version 1.71, you can now create and manage License Plates through the API, providing greater flexibility and automation for fleet management.

GET /api/v1/licenseplates/barcode/{barcode}

Fetch or create a license plate

DELETE /api/v1/licenseplates/{licensePlateId}

Breaks a license plate

POST /api/v1/licenseplates/{licensePlateId}/add

Add items (parcel or license plate) to a license plate

Request Body:

{

"currentBarcode": "string",

"damaged": true,

"showRouteInformation": true

}

POST /api/v1/licenseplates/add

Add items (parcel or license plate) to license plates

Request Body:

{

"licensePlatesWithItemsToAdd": [

{

"licensePlateId": "string",

"licensePlateBarcode": "string",

"items": [

{

"currentBarcode": "string",

"damaged": true,

"showRouteInformation": true

}

]

}

]

}

DELETE /api/v1/licenseplates/{licensePlateId}/item

Remove an item (parcel or license plate) from a license plate

Request Body:

{

"orderId": "string",

"itemId": "string",

"licensePlateId": "string"

}

Enhancing Subscriptions with Order Rules

Webhook-based integrations often require triggers based on specific conditions, such as a particular service level or when an order reaches its final segment. Previously, webhook events were sent based solely on Order events, without the ability to restrict subscriptions based on Order criteria.

With this update, Order subscriptions now support Order rules, allowing users to define specific conditions when creating or editing subscriptions. This enhancement provides greater flexibility and ensures that webhooks are only triggered when relevant Order criteria are met.

Important Note: Rules Apply Only to Order Subscription Events.
Only subscriptions events of type Order can be configured with a Rule. If a Rule is included in a subscription for an event type other than Order, an error will be returned, and the subscription will not be created.

Integration Tenants Endpoints that will return OrderRuleId when used

GET /api/v1/subscriptions, GET /api/v1/subscriptions/{subscriptionId}, POST /api/v1/subscriptions/{accountId}/subscriptions and GET /api/v1/subscriptions/{entityType}/{entityId}

When retrieving subscriptions, any subscription that includes a rule will now be explicitly indicated. This enhancement improves visibility, making it easier to identify and manage subscriptions that have specific filtering criteria applied.

Response example:

{

"items": [

{

"subscriptionId": "subscriptionid",

"entityType": "Account or Tenant",

"entityId": "Account or TenantId",

"targetUrl": "webhook URL",

"eventTypes": [

"event type1", "event type2", ...

"orderRuleId": RuleId,

"accountId": "AccountId"

}

]

}

Integration Tenants Endpoints that will accept OrderRuleID

When an OrderRuleId is included in an Order event type subscription, the rule will be applied to ensure the subscription is only triggered when the specified criteria are met. This enhancement allows for more precise filtering, reducing unnecessary webhook notifications.

POST /api/v1/subscriptions

Request Body:

{

"EntityType": "Account",

"EntityId": "the_account_id",

"Url": "https://mywebhook.com",

"EventTypes": [

"order_picked_up"

"OrderRuleId": 1

}

PATCH /api/v1/subscriptions/{subscriptionId}

Request Body:

[

{

"op": "replace",

"path": "/orderRuleId",

"value": RuleId

}

]

POST /api/v1/subscriptions/batch

Request Body:

{

"EntityType": "Account",

"EntityIds": [

"the_first_account_id",

"the_second_account_id"

"Url": "https://mywebhook.com",

"EventTypes": [

"order_picked_up"

"OrderRuleId": RuleId

}

Integration API

Schema Documentation

In the Integration-Tenants API, some API contain enums that are used in the request body. The schemas will now show the different enums and their descriptions.

OData

Orders Table

A new field is added in the Orders Table called OrderSource. This field will show how the Order was created:

APISelfServe
APICSR
UISelfServe
UICSR
DeliveryApp
DriverApp
ImportSelfserve
ImportCSR
RecurringRoute