Calendar occurrences for vehicles within a date range.
API Reference//
- Complete a trip
Start a trip
Finish a trip and start a new trip
Get combined financials
Update trips
Create trip
Finish a trip
Create trip and generate route
Confirm a trip
Get trip
Delete trip
Update action lifeCycle
Update vehicle trips order
Update action times
Cancel trips
Update trip
Create trip
Update action times
Complete all actions on a trip
Get trips
Search trips
Cancel a trip
Create trips
Get trip
Get trip activity
Confirm trips
Add documents
Complete a trip
Transportial OTMS API (0.9.74)
Welcome to the Transportial API. It's the full API access for the OTMS Transportatial application. Every feature that is available (and more) in the UI is available here. It's our mission to facilitate open, fast, enterprise grade architecture for transportation.
Download OpenAPI description
Overview
Languages
Servers
Mock server
https://docs.transportial.com/_mock/apis
Test environment
https://test.api.otms.transportial.com/api
Production
https://api.otms.transportial.com/api
Request
Complete all actions on a trip in bulk, marking them as REALIZED. This is useful when customers don't use driver-links or integrations and need to easily complete a trip by providing the dates/times of completion.
You can optionally specify start/end times and results per action, or use default values that apply to all actions.
Security
bearer or apiKey or apiSecret
Optional list of action completion details. If not provided, all actions will be completed with current timestamp.
Default start time to use for actions not specified in the actions list. Defaults to current time.
Default end time to use for actions not specified in the actions list. Defaults to current time.
- Mock serverhttps://docs.transportial.com/_mock/apis/trip/{id}/complete-actions
- Test environmenthttps://test.api.otms.transportial.com/api/trip/{id}/complete-actions
- Productionhttps://api.otms.transportial.com/api/trip/{id}/complete-actions
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://docs.transportial.com/_mock/apis/trip/{id}/complete-actions?shareCode=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"actions": [
{
"actionId": "string",
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"result": {
"status": "succeeded",
"remark": "string",
"reason": "string",
"results": [
{
"property1": {},
"property2": {}
}
],
"answers": {
"property1": {},
"property2": {}
},
"attachments": [
{
"questionId": "string",
"type": "photo",
"documentId": "string",
"dataUrl": "string"
}
]
}
}
],
"defaultStartTime": "2019-08-24T14:15:22Z",
"defaultEndTime": "2019-08-24T14:15:22Z",
"defaultResult": {
"status": "succeeded",
"remark": "string",
"reason": "string",
"results": [
{
"property1": {},
"property2": {}
}
],
"answers": {
"property1": {},
"property2": {}
},
"attachments": [
{
"questionId": "string",
"type": "photo",
"documentId": "string",
"dataUrl": "string"
}
]
}
}'Response
application/json
{ "success": true, "message": "string", "code": 0, "trip": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "language": {}, "name": "string", "type": "internal", "tripNr": "string", "remark": "string", "route": { … }, "stackMap": { … }, "status": "draft", "planStatus": "ok", "routeStatus": "on_route", "currentAction": {}, "transportMode": "maritime", "capacityContract": { … }, "vehicle": {}, "linkedTrip": true, "chauffeurs": [ … ], "transportEquipments": [ … ], "consignments": [ … ], "contextEvents": [ … ], "documents": [ … ], "actors": [ … ], "actions": [ … ], "constraints": [ … ], "identifiers": [ … ], "businesses": [ … ], "startDate": "2019-08-24T14:15:22Z", "endDate": "2019-08-24T14:15:22Z", "kmStart": 0, "kmEnd": 0, "booking": { … }, "shareSettings": { … }, "externalAttributes": { … }, "expectedCost": { … }, "expectedRevenue": { … }, "actualCost": { … }, "quote": { … }, "CO2eWTW": 0.1, "CO2eTTW": 0.1, "nextAction": {}, "lastAction": {}, "estimatedDuration": 0, "versionNumber": 0 } }
- Mock serverhttps://docs.transportial.com/_mock/apis/trip/{id}/complete
- Test environmenthttps://test.api.otms.transportial.com/api/trip/{id}/complete
- Productionhttps://api.otms.transportial.com/api/trip/{id}/complete
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.transportial.com/_mock/apis/trip/{id}/complete' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Response
application/json
{ "success": true, "message": "string", "code": 0, "trip": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "language": {}, "name": "string", "type": "internal", "tripNr": "string", "remark": "string", "route": { … }, "stackMap": { … }, "status": "draft", "planStatus": "ok", "routeStatus": "on_route", "currentAction": {}, "transportMode": "maritime", "capacityContract": { … }, "vehicle": {}, "linkedTrip": true, "chauffeurs": [ … ], "transportEquipments": [ … ], "consignments": [ … ], "contextEvents": [ … ], "documents": [ … ], "actors": [ … ], "actions": [ … ], "constraints": [ … ], "identifiers": [ … ], "businesses": [ … ], "startDate": "2019-08-24T14:15:22Z", "endDate": "2019-08-24T14:15:22Z", "kmStart": 0, "kmEnd": 0, "booking": { … }, "shareSettings": { … }, "externalAttributes": { … }, "expectedCost": { … }, "expectedRevenue": { … }, "actualCost": { … }, "quote": { … }, "CO2eWTW": 0.1, "CO2eTTW": 0.1, "nextAction": {}, "lastAction": {}, "estimatedDuration": 0, "versionNumber": 0 } }
- Mock serverhttps://docs.transportial.com/_mock/apis/trips/{offset}/{amount}
- Test environmenthttps://test.api.otms.transportial.com/api/trips/{offset}/{amount}
- Productionhttps://api.otms.transportial.com/api/trips/{offset}/{amount}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.transportial.com/_mock/apis/trips/{offset}/{amount}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Response
application/json
{ "success": true, "message": "string", "code": 0, "totalResults": 0, "trips": [ { … } ] }
TransportEquipment are the items to be transported as part of a consignment. TransportEquipment can be divided into two sub-types of transportEquipment, depending on the use case and the level of detail. TransportEquipment either consists of items, describing the actual transportEquipment to be transported. Or a transport equipment, which is equipment used to carry the actual transportEquipment to be transported. Transport equipment is (usually) a means to an end, not something that needs to be transported on itself, such as pallets.
Operations
Goods are the items to be transported as part of a consignment. Goods can be divided into two sub-types of goods, depending on the use case and the level of detail. Goods either consists of items, describing the actual goods to be transported. Or a transport equipment, which is equipment used to carry the actual goods to be transported. Transport equipment is (usually) a means to an end, not something that needs to be transported on itself, such as pallets.
Operations
Events - like actions - model dynamic entities that couple various static entities at a certain moment in time. Events are used for either real-time updates, or updates on earlier provided data. Notice that in both event types these are updates on earlier provided data, whereas actions are usually used together with the entities they dynamically couple.
Operations