TruckMate 2022.1 New Features: Web / APIs

A new optional parameter in the POST imaging/interlinerpayables/approve endpoint lets you override the tolerance by a dollar amount when using the API to approve an interliner payable record.

The TruckMate REST API tm/trips endpoints now include planned departure and scheduled arrival fields.

The Agent REST API service has been deprecated and removed from version 2022.1 of the ART Server Administrator.

The internal API documentation in the openapi.json file is now sorted in alphabetical order.

The True and False fields in the ART Server services now ignores capitalization or upper and lower case forms for any true and false values.

The GET tm/trips and GET tm/trips/{tripNumberId} endpoints in the TruckMate REST API service now use arrays for each resource type. This means it can retrieve all the resources for a trip. This change applies to these resource types:

The response body in the tm/orders statusHistory section now contains reason and reasonDescription fields.

The reason field was removed for trip-based status change requests.

For resources, the type and action fields return consistent value formats in the request and response body for tm/trips.

The ART Server Administrator application now has new levels to group log files.

Now, you can retrieve a list of drivers and power units in tm/trips for their endpoints:

TM4Web imaging now supports WorkOptima.

To use it, set up Other imaging vendor document types in Codes Maintenance. For each document type, set the URL to:

http://TM4WEB DOMAIN/imaging/workOptima.msw?documentType=%t&searchValue=%i

The contacts endpoint was removed from the TruckMate REST API (/tm) service. This affects:

The arrivedActual and departedActual fields in the GET trips/{tripNumber}/stops endpoint now display the correct values.

All TruckMate REST API services now verify the request body entries match the OpenAPI spec. An error message appears if there is a mismatch. For example:

{"errorCode":400, "errorText": "orderId is expected to be a valid integer."}

The POST tm/trips API request checks for valid entries before creating a trip. For example:

The tm/documents endpoint in the TruckMate REST API service can now use a web user Java web token (JWT) for authorization to retrieve a document.

Some error messages now provide more information about what caused an error and how to fix it.

All error messages now follow a consistent format.

The API documentation in the OpenAPI specification has been updated. All of the endpoints describe the correct response codes.

The 404 (Not found) error code responses for tm/trips, tm/orders, and related sub endpoints return consistent error text.

For better workflow and consistency, the orders sub paths have been removed from the tm/trips API path. Access these endpoints through the tm/orders API path.

The only orders sub resources accessible through tm/trips are:

Now you can use an OData filter on trace numbers for the GET tm/orders/orderId/traceNumbers endpoint.

You can now unassign orders from a trip using the Trips API and the DELETE methods.

The webUpdate field for the tm/orders endpoint displays a list of valid options.

The TruckMate REST API service OpenAPI specification now reflects the correct list.

When sending a request to an endpoint that has no required fields but at least one field that needs to be sent, changes were made to how it handles the request body being empty. Instead of returning a 200 (Success) code, it now returns a 400 (Client Error) code.

Now, you can generate and retrieve a document even if the document type contains a space.

The tm/trips API requests now display resources for a delivery and terminal stop that has resources and actions.

Now, the tm/trips API consistently creates stops for non-terminal zones when creating P&D trips.

A memory leak no longer occurs when you:

POST /orders/{orderId}/notes no longer returns an error when creating notes for an order.

The TM4Web external trace results now load correctly with no PHP error.

Special characters (such as â, ê, î, ô) are now saved correctly when using the /tm POST or PUT methods.

When launched as a Windows service, the TruckMate API was unable to find the TMCrystalNetPlugin DLL when accessing the /reports endpoint. This has been resolved for version 2022.1.

Now, tm/trips can unassign orders already assigned to a trip without an SQL error.

Because you cannot write to it, the phoneNumber field has been removed from the tm/orders request body schema. It combines the phone and phoneExt fields and can be returned in the response body for all contact types.

The POST tm/orders API now populates the currency when you enter a COD amount.

The TM4Web REST API no longer return a 500 (Internal Server Error) error when using POST tm4web/orders to create orders.

The TruckMate REST API no longer returns an error when using POST or PUT tm/orders with a phone number value that contains more than 13 characters. It now accepts phone numbers up to 20 characters.

The tm/trips API now displays a 202 (received but not completed yet) response code for partial trip creation. These are scenarios in which one or more orders cannot be matched due to business logic.

The PUT /trips/tripNumber/orderId/status endpoint no longer returns a 301 (Moved permanently) error when changing an LTL status.

The /tm/trips API was creating P&D trips that were already parked at Door 0. This prevented them from being parked at a real door later.

The /assign and /deassign endpoints for /tm/trips were generating a 404 (Not Found) error. This has been fixed for:

The TruckMate REST API’s TripControls schema now contains a deassignOrdersFromMatchingTrips control function. It allows you to unassign orders that are already assigned to a trip.

New logic has been added to ensure that when you create a new P&D trip and this control function is set to True, only orders from trips with matching start and end zone are unassigned. Previously, inactive trips with different start and end zones were being matched.

When the order is already assigned to another uncompleted trip with matching start and end zones (for example, coming out of the same terminal), the following logic applies: