Open Trip Model (v5.8.0)

Why OTM?

In this day and age more and more information about logistics and traffic is shared over the Internet between various parties. To make this communication easier the Open Trip Model specification was created. It is a lightweight data model used to exchange real-time logistic trip data on the web, and to make it easier for shippers, carriers, software vendors, OEMs, and truck manufacturers to create new multi-brand applications and services.

To learn more about the what, the why and the how see the OTM documentation website.

Changelog

Found any bugs on this page? Or have any feature requests for OTM? Create a new ticket on the OTM5 change requests Github page

Unreleased changes

Version 5.8 (released on 2026-03-13)

• Remove several duplicate definitions of the same entity or fields e.g. unit of measure
• Add actions property for vehicle entity. This allows to relate actions to a vehicle without the need to relate them to a trip. E.g. to indicate that a vehicle has a trailer (i.e. transport equipment) attached. See 108
• Better explain the difference between fields actors[].entity.role and actors[].roles See 109
• Fix inconsistencies in the specification of use of actor entity. See 110
• Add volume property to transport equipment and goods items. This can be provided by means of value and unit (e.g. 120 m3). See 111
• Add support for multiple vehicle fuel types. This deprecated the fields: 'fuel', 'otherFuelType' and 'averageFuelConsumption' on the vehicle entity, and replaces it with a new field 'fuels' that allows for multiple fuel types, each with their own average fuel consumption. See 112
• Extend list of possible fuel types See 113
• Add the possibility to reference entities in the action result and specificy sub results. For example the unload action can be succeeded for certain goods and failed for others, in which case the overall result would be partially succeeded and the sub results would indicate which goods were unloaded successfully and which were not. See 115
• Extend list of possible emission standards with value Z See 117
• Fix missing entityType property for goods sub types items and transport equipment. See 118
• Fix circular polymorphic pattern for actor, person and company. See 119
• Add missing actions property in consignment entity. See 121

Version 5.7 (released on 2025-05-23)

• Fix broken link to goods packaging type codes. See 87.
• Fix inconsistent use of plural name 'geoReferences' for non array property in route definitions. Add new property 'geoReference' and deprecate 'geoReferences'. First one is now required. See 86.
• Add enums for location types 'fuelStation', 'serviceStation' and 'other'. Add new property 'otherLocationType' to specify the location type in case of 'other'. See 73.
• Add eight new action result reasons, including 'deliveredElsewhere', 'deliveredToWrongReceiver' and 'other'. In case of 'other' the result reason can be provided as free text in the existing remark property. See 89.
• Add distance property in move action. This can be provided by means of value and unit (e.g. 120 km) See 90
• Add two specializations of actor, i.e. 'peron' and 'company'. Each with an additional set of properties. See 100

Version 5.6 (released on 2023-11-17)

• Add loading and unloading consignment in and from transport equipment. See 63.
• Add enforceability of a constraint. See 75.
• Add recurring date times & durations on actions & events. See 75.
• Add sub-locations as optional field on a location. See 77.
• Add owner as a new type of actor role. See 78.
• Add routeEntityConstraint and deprecate routeConstraint. See 80.

Version 5.5 (released on 2023-02-07)

• Explain when to use Consignment vs Goods constraints. See 42.
• Make fuel on vehicle an enum instead of a free string. See 51.
• Add emissionStandardConstraint as a possible constraint. See 52.
• Add transportOrder as a field on Consignment to enable the two-way relationship. See 59.
• Add eori as a possible contact detail option. See 60.
• Add valueBoundConstraint as a possible constraint. See 61.
• Add refuel as a possible action. See 62.
• Add accessConstraint as possible constraint. See 69.

Version 5.4 (released on 2022-05-09)

• _Add a TransportEquipmentConstraint. See 46.
• _Add averageFuelConsumption to vehicle. See 48.
• _Add fuel consumption and emission events. See 49.
• _Add contextEvents on entities. See 49.
• _Add sequenceNr to all action types. See 50.
• _Add cancelled on action results and receiverAbsent as 'reason' type. See 53.
• _Add actors to all event types. See 55.
• _Add description to all constraint types. See 56.

Version 5.3 (released on 2021-12-16)

• Support 204 (No Content) for delete requests. See 23.
• Add classification lines to goods. See 26.
• Add a result to actions. See 30.
• Extend ADR with points and transport category. See 31.
• Support relatedConsignments in consignments. See 32.
• Support UNCode and GLN in locations. See 36.
• Support temperatureConstraint as a possible constraint type. See 37.
• Add some references to existing code lists. See 27.
  • Using ISO country codes in the country field in addresses.
  • Using ISO currency codes in 'value-with-unit' fields.
  • Using the metric system as recommend and default system for dealing with mass, velocity, weight and sizes.
  • Using the package material codes from the GS1 standard.

Version 5.2 (released on 2021-09-09)

• _Add transportEquipmentSubType for example to indicate what type of pallets you use. See 19.
• _Add timeWindowConstraint to replace startDateTimeConstraint and endDateTimeConstraint. See 6.
• _Add operationalBase as a location type. See 22.
• _Add more actor role types. See 20.
• _Add new break and wait actions. See 17.
• _Allow for server side UUID generation. See 16.

Version 5.1 (released on 2021-06-01)

• Add an optional emission to Vehicle. See 13.
• Add an optional transportMode to Trip and Move. See 12.
• Add optional grossWeight to Goods. See 11.
• AddmobilePhone as contact detail option. See 5.
• Add an optional lastModified field to each entity. See 2.
• Add an optional language to contact details. See 9.
• Add a new entity Document to deal with information about files that can be shared. See 7.
• Add new statuses to Trip and Consignment. See 4.
• Add an optional sensors association to vehicle. See 2.

Version 5.0 (only documentation changes)

• Add documentation about validation endpoints.
• Add reference to the otm5-change-requests github.
• Fix the broken checkbox for actions when choosing the Stop action.
• Document the license plate on a TransportEquipment (i.e. a trailer).