Here's a preview video of what's new in this release:
New features included in this release
- The current status of an order is now displayed on the order details screen
- It is now possible to override a driver's commission by extra fees
- The back-office dashboard is now configurable by administrators
- It is now possible to prevent self-serve orders from being placed with an invalid price
- New calls and additional properties can be updated through Integration and Tenant APIs
Other new features
- No UI change: Distances between 2 addresses are now cached for 5 days and if after 5 days distance is within the 5% threshold, the distance will be kept for another 5 days. This is done to ensure that the distance between 2 addresses are kept identical unless the distance changes over the acceptable +/- 5% variation limit.
Note: you can request to have the 5 days, 5% changed by contacting support. - The ability to create orders dated in the past has been reinstated for internal users and removed in Edit for external users
- It is now possible to archive attributes
Definition
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/
Back Office
Order Entry
The order status icon, previously only visible on the dispatch boards, is now displayed on the Order Entry page. This will help Customer Service agents and others quickly access and share order status information:
Driver Management
Driver Payout Schedule
It is now possible to override the driver's default payout schedule with unique commissions for specific extra fee items.
How to:
1) Go to Drivers --> Payout Schedules and select a payout schedule. You will notice a new item has been added to the screen called +Add and Extra Fee Override. Click on it:
2) Click on the COMMISSION ON EXTRA OVERRIDE (%) and select the target extra fee, then type the commission % override you want to apply for that specific extra fee. Click Save:
3) Repeat the same process for as many extra fees for which you need to apply a commission override. Click Save to save the Payout Schedule (click on the garbage bin icon next to a specific extra fee override to remove it):
Administration
Dashboard
The Back Office Dashboard is now configurable by Administrators! Is it now possible to hide or display Driver information on the board. As well, itès now possible to hide or display order information for companies and specific clients.
How to:
1) Go to Settings --> Configurations --> System and select Dashboard:
2) Check or uncheck the items you want the Dashboard to display, then click Save. The check items will become visible on the dashboard. For instance, if you check these items and click on Save:
The Dashboard will now display this:
Customer Portal
It is now possible to prevent customer portal users from entering orders with invalid pricing.
How to:
1) Go to Accounts --> Profiles, select any account profile and click on Edit the Self-Serve Options section:
2) Check NEEDS A VALID PRICE, and input the desired warning message below it, then click Save:
You're done. Next time an account user with that profile tries to create an order without a valid price, the warning message you created will display on his screen and the user will not be able to complete their order until the cause is addressed.
This will also be true when account users or admins are creating orders though the API or through an import.
API
Integration API
You can now update the Item user fields and the order user fields.
Item User Fields Update
API Call: PUT /api/v1/orders/{orderId}/items
Parameter: Order Id
Schema:
[
{
"itemId": "string",
"barcode": "string",
"parcelTypeId": "string",
"description": "string",
"weight": 0,
"height": 0,
"length": 0,
"width": 0,
"userFields": [
{
"userFieldId": "string",
"value": "string"
}
]
}
]
Note: Before updating, perform a GET /api/v1/userfields/{orderId}/items to keep the parceltype, description, dimension and weight are not overwritten during update.
You can update multiple items and multiple user fields.
Order User Fields Update
API Call: PUT /api/v1/userfields/{orderId}
Parameter: Order Id
Schema:
[
{
"userFieldId": "string",
"value": "string"
}
]
Note: You can update multiple user fields.
To get the Item user field ID, you can use the GET /api/v1/userfields/{orderId}
Tenant API
You can now update the Item user fields and the order user fields.
Item User Fields Update
API Call: PUT /api/v1/orders/{orderId}/items
Parameter: Order Id
Schema:
{
"updateWeightExtraFee": true,
"updateNumberOfPiecesExtraFee": true,
"items": [
{
"itemId": "string",
"barcode": "string",
"parcelTypeId": "string",
"description": "string",
"weight": 0,
"height": 0,
"length": 0,
"width": 0,
"userFields": [
{
"userFieldId": "string",
"value": "string"
}
]
}
]
}
Note: Before updating, perform a GET /api/v1/userfields/{orderId}/items to keep the parceltype, description, dimension and weight are not overwritten during update.
You can update multiple items and multiple user fields.
Order User Fields Update
API Call: PUT /api/v1/userfields/{orderId}
Parameter: Order Id
Schema:
[
{
"userFieldId": "string",
"value": "string"
}
]
Note: You can update multiple user fields.
To get the Item user field ID, you can use the GET /api/v1/userfields/{orderId}
Create Account Users
The account user email was a required field however, this was not set as required in the
POST /api/v1/accounts/{accountId}/users
The account user field email is now required when creating a new user.
Release a Held Order
A Held Order can now be released through the API using the POST /api/v1/orders/{orderId}/release
Order Delivery
The POST /api/v1/orders/{orderId}/deliver now allows you to enter user fields and a signature image when delivering an order.
{
"customerName": "string",
"codCollected": true,
"codAmountCollected": 0,
"identityDocumentVerified": true,
"identityDocumentType": "string",
"userFields": {
"OrderUserFieldId": "string"
},
"signature": "string"
}
Note: signature is the signature image and is entered in byte format.
You can enter multiple user fields if needed.
Set Order at Checkpoint
A checkpoint can be set on an order thorough the Tenant API:
POST /api/v1/orders/{orderId}/checkpoint
{
"checkpointId": "string"
}