TruckMate 2025.3 New Features: Web/APIs

Required upgrade (TM-173710)

TruckMate 2024.1 and later requires DB2 version 11.5.9.

You must upgrade your instance of DB2 to this version before upgrading TruckMate.

The TruckMate ART Server is a high-performance, multi-threaded HTTP server running TruckMate API services designed using Representational State Transfer (RESTful) API principles.

The ART Server currently supports these public APIs:

  • TruckMate REST API Bundle

  • Master Data APIs

  • Imaging

  • Freight Bill Import (deprecated)

Freight Bill Import and Profile Import were deprecated in March 2024. These APIs have been removed as of TruckMate 2025.2. Customers should convert to REST and MasterData APIs.

For more information, see TruckMate REST API service replaces TM4Web REST APIs.

The API release notes cover all changes made to TruckMate public APIs.

TruckMate API

Public link: https://truckmatecloudhub.trimble-transportation.com/tm/documentation

The TruckMate REST APIs are a comprehensive set of RESTful services, allowing developers to integrate TruckMate with custom or third-party applications, automate tasks, and much more.

Some ways you can use these APIs include:

  • Internal systems
    Share data and streamline internal business processes.

  • External data sharing and connection
    Share TruckMate data with third party systems.

  • Application integrations
    Access TruckMate data in real time.

  • Embedded content
    Request TruckMate data to include onto your site.

Available endpoints and methods differ depending on the license keys and authorization methods used.

To use the TruckMate REST APIs, we recommend upgrading directly to the latest version of TruckMate instead of an earlier release. This gives you access to the most current, improved, and expanded set of API methods and endpoints.

The following additional information is available on the Transportation Knowledge Base:

These tables list issues in numerical order by case number.

Orders API

Case Issue Case Name Description

TM-164245

legId should be a nullable field for PUT tm/orders/orderId status endpoint in the response body

Added nullable property in openAPI for legId for PUT orders/orderId/status response body schema.

TM-182573

DEV: Add more fields to GET orders.quoteStatus resource

Added additional fields to the response of GET orders.quoteStatus.

TM-183225

TMS_ORDERS - Drop the index for DETAIL_LINE_ID for CGTT_DLD_ONLY

Removed indexes for CGTT tables used for retrieving orders and trips in the REST API as they did not carry any performance benefit.

TM-183387

POST orders?copyOrderId=xxx is not able to create type T orders from quotes

Fixed an issue with POST orders?copyOrderId, where type T orders could not be created from quotes.

TM-184358

PUT orders/orderId/status - Wrong error message returned for status updates when users don’t have sufficient rights to apply an admin status change

Fixed the error message returned when the user associated with an API key tries to apply an administrative status change to order without have the necessary permission using the orders API.

  • PUT orders/{orderId}/status

Trips API

Case Issue Case Name Description

TM-183807

GET trips - Add new query parameter loadOfferOnly

Added support for a new query parameter loadOfferOnly in the trips API (GET trips) that can be used to return trips where a carrier is assigned but the load offer is pending to be either accepted or rejected.

Finance API

Case Issue Case Name Description

TM-180963

Finance - Add GET /glAccounts

Added support to retrieve GL accounts using the Finance REST API.

  • GET glAccounts

  • GET glAccounts/glAccountId

TM-182071

ART Finance - DriverDeductions or DriverPayments - PUT - click Send, get '400 Bad Request' after a driver deduction record or driver pay record has "driverId" updated successfully

Fixed an issue where ART Finance - DriverDeductions or DriverPayments - PUT gave an incorrect response when Driver ID was updated.

TM-183933

Finance - Add public link to download openAPI doc

Added a public link to the finance openAPI that can be used to download the related openAPI documentation.

Master Data API

Public link: https://truckmatecloudhub.trimble-transportation.com/masterData/documentation

The Master Data management API allows an external system to create, retrieve, update, or delete TruckMate configuration data. Some data types include client, vendor, and driver profiles, as well as sites, zones, commodity codes, and so on.

Case Issue Case Name Description

TM-182904

DEV 4b-2, Other applications - Imaging API, support changes on tb:CLIENT

Verified that the change made in the CLIENT table regarding Appointment Required values has been supported by the Imaging API.

TM-184298

MasterData (Active Loads) - should be set to no cache for GET /statusCodes endpoint call

Set the cache-control - max-age to 0 for GET statusCodes call to stop the caching of the endpoint response.

TM-185108

MasterData - Vendors API - Need to add missing fields that were supported in the profiles API

MasterData API - Added 4 properties to the Vendors API to support the following fields:

  • status

  • currencyCode

  • openTime

  • closeTime

ConnectedDock API (ART)

Case Issue Case Name Description

TM-177815

ConnectedDock - Rename query parameter "terminal" to "terminalId" in GET terminal/doors

Renamed the query parameter terminal to terminalId for GET /terminals/:terminalId/doors based on the TruckMate API’s standards for openAPI doc and ConnectedDock.

TM-183836

Rename trip_seals endpoint to tripSeals

Standardized the endpoint name from trip_seals to tripSeals.

Other APIs

Case Issue Case Name Description

TM-166568

ConnectedDock screen_custom_fields endpoint

Hid the screenCustomFields endpoint and updated the screenCustomFields portion of GET /setup in the openAPI doc.

TM-166569

ConnectedDock scale endpoint

Updated the scale OpenAPI doc.

TM-166570

ConnectedDock route endpoint

Deprecated unsupported GET /routes, expanded GET /terminals to support routes as subresources, and fixed missing routeId in ConnectedDock responses.

TM-166571

ConnectedDock generic_resources endpoint

Hide the GET genericResources endpoint and updated the genericResources portion of the GET /terminals endpoint.

TM-166572

ConnectedDock osdTypes endpoint

Enhanced ConnectedDock /osdTypes endpoints with pagination support, improved response schemas, and updated descriptions.

TM-166576

ConnectedDock reason_codes endpoint

Updated ConnectedDock reasonCodes endpoints for ConnectedDock.

TM-166578

ConnectedDock units endpoint

Removed the GET units endpoints from ConnectedDock service.

TM-166579

ConnectedDock services endpoint

Added OpenAPI documentation for services in ConnectedDock.

TM-166580

ConnectedDock status endpoint

Updated the Connected Dock GET /status endpoints to follow the API standard.

TM-166581

ConnectedDock commodities endpoint

Removed support for commodities from the ConnectedDock endpoint.

TM-166582

ConnectedDock aChargeCodes endpoint

Removed support for the aChargeCodes endpoints from the ConnectedDock endpoint.

TM-166583

ConnectedDock scan_prefix endpoint

Updated the GET /scanPrefixes endpoint.

TM-175501

Track changes to ART API Keys

Added the ability to track changes made to the TruckMate API Key. Changes include generation, re-generation, and revocation of TruckMate API Keys. A comment field has also been added for entering additional details regarding specific TruckMate API Key records.

TM-176031

ART - Service properties DB password is limited to 19 characters

Fixed an issue where the ART service could not be run with a user that has a password that exceeds 19 characters.

TM-176840

ARTAdmin - Set the TrustedJwksIssuers registry value for TMS Connector

Enhanced the ART service creation process to automatically populate the TrustedJwksIssuers registry value and ensured it is not wiped during service property edits

TM-177812

ConnectedDock - ART - GET /terminals/:terminalId/location_summary - Rename to locationSummary

Updated the child resource of terminals from location_summary to locationSummary to follow the TruckMate API standards. ConnectedDock mobile app is updated to use the new child resource name.

TM-178696

Remove Profiles API from ARTAdmin

Removed Profile Import API option from the ARTAdmin.

TM-179474

Trips API - Carriers - Fix missing two enum values from costAllocationRule

Added pieces and pallet enum option to the costAllocationRule field for trip carriers. Also updated openAPI document description.

TM-180230

ConnectedDock - GET /company - Fixes for company endpoint in the openAPI document

Updated the OpenAPI document for GET /company.

TM-181181

Imaging API - memory issues

Fixed an issue within the Imaging service where a memory leak was occurring when the service was in use.

This has been corrected - the memory leak that was causing issues against the Imaging service will no longer occur.

TM-181338

ConnectedDock - GET /locations - DB2 error getting location by id

Disabled direct access to the GET dock/locations endpoint.

TM-182452

ConnectedDock - Security risk: dock worker can access supervisor rights through API

Made a modification to the ConnectedDock application to add additional security around the Supervisor PIN workflow. This adjustments adds an additional security layer to the app itself to prevent bad actors from being able to access the PIN’s assigned to each Supervisor.

Users will experience no adjustment to the Supervisor PIN workflow on the application itself; all changes were done behind the scenes.

TM-182618

ConnectedDock - POST /image - Add request body as multipart/form-data format

Add multi-form data format field to request body for POST /image endpoint in the openAPI documentation for the Connected Dock API.

TM-182682

ConnectedDock - scan_events endpoint

Added OpenAPI documentation for scan_events in ConnectedDock.

TM-182845

ConnectedDock - Re-order the Scanning Prefixes title in OpenAPI

Relocated the Scanning Prefixes to the correct position in the openAPI doc by the alphabetical order.

TM-182975

GET trips - Add support for $filter for carriers/status child resource field

Added support for $filter functionality for the carriers/status child resource field in the GET/Trips endpoint.

TM-183093

ART loading LogConfigs - Out-of-bounds array access

Issue has been resolved.

TM-183360

ConnectedDock - fix access violation in ad item to palletgroup

Fixed access violation when adding an item to a non-existent pallet group.

TM-183541

ART - Create new building option for FastMM4

Added an option when building a debug version of ART.exe application that allows for detection of memory leaks.

TM-183950

ConnectedDock - Fix terminalId for GET /terminals and GET /doors endpoints on OpenAPI doc

Renamed the path parameter from terminalId to termId to avoid the name conflict of query parameter.

Updated the query parameter terminalId as optional for GET terminals endpoints without affecting GET doors endpoints.

TM-185454

ART - Implement client credentials authentication for TTC services

Added support for Trimble Transportation Cloud (TTC) client credential tokens to authenticate with TruckMate REST API services (ART).

TM4Web

Case Issue Case Name Description

TM-183450

Add more documentation around creating extra stops POST orders

Added extraStops info to the POST /orders endpoint description. Updated the copyright year to 2025.