Full Planning example
Following all previous pages for this guide, you will end up with a full message example like underneath. In case you still need more detail on each field: feel free to visit the full OTM specification on https://www.opentripmodel.org
{
"id": "2a8af6c6-e4d5-5dfb-9532-e8b17c3ffd88",
"name": "DCX|2020|32-2-888",
"externalAttributes": {
"displayName": "DCX|32-2-888",
"plannedStart": "2020-10-14T08:54Z",
"groupingAddressIdentifier": "7",
"oneWay": "false",
"plannedLicensePlate": "31-ABC-3",
"requestedTractorType": "CITY_11_20",
"insertDate": "2020-10-13T14:27:57.885Z",
"administrativeKm": "73",
"plannedEnd": "2020-10-14T11:31Z",
"cancelled": "false",
"department": "DCX-VW",
"customer_data_taskNumber": "2284",
"mutated": "false",
"plannedDeparture": "2020-10-14T09:24Z",
"requestedFuelType": "EURO_6_DIESEL",
"planningLastModified": "2020-10-14T08:45:17.761Z",
"activity": "APPROACHING_START",
"routeNumber": "32-2-888",
"superLorry": "false",
"administrativeTime": "02:37",
"totalVolume": "0.0",
"requestedVehicleCapacity": "45.0"
},
"vehicle": {
"entity": {
"id": "8e410040-1b36-4179-a216-63fcd2e9c888",
"externalAttributes": {
"licensePlate": "31-ABC-3",
"customerDeviceIdentifier": "TEST01",
"externalDeviceIdentifier": "TEST01",
"deviceName": "TEST01"
},
"vehicleType": "Tractor",
"fuel": "EURO_5_DIESEL",
"actors": [
{
"entity": {
"id": "861355f1-24ec-3fe3-bd0e-9ddfb2fc6d3d",
"name": "Hendricus Gillis"
},
"associationType": "inline"
}
]
},
"associationType": "inline"
},
"actors": [
{
"entity": {
"id": "66cbe2e0-3f0e-5b19-85e8-f0fb7302a888",
"name": "Janszoon Transport B.V.",
"externalAttributes": {
"code": "janszoon",
"description": "carrier"
}
},
"associationType": "inline"
},
{
"entity": {
"id": "79b50ea6-b390-528e-9920-efe260a1b888",
"name": "Supermercado",
"externalAttributes": {
"code": "supermercado",
"description": "shipper"
}
},
"associationType": "inline"
}
],
"actions": [
{
"entity": {
"id": "79d841c8-90f7-5c36-8ac4-9630d4979888",
"externalAttributes": {
"exceptionLateThreshold": "2020-10-14T09:11Z",
"stopType": "DC",
"externalStopId": "DCX|2020|32-2-888|DC",
"label": "1",
"returnFlowAllowed": "false",
"cancelled": "false",
"customer_data_taskNumber": "2284",
"sequence": "1",
"exceptionEarlyThreshold": "2020-10-14T07:56Z",
"mutated": "false",
"isOriginallyPlanned": "false",
"administrative": "false"
},
"lifecycle": "planned",
"location": {
"entity": {
"id": "8f14e45f-ceea-367a-9a36-aabb4bea2543",
"name": "DCX",
"externalAttributes": {
"locationId": "7",
"globalLocationNumber": "9210400000329",
"customerLocationIdentifier": "NL1234AB0001"
},
"geoReference": {
"lat": 52.1561113,
"lon": 5.3878266,
"type": "latLonPointGeoReference"
},
"administrativeReference": {
"name": "DCX",
"street": "Auroraweg 1",
"postalCode": "1234AB",
"city": "Eindhoven",
"country": "NLD"
}
},
"associationType": "inline"
},
"startTime": "2020-10-14T08:56:00Z",
"endTime": "2020-10-14T09:18:00Z",
"actions": [
{
"entity": {
"id": "6162b713-fa89-38b2-bb27-6d1e6bbd1c70",
"transportEquipment": {
"entity": {
"id": "fb4a5174-8ab6-3061-8764-10e0794e2e39",
"externalAttributes": {
"licensePlate": "OS-44-HH",
"trailerType": "EURO_13_60_KOEL"
},
"equipmentType": "trailer"
},
"associationType": "inline"
},
"actionType": "attachTransportEquipment"
},
"associationType": "inline"
},
{
"entity": {
"id": "73385065-7f7d-3138-a908-f29e1da4458f",
"lifecycle": "planned",
"consignment": {
"uuid": "03dee193-9f36-569f-b061-269f22bdd112",
"entityType": "consignment",
"associationType": "reference"
},
"actionType": "load"
},
"associationType": "inline"
}
],
"actionType": "stop"
},
"associationType": "inline"
},
{
"entity": {
"id": "12576db0-1b92-3e96-b4b9-cc8a7bc4b27f",
"from": {
"uuid": "8f14e45f-ceea-367a-9a36-aabb4bea2543",
"entityType": "location",
"associationType": "reference"
},
"to": {
"entity": {
"id": "571d3a94-20bf-3921-9f65-b643d0003ccc",
"name": "John's Shop",
"externalAttributes": {
"locationId": "1",
"globalLocationNumber": "8710400011",
"customerLocationIdentifier": "NL8891DG017X"
},
"geoReference": {
"lat": 52.1561113,
"lon": 5.3878266,
"type": "latLonPointGeoReference"
},
"administrativeReference": {
"name": "John's Shop",
"street": "Septemberstraat 9",
"postalCode": "8891DG",
"city": "Almere",
"country": "NLD"
}
},
"associationType": "inline"
},
"actions": [
],
"actionType": "move"
},
"associationType": "inline"
},
{
"entity": {
"id": "b1c0acef-1108-5555-ae6f-bf8c96f9e74b",
"externalAttributes": {
"exceptionLateThreshold": "2020-10-14T10:11Z",
"timeWindowStart": "2020-10-14T09:00Z",
"stopType": "WINKEL",
"timeWindowEnd": "2020-10-14T11:00Z",
"externalStopId": "147531300",
"label": "2",
"returnFlowAllowed": "false",
"cancelled": "false",
"customer_data_taskNumber": "2284",
"sequence": "2",
"exceptionEarlyThreshold": "2020-10-14T08:56Z",
"mutated": "false",
"isOriginallyPlanned": "false",
"administrative": "false"
},
"lifecycle": "planned",
"location": {
"uuid": "571d3a94-20bf-3921-9f65-b643d0003ccc",
"entityType": "location",
"associationType": "reference"
},
"startTime": "2020-10-14T09:56:00Z",
"endTime": "2020-10-14T10:40:00Z",
"actions": [
{
"entity": {
"id": "308abb7f-138e-353d-bf3c-719589308730",
"lifecycle": "planned",
"consignment": {
"entity": {
"id": "03dee193-9f36-569f-b061-269f22bdd112",
"externalAttributes": {
"externalShipmentId": "147531300HH-drop",
"externalOrderId": "482e4dea-d389-38ec-8057-55778241ac71",
"shipmentNumber": "1",
"cancelled": "false"
},
"type": "HB",
"goods": []
},
"associationType": "inline"
},
"actionType": "unload"
},
"associationType": "inline"
},
{
"entity": {
"id": "def5197e-a9e6-35d1-868e-dce26b3d99c1",
"lifecycle": "planned",
"consignment": {
"uuid": "66086228-f456-550c-a16b-5cd56edd4599",
"entityType": "consignment",
"associationType": "reference"
},
"actionType": "load"
},
"associationType": "inline"
}
],
"actionType": "stop"
},
"associationType": "inline"
},
{
"entity": {
"id": "c9d6bcba-b514-3c07-82b7-9dfb596e0bfd",
"from": {
"uuid": "571d3a94-20bf-3921-9f65-b643d0003ccc",
"entityType": "location",
"associationType": "reference"
},
"to": {
"entity": {
"id": "868a4b62-023a-3d9d-b827-6152d8c5aaaa",
"name": "Enterprise",
"externalAttributes": {
"locationId": "999",
"globalLocationNumber": "8710400000123",
"customerLocationIdentifier": "NL8213BT07RH"
},
"geoReference": {
"lat": 52.1561113,
"lon": 5.3878266,
"type": "latLonPointGeoReference"
},
"administrativeReference": {
"name": "Enterprise",
"street": "Zazastraat 7",
"postalCode": "8213BT",
"city": "Oss",
"country": "NLD"
}
},
"associationType": "inline"
},
"actions": [],
"actionType": "move"
},
"associationType": "inline"
},
{
"entity": {
"id": "56effb57-8455-5471-ad02-ce8049839d2e",
"externalAttributes": {
"exceptionLateThreshold": "2020-10-14T11:28Z",
"stopType": "MC",
"externalStopId": "DCX|2020|32-2-888|MC",
"label": "3",
"returnFlowAllowed": "false",
"cancelled": "false",
"customer_data_taskNumber": "2284",
"sequence": "3",
"mutated": "false",
"isOriginallyPlanned": "false",
"administrative": "false"
},
"lifecycle": "planned",
"location": {
"uuid": "868a4b62-023a-3d9d-b827-6152d8c5aaaa",
"entityType": "location",
"associationType": "reference"
},
"startTime": "2020-10-14T11:13:00Z",
"endTime": "2020-10-14T11:31:00Z",
"actions": [
{
"entity": {
"id": "97aced43-f2a8-31bf-ace3-67707adc88b8",
"lifecycle": "planned",
"consignment": {
"entity": {
"id": "66086228-f456-550c-a16b-5cd56edd4599",
"externalAttributes": {
"externalShipmentId": "DCX|2020|32-2-888|MC|1",
"externalOrderId": "2165ecf7-55dd-3afa-938a-2161b901bdef",
"shipmentNumber": "1",
"cancelled": "false"
},
"type": "emballage",
"goods": [],
"freightDocumentReferences": [
{
"type": "eCMR",
"authorityReference": "NL000000159999TFL",
"provider": {
"entity": {
"id": "be307f84-2149-3686-8029-7598ad798888",
"name": "transfollow"
},
"associationType": "inline"
},
"status": "draft",
"externalAttributes": {
"externalId": "316333",
"freightDocumentUrl": "https://portal.partner.transfollow.com/#/view/316333"
}
}
]
},
"associationType": "inline"
},
"actionType": "unload"
},
"associationType": "inline"
}
],
"actionType": "stop"
},
"associationType": "inline"
}
]
}