# Transportial OTMS API 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. Version: 0.9.74 ## Servers Test environment ``` https://test.api.otms.transportial.com/api ``` Production ``` https://api.otms.transportial.com/api ``` ## Security ### apiKey Type: apiKey In: header Name: x-api-key ### bearer Type: http Scheme: bearer Bearer Format: JWT ### apiSecret Type: apiKey In: header Name: x-api-secret ## Download OpenAPI description [Transportial OTMS API](https://docs.transportial.com/_bundle/apis/index.yaml) ## Calendar Events Calendar occurrences for vehicles within a date range. ### Check if a specific vehicle is available (no conflicting calendar events) within a date range. - [GET /calendar/vehicles/{vehicleId}/available](https://docs.transportial.com/apis/calendar-events/isvehicleavailable.md) ### Add or update an exception for a specific recurring event. - [POST /calendar/recurring-events/{recurringEventId}/exception](https://docs.transportial.com/apis/calendar-events/addeventexception.md) ### Get calendar events for a specific vehicle within a date range. - [GET /calendar/vehicles/{vehicleId}/events](https://docs.transportial.com/apis/calendar-events/getvehiclecalendarevents.md) ### Get occurrences of recurring events within a date range. - [GET /calendar/recurring-events/occurrences](https://docs.transportial.com/apis/calendar-events/geteventoccurrences.md) ### Get calendar events for a specific transport equipment within a date range. - [GET /calendar/transport-equipment/{equipmentId}/events](https://docs.transportial.com/apis/calendar-events/gettransportequipmentcalendarevents.md) ### Create a new recurring calendar event. - [POST /calendar/recurring-events](https://docs.transportial.com/apis/calendar-events/createrecurringevent.md) ## Tender Tenders can be stacked and constrain different activities in their context ### Get tenders - [GET /tenders/{offset}/{amount}](https://docs.transportial.com/apis/tender/get:tenders.md): Get list of tenders ### Get tenders - [POST /tenders/{offset}/{amount}](https://docs.transportial.com/apis/tender/search:tenders_1.md): Search list of tenders based on query and params ### Accept tenderBid - [GET /tender/bid/{id}/accept](https://docs.transportial.com/apis/tender/accept:tenderbid.md): Accept a tender bid that has been made ### Create tender - [POST /tender/bid/{id}/decline](https://docs.transportial.com/apis/tender/create:tender.md): Create a new tender ### Counter offer - [POST /tender/bid/{id}/counter](https://docs.transportial.com/apis/tender/counter:tender.md): decline and counter offer ### Update tender - [PUT /tender](https://docs.transportial.com/apis/tender/update:tender.md): Update a tender ### Create tender - [POST /tender](https://docs.transportial.com/apis/tender/create:tender_1.md): Create a new tender ### Get tender - [GET /tender/{id}](https://docs.transportial.com/apis/tender/get:tender.md): Get a tender on id ### Accept tender bid and create trip - [POST /tender/{id}/accept-and-plan](https://docs.transportial.com/apis/tender/accept:tenderandplan.md): Accepts a tender bid, closes the tender, and creates a trip from the consignment in a single transaction ### Create tender bid - [POST /tender/{id}/bid](https://docs.transportial.com/apis/tender/create:tenderbid.md): Create a bid on a tender ### Delete tender - [DELETE /tender/bid/{id}](https://docs.transportial.com/apis/tender/delete:tender.md): Delete a tender ### Get tenders - [GET /tender/{id}/bids/{offset}/{amount}](https://docs.transportial.com/apis/tender/get:tenders_1.md): Get list of tenders ### Search tender bids - [POST /tender/{id}/bids/{offset}/{amount}](https://docs.transportial.com/apis/tender/search:tenders.md): Search list of tenders based on query and params ### Create inbound tender from external source - [POST /api/v1/tender/inbound](https://docs.transportial.com/apis/tender/create:tender:inbound.md): Receives an external order and creates a tender with source=API_INBOUND. Authenticated via x-api-key/x-api-secret headers. ## Widget Widgets can be stacked and constrain different activities in their context ### Get public widget - [GET /widget/public/{id}/{publicKey}](https://docs.transportial.com/apis/widget/get:widget:public.md): Get a widget on id and ### Get widgets - [GET /widgets/{offset}/{amount}](https://docs.transportial.com/apis/widget/get:widgets.md): Get list of widgets ### Get widgets - [POST /widgets/{offset}/{amount}](https://docs.transportial.com/apis/widget/search:widgets.md): Search list of widgets based on query and params ### Update widget - [PUT /widget](https://docs.transportial.com/apis/widget/update:widget.md): UPdate widget ### Create widget - [POST /widget](https://docs.transportial.com/apis/widget/create:widget.md): Create a new widget ### Get widget - [GET /widget/{id}](https://docs.transportial.com/apis/widget/get:widget.md): Get a widget on id ### Delete widget - [DELETE /widget/{id}](https://docs.transportial.com/apis/widget/delete:widget.md): Delete a widget ### Submit widget payload - [POST /widget/{id}/{publicKey}/submission](https://docs.transportial.com/apis/widget/submit:widget:public.md): Public endpoint to submit a payload to a widget (e.g. transport order request, quote request) ## Vehicle A `Vehicle` is a means to transport consignments from one location to potentially multiple other locations. There are various types of vehicles, each with their own unique properties like size, dimensions, fuel type and means of tranport (by air, on land, over sea). ### Get the location of all vehicles - [GET /vehicles/{uuid}/{lifeCycle}/events/{offset}/{amount}](https://docs.transportial.com/apis/vehicle/get:vehicles:events.md): Get the location of all vehicles within a platform ### Create vehicle event - [POST /vehicle/{uuid}/{lifeCycle}/event](https://docs.transportial.com/apis/vehicle/create:vehicle:event.md): Create a new vehicle event ### Get the events of a vehicle - [GET /vehicle/{id}/events/{offset}/{amount}](https://docs.transportial.com/apis/vehicle/get:vehicle:events.md): Get the events of a vehicle within a platform ### Create vehicle event - [POST /vehicle/{uuid}/{lifeCycle}/stopMoving](https://docs.transportial.com/apis/vehicle/create:vehicle:event_1.md): Create a new vehicle event ### Get ExtendedVehicles - [GET /vehicles/extended/{offset}/{amount}](https://docs.transportial.com/apis/vehicle/get:vehicles:extended.md): Get list of ExtendedVehicles ### Search ExtendedVehicles - [POST /vehicles/extended/{offset}/{amount}](https://docs.transportial.com/apis/vehicle/search:vehicles:extended.md): Search list of ExtendedVehicles ### Get vehicle trips - [GET /vehicle/{id}/trips/{offset}/{amount}](https://docs.transportial.com/apis/vehicle/get:vehicle:trips.md): Get the trips of a vehicle ### Update vehicle - [PUT /vehicle](https://docs.transportial.com/apis/vehicle/update:vehicle.md): Update a vehicle ### Create vehicle - [POST /vehicle](https://docs.transportial.com/apis/vehicle/create:vehicle.md): Create a new vehicle ### Get vehicle - [GET /vehicle/extended/{id}](https://docs.transportial.com/apis/vehicle/get:vehicle.md): Get a vehicle on id ### Get vehicle - [GET /vehicle/{id}](https://docs.transportial.com/apis/vehicle/get:vehicle_1.md): Get a vehicle on id ### Delete vehicle - [DELETE /vehicle/{id}](https://docs.transportial.com/apis/vehicle/delete:vehicle.md): Delete a vehicle ### Get the location of all vehicles - [GET /vehicle/{id}/chauffeurs](https://docs.transportial.com/apis/vehicle/get:vehicle:chauffeurs.md): Get the location of all vehicles within a platform ### Decouple chauffeur - [POST /vehicle/{id}/detach/chauffeur](https://docs.transportial.com/apis/vehicle/decouple:chauffeur.md): Decouple chauffeur to Vehicle ### Get vehicle trips, todos and calendar event occurrences by datetime range - [GET /vehicle/{id}/trips-todos-and-events:byDateTime/{startDateTime}/{endDateTime}](https://docs.transportial.com/apis/vehicle/get:vehicle:trips-todos-and-events:bydatetime.md): Get the trips, todos and calendar event occurrences of a vehicle within a specific datetime range ### Get vehicle trips - [POST /vehicles/trips:byDate/{fromDate}/{toDate}](https://docs.transportial.com/apis/vehicle/get:vehicle:trips_1.md): Get the trips of a vehicle ### Create vehicle event - [POST /vehicle/{uuid}/{lifeCycle}/locationUpdate](https://docs.transportial.com/apis/vehicle/create:vehicle:event_2.md): Create a new vehicle event ### Get vehicle trips - [GET /vehicle/{id}/trips:byDate/{fromDate}/{toDate}](https://docs.transportial.com/apis/vehicle/get:vehicle:trips_2.md): Get the trips of a vehicle ### Get vehicle trips - [GET /vehicle/{id}/trips:active/{offset}/{amount}](https://docs.transportial.com/apis/vehicle/get:vehicle:trips_3.md): Get the trips of a vehicle ### Get the location of all vehicles - [GET /vehicle/{id}/transportEquipments](https://docs.transportial.com/apis/vehicle/get:vehicle:transportequipments.md): Get the location of all vehicles within a platform ### Get vehicles - [GET /vehicles/{offset}/{amount}](https://docs.transportial.com/apis/vehicle/get:vehicles.md): Get list of vehicles ### Get vehicles - [POST /vehicles/{offset}/{amount}](https://docs.transportial.com/apis/vehicle/search:vehicles.md): Get list of vehicles ### Get vehicle trips - [POST /vehicles/trips:nextActive/{offset}/{amount}](https://docs.transportial.com/apis/vehicle/get:vehicle:trips_4.md): Get the trips of a vehicle ### Get vehicle trips and calendar events by datetime range - [GET /vehicle/{id}/trips-and-events:byDateTime/{startDateTime}/{endDateTime}](https://docs.transportial.com/apis/vehicle/get:vehicle:trips-and-events:bydatetime.md): Get the trips and calendar events of a vehicle within a specific datetime range ### Create vehicle event - [POST /vehicle/{uuid}/{lifeCycle}/startEngine](https://docs.transportial.com/apis/vehicle/create:vehicle:event_3.md): Create a new vehicle event ### Attach chauffeur - [POST /vehicle/{id}/attach/chauffeur](https://docs.transportial.com/apis/vehicle/attach:chauffeur.md): Attach chauffeur to Vehicle ### Get vehicle history of trips - [GET /vehicle/{id}/trips:history/{offset}/{amount}](https://docs.transportial.com/apis/vehicle/get:vehicle:trips_5.md): Get the trips of a vehicle that have either been completed or cancelled ### Attach chauffeur - [POST /vehicle/{id}/attach/transportEquipment](https://docs.transportial.com/apis/vehicle/attach:transportequipment.md): Attach chauffeur from Vehicle ### Get vehicle location update events - [GET /vehicle/{id}/locationUpdateEvents/{fromDate}/{toDate}](https://docs.transportial.com/apis/vehicle/get:vehicle:locationupdateevents.md): Get the location update events of a vehicle ### Get the location of all vehicles - [GET /vehicles/location](https://docs.transportial.com/apis/vehicle/get:vehicles:location_1.md): Get the location of all vehicles within a platform ### Get the location of all vehicles - [POST /vehicles/location](https://docs.transportial.com/apis/vehicle/get:vehicles:location.md): Get the location of all vehicles within a platform ### Detach chauffeur - [POST /vehicle/{id}/detach/transportEquipment](https://docs.transportial.com/apis/vehicle/detach:transportequipment.md): Detach chauffeur from Vehicle ### Create vehicle event - [POST /vehicle/{uuid}/{lifeCycle}/stopEngine](https://docs.transportial.com/apis/vehicle/create:vehicle:event_4.md): Create a new vehicle event ### Create vehicle event - [POST /vehicle/{uuid}/{lifeCycle}/startWaiting](https://docs.transportial.com/apis/vehicle/create:vehicle:event_5.md): Create a new vehicle event ### Create vehicle event - [POST /vehicle/{uuid}/{lifeCycle}/startMoving](https://docs.transportial.com/apis/vehicle/create:vehicle:event_6.md): Create a new vehicle event ## Trip A Trip is an aggregate entity that combines various entities to model visiting various locations, potentially doing one or multiple actions on each location, such as loading or unloading consignments. It is optionally coupled to a Vehicle that is/was driving this trip. ### Start a trip - [GET /trip/{id}/start](https://docs.transportial.com/apis/trip/handle.md): Starting a trip and attaching it to the vehicle ### Finish a trip and start a new trip - [GET /trip/{id}/finish/{nextId}/start](https://docs.transportial.com/apis/trip/handle_39.md): Finish a trip and start a new one ### Get combined financials - [GET /trip/{id}/financials/combined](https://docs.transportial.com/apis/trip/handle_47.md): Get simple and combined combined financials for a trip (linked chain). ### Update trips - [PUT /trips](https://docs.transportial.com/apis/trip/handle_477.md): Update a list of trips ### Create trip - [POST /trips](https://docs.transportial.com/apis/trip/handle_149.md): Create a new trip ### Finish a trip - [GET /trip/{id}/finish](https://docs.transportial.com/apis/trip/handle_153.md): Finishing a trip and detaching it to the vehicle ### Create trip and generate route - [POST /trip:route](https://docs.transportial.com/apis/trip/handle_181.md): Create a new trip and calculate a route ### Confirm a trip - [GET /trip/{id}/confirm](https://docs.transportial.com/apis/trip/handle_194.md): Confirming a trip and detaching it to the vehicle ### Get trip - [GET /trip/{id}](https://docs.transportial.com/apis/trip/handle_214.md): Get a trip on id ### Delete trip - [DELETE /trip/{id}](https://docs.transportial.com/apis/trip/handle_426.md): Delete a trip ### Update action lifeCycle - [PUT /trip/{id}/action/{actionId}](https://docs.transportial.com/apis/trip/update:trip:action.md): Update an actions lifeCycle, this includes all child actions ### Update vehicle trips order - [PUT /vehicle/{id}/trips:swap](https://docs.transportial.com/apis/trip/update:vehicle:trips.md): Update an actions lifeCycle, this includes all child actions ### Update action times - [PUT /trip/{id}/action](https://docs.transportial.com/apis/trip/update:trip:action_1.md): Update an actions lifeCycle, this includes all child actions ### Cancel trips - [POST /trips/cancel](https://docs.transportial.com/apis/trip/handle_292.md): Cancel a list of trips ### Update trip - [PUT /trip](https://docs.transportial.com/apis/trip/handle_304.md): Update a trip ### Create trip - [POST /trip](https://docs.transportial.com/apis/trip/handle_310.md): Create a new trip ### Update action times - [PUT /trip/{id}/action/{actionId}/times](https://docs.transportial.com/apis/trip/update:trip:action_2.md): Update an actions lifeCycle, this includes all child actions ### Complete all actions on a trip - [PUT /trip/{id}/complete-actions](https://docs.transportial.com/apis/trip/complete:trip:actions.md): 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. ### Complete a trip - [GET /trip/{id}/complete](https://docs.transportial.com/apis/trip/handle_338.md): Complete a trip that is in PENDING_COMPLETION state, triggering invoices and integration events ### Get trips - [GET /trips/{offset}/{amount}](https://docs.transportial.com/apis/trip/handle_355.md): Get list of trips ### Search trips - [POST /trips/{offset}/{amount}](https://docs.transportial.com/apis/trip/handle_440.md): Get list of trips through a search ### Cancel a trip - [GET /trip/{id}/cancel](https://docs.transportial.com/apis/trip/handle_394.md): Cancel a trip, realize all actions below, remove from Vehicle and change Consignment status ### Create trips - [POST /trip/optimizer](https://docs.transportial.com/apis/trip/handle_395.md): Create a new trip ### Get trip - [GET /trip/{id}/{shareCode}](https://docs.transportial.com/apis/trip/handle_409.md): Get a trip on id ### Get trip activity - [GET /trip/{id}/activity](https://docs.transportial.com/apis/trip/handle_451.md): Get the activity timeline for a trip ### Confirm trips - [POST /trips/confirm](https://docs.transportial.com/apis/trip/handle_463.md): Confirm a list of trips ### Add documents - [PUT /trip/{id}/documents](https://docs.transportial.com/apis/trip/handle_502.md): Add documents to tripp ## File File management. Upload, retrieve and download files. Categorized by it's purpose. ### Download file - [GET /file/{id}/download](https://docs.transportial.com/apis/file/download:file.md): Download file from ID ### Convert file to HTML - [POST /file/toMatrix](https://docs.transportial.com/apis/file/tomatrix:file.md): Convert file to HTML. Supported types are .pdf right now ### Download file via proxy - [GET /file/{id}/download:proxy](https://docs.transportial.com/apis/file/download:proxy:file.md): Download file from ID via API proxy. The API downloads the file from S3 and streams it to the client. ### Convert file to HTML - [POST /file/toHtml](https://docs.transportial.com/apis/file/tomatrix:file_1.md): Convert file to HTML. Supported types are .pdf right now ### Upload file - [POST /file/upload](https://docs.transportial.com/apis/file/upload:file.md): Upload a new file ### Get file - [GET /file/{id}](https://docs.transportial.com/apis/file/get:file.md): Get a file on id ## CapacityContract The CapacityContract is the entity to model a contract of a purchase of certain amount of scheduled capacity. ### Get a capacityContract - [GET /capacityContract/{id}](https://docs.transportial.com/apis/capacitycontract/get:capacitycontract.md): Get a capacityContract by id ### Delete capacityContract - [DELETE /capacityContract/{id}](https://docs.transportial.com/apis/capacitycontract/delete:capacitycontract.md): Delete a new capacityContract ### Update a capacityContract - [PUT /capacityContract](https://docs.transportial.com/apis/capacitycontract/update:capacitycontract.md): Update a capacityContract specified by id ### Create capacityContract - [POST /capacityContract](https://docs.transportial.com/apis/capacitycontract/create:capacitycontract.md): Create a new capacityContract for a specified scheduledCapacity by id. ### Get a capacityContracts - [GET /capacity/contracts/{offset}/{amount}](https://docs.transportial.com/apis/capacitycontract/get:capacitycontracts.md): Get a list capacityContracts from offset, and of given amount ### Search capacity contracts - [POST /capacity/contracts/{offset}/{amount}](https://docs.transportial.com/apis/capacitycontract/search:capacitycontracts.md): Get a list capacityContracts from offset, and of given amount ### Create capacityContract - [POST /transportOrder/{id}/capacityContract](https://docs.transportial.com/apis/capacitycontract/create:capacitycontract_1.md): Create a new capacityContract for a specified scheduledCapacity by id. ## MessageTemplate MessageTemplates can be stacked and constrain different activities in their context ### Update messageTemplate - [PUT /messageTemplate](https://docs.transportial.com/apis/messagetemplate/update:messagetemplate.md): Update a messageTemplate ### Create messageTemplate - [POST /messageTemplate](https://docs.transportial.com/apis/messagetemplate/create:messagetemplate.md): Create a new messageTemplate ### Get messageTemplates - [GET /messageTemplates/{offset}/{amount}](https://docs.transportial.com/apis/messagetemplate/get:messagetemplates.md): Get list of messageTemplates ### Search messageTemplates - [POST /messageTemplates/{offset}/{amount}](https://docs.transportial.com/apis/messagetemplate/search:messagetemplates.md): Search list of messageTemplates by query and multiple parameters ### Get messageTemplate - [GET /messageTemplate/{id}](https://docs.transportial.com/apis/messagetemplate/get:messagetemplate.md): Get a messageTemplate on id ### Delete messageTemplate - [DELETE /messageTemplate/{id}](https://docs.transportial.com/apis/messagetemplate/delete:messagetemplate.md): Delete a messageTemplate ### Get message from MessageTemplate - [GET /messageTemplate/{id}/message/{chat}](https://docs.transportial.com/apis/messagetemplate/get:messagefrommessagetemplate.md): Get the generated message from the MessageTemplate and teh context ## Business Business is a base entity that describes a companies information. Thiis entity is used for contracts, clients, invoices, quotes, etc. It can be any type of relation you do business with. ### Verify business - [GET /business/{id}/unverify](https://docs.transportial.com/apis/business/verify:business.md): Verify a business on id ### Get businesses - [GET /businesses/{offset}/{amount}](https://docs.transportial.com/apis/business/create:businesses.md): Get list of businesses ### Get businesss - [POST /businesses/{offset}/{amount}](https://docs.transportial.com/apis/business/create:businesss.md): Get list of businesss ### Get business - [GET /business/{id}](https://docs.transportial.com/apis/business/get:business.md): Get a business on id ### Delete business - [DELETE /business/{id}](https://docs.transportial.com/apis/business/delete:business.md): Delete a business ### Verify business - [GET /business/{id}/verify](https://docs.transportial.com/apis/business/verify:business_1.md): Verify a business on id ### Update business - [PUT /business](https://docs.transportial.com/apis/business/update:business.md): Update a business ### Create business - [POST /business](https://docs.transportial.com/apis/business/create:business.md): Create a new business ## SAML SAML Configuration for Single-SignOn(SSO) establishment between Service-Provider(SP) and Identity-Provider(IDP) ### Get SAMLs - [GET /samls/{offset}/{amount}](https://docs.transportial.com/apis/saml/handle_2.md): Get SAML Configurations ### Get SAMLs - [POST /samls/{offset}/{amount}](https://docs.transportial.com/apis/saml/handle_135.md): Get SAML Configurations ### Update SAML - [PUT /saml](https://docs.transportial.com/apis/saml/handle_225.md): Update SAML Configuration ### Add new SAML - [POST /saml](https://docs.transportial.com/apis/saml/handle_89.md): Add new SAML Configuration ### Get Platform SAML Metadata - [GET /saml/platformSamlMetadata](https://docs.transportial.com/apis/saml/handle_167.md): Get current platform's SAML Metadata (Issuer, Assertion Consumer Service URL, etc.) required for a SAML Configuration. ### Get SAML - [GET /saml/{id}](https://docs.transportial.com/apis/saml/handle_306.md): Get a SAML Configuration by id ### Delete SAML - [DELETE /saml/{id}](https://docs.transportial.com/apis/saml/handle_208.md): Delete a SAML Configuration ### Assertion Consumer Service for SAMLResponse from IDP - [POST /saml/assertion](https://docs.transportial.com/apis/saml/handle_316.md): ACS handles authenticates SAMLResponse (validates authentication & assertions) and redirects in response. ### Generate Service-Provider's SAML Metadata XML File - [POST /saml/spSamlMetadata/xml](https://docs.transportial.com/apis/saml/handle_348.md): Generate XML File based on provided Service-Provider's SAML Metadata. ## Route A route models the path going from one location to at least one other location. ### Calculate and create a new route - [POST /route/calculate:georeferences](https://docs.transportial.com/apis/route/handle_3.md): Calculate and create a new route based on Vehicle and the Georeferences ### Get route - [GET /route/{id}](https://docs.transportial.com/apis/route/handle_10.md): Get a route on id ### Delete route - [DELETE /route/{id}](https://docs.transportial.com/apis/route/handle_277.md): Delete a route ### Get routes - [GET /routes/{offset}/{amount}](https://docs.transportial.com/apis/route/handle_243.md): Get list of routes ### Search routes - [POST /routes/{offset}/{amount}](https://docs.transportial.com/apis/route/handle_131.md): Search list of routes based on query ### Update route - [PUT /route](https://docs.transportial.com/apis/route/handle_276.md): Update a route ### Create route - [POST /route](https://docs.transportial.com/apis/route/handle_432.md): Create a new route ### Calculate and create a new route - [POST /route/calculate](https://docs.transportial.com/apis/route/handle_492.md): Calculate and create a new route based on Vehicle and the Georeferences ## Chat Sending messages to users grouped by rooms ### Get message - [GET /chat/message/{id}](https://docs.transportial.com/apis/chat/handle_5.md): Get message by ID ### Delete message - [DELETE /chat/message/{id}](https://docs.transportial.com/apis/chat/handle_282.md): Delete message by ID ### Read message - [GET /chat/message/{id}/read](https://docs.transportial.com/apis/chat/handle_26.md): read message by ID ### Update chat external integration - [PUT /chat/{chatId}/integrations/{bindingId}](https://docs.transportial.com/apis/chat/handle_287.md): Update an existing external channel integration for a specific chat ### Delete chat external integration - [DELETE /chat/{chatId}/integrations/{bindingId}](https://docs.transportial.com/apis/chat/handle_71.md): Delete an external channel integration for a specific chat ### Get chat - [GET /chat/{id}](https://docs.transportial.com/apis/chat/handle_452.md): Get chat by ID ### Delete chat - [DELETE /chat/{id}](https://docs.transportial.com/apis/chat/handle_77.md): Delete chat by ID ### Unread chat - [GET /chat/{id}/unread](https://docs.transportial.com/apis/chat/handle_97.md): Unread chat by ID ### Get all chats - [GET /chats/{offset}/{amount}](https://docs.transportial.com/apis/chat/handle_496.md): Get all the chats by offset and amount ### Get all chats - [POST /chats/{offset}/{amount}](https://docs.transportial.com/apis/chat/handle_106.md): Get all the chats by offset and amount ### Send message to external channel - [POST /chat/{chatId}/send-external](https://docs.transportial.com/apis/chat/handle_113.md): Send a message to a specific external channel (email, WhatsApp, etc.) ### Get chat external integrations - [GET /chat/{chatId}/integrations](https://docs.transportial.com/apis/chat/handle_488.md): Get all external channel integrations for a specific chat ### Create chat external integration - [POST /chat/{chatId}/integrations](https://docs.transportial.com/apis/chat/handle_140.md): Create or update an external channel integration for a specific chat ### Update chat - [PUT /chat](https://docs.transportial.com/apis/chat/handle_158.md): Create a new Chat ### Create chat - [POST /chat](https://docs.transportial.com/apis/chat/handle_434.md): Create a new Chat ### Update message - [PUT /chat/message](https://docs.transportial.com/apis/chat/handle_345.md): Create a new message ### Create chat message - [POST /chat/message](https://docs.transportial.com/apis/chat/handle_265.md): Create a new chat message ### Received message - [POST /chat/messages/received](https://docs.transportial.com/apis/chat/handle_302.md): Received message by ID ### Read message - [POST /chat/messages/read](https://docs.transportial.com/apis/chat/handle_398.md): read message by ID ### Get all chats - [GET /chat/messages/{id}/{offset}/{amount}](https://docs.transportial.com/apis/chat/handle_485.md): Get all the chats by offset and amount ### Search all chats - [POST /chat/messages/{id}/{offset}/{amount}](https://docs.transportial.com/apis/chat/handle_427.md): Search all the chats by offset and amount ### Received message - [GET /chat/message/{id}/received](https://docs.transportial.com/apis/chat/handle_445.md): Received message by ID ### Get translated message - [GET /chat/message:translate/{id}](https://docs.transportial.com/apis/chat/handle_490.md): Get a translated version of the message by ID ## TransportEquipment 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. ### Get transportEquipment - [GET /transportEquipment/{id}](https://docs.transportial.com/apis/transportequipment/handle_120.md): Get a transportEquipment on id ### Delete transportEquipment - [DELETE /transportEquipment/{id}](https://docs.transportial.com/apis/transportequipment/handle_6.md): Delete a transportEquipment ### Get extended transportEquipments - [GET /transportEquipments:extended/{offset}/{amount}](https://docs.transportial.com/apis/transportequipment/handle_67.md): Get list of extended transportEquipments ### Search transportEquipment - [POST /transportEquipments:extended/{offset}/{amount}](https://docs.transportial.com/apis/transportequipment/handle_247.md): Search transportEquipment ### Update transportEquipment - [PUT /transportEquipment](https://docs.transportial.com/apis/transportequipment/handle_157.md): Update a transportEquipment ### Create transportEquipment - [POST /transportEquipment](https://docs.transportial.com/apis/transportequipment/handle_73.md): Create a new transportEquipment ### Get transportEquipment trips - [GET /transportEquipment/{id}/trips/{offset}/{amount}](https://docs.transportial.com/apis/transportequipment/get:transportequipment:trips.md): Get the trips of a transportEquipment ### Get transportEquipments - [GET /transportEquipments/{offset}/{amount}](https://docs.transportial.com/apis/transportequipment/handle_377.md): Get list of transportEquipments ### Search transportEquipment - [POST /transportEquipments/{offset}/{amount}](https://docs.transportial.com/apis/transportequipment/handle_251.md): Search transportEquipment ### Get transportEquipments trips - [POST /transportEquipments/trips:byDate/{fromDate}/{toDate}](https://docs.transportial.com/apis/transportequipment/get:transportequipments:trips.md): Get the trips of transportEquipments ### Get transport equipment trips and calendar events by datetime range - [GET /transportEquipment/{id}/trips-and-events:byDateTime/{startDateTime}/{endDateTime}](https://docs.transportial.com/apis/transportequipment/get:transportequipment:trips-and-events:bydatetime.md): Get the trips and calendar events of a transport equipment within a specific datetime range ### Get transportEquipment transportEquipment - [GET /transportEquipment/{id}/trips:byDate/{fromDate}/{toDate}](https://docs.transportial.com/apis/transportequipment/get:transportequipment:trips_1.md): Get the trips of a chauffeur ## Insights All the insights you need can be gathered from these endpoints ### Get trips loading sheet per location - [POST /insights/trips:loading/location/{id}](https://docs.transportial.com/apis/insights/get:tripsloadingsheet.md): Get trips loading sheet per location by a date range ### Get vehicle trips insight - [POST /insights/chauffeurs/borderCrossings:byDateRange](https://docs.transportial.com/apis/insights/get:insight.md): Get the trips a vehicle has done by a date range ### Get consignment results by date range - [POST /insights/consignments:results](https://docs.transportial.com/apis/insights/get:consignmentresultsbydate.md): Get consignment results by date range ### Get vehicles trips insight - [POST /insights/vehicles/trips](https://docs.transportial.com/apis/insights/get:insight_1.md): Get the trips a list of vehicles have done by a date range ### Get vehicles CO2 insight - [POST /insights/vehicles/CO2:byDateRange](https://docs.transportial.com/apis/insights/get:insight_2.md): Get the trips a vehicle has done by a date range ### Get vehicles trips insight - [GET /insights/fleet/{id}/trips/{startDate}/{endDate}](https://docs.transportial.com/apis/insights/get:insight_3.md): Get the trips a list of vehicles have done by a date range ### Get user's welcome insights for current day - [GET /insights/user/welcome-stats](https://docs.transportial.com/apis/insights/get:insight_4.md): Get user's welcome insights for current day ### Get customer transport order report - [POST /insights/customer/transportOrders:byDateRange](https://docs.transportial.com/apis/insights/get:insight_5.md): Get the information about things done by a user within a date range ### Get vehicle trips insight - [GET /insights/vehicle/{id}/trips/{startDate}/{endDate}](https://docs.transportial.com/apis/insights/get:insight_6.md): Get the trips a vehicle has done by a date range ### Get vehicles trips insight - [GET /insights/fleet/{id}/moveActions/{startDate}/{endDate}](https://docs.transportial.com/apis/insights/get:insight_7.md): Get the trips a list of vehicles have done by a date range ### Get vehicle trips insight - [POST /insights/chauffeurs/actions:byDateRange](https://docs.transportial.com/apis/insights/get:insight_8.md): Get the trips a vehicle has done by a date range ### Get vehicle trips insight - [POST /insights/vehicles/sensorValueAtDate](https://docs.transportial.com/apis/insights/get:insight_9.md): Get the trips a vehicle has done by a date range ### Get vehicle trips insight - [POST /insights/chauffeurs/onTruck:byDateRange](https://docs.transportial.com/apis/insights/get:insight_10.md): Get the trips a vehicle has done by a date range ### Get users' insight - [POST /insights/users/report](https://docs.transportial.com/apis/insights/get:insight_11.md): Get the information about things done by a user within a date range ### Get trips daily report - [POST /insights/trips:dailyReport](https://docs.transportial.com/apis/insights/post:insight.md): Get trips per day per vehicle in a date range, showing trip number, drivers, vehicle info, stop counts, load/unload stops, total LDM and total weight ### Get vehicles actions insight - [POST /insights/vehicles/actions](https://docs.transportial.com/apis/insights/get:insight_12.md): Get the actions a list of vehicles have done by a date range ## User Users related to the platform and all actions required ### Get the logged in user - [GET /user](https://docs.transportial.com/apis/user/handle_8.md): Get the currently logged in user ### Update the user - [PUT /user](https://docs.transportial.com/apis/user/handle_280.md): Update the password of the currently logged in user. The current password has to be known for this change ### Create a new user - [POST /user](https://docs.transportial.com/apis/user/handle_270.md): Invite a new user to the platform through an invitation e-mail, the user has to reset his password. ### Creates new access_token - [POST /user/session/refresh](https://docs.transportial.com/apis/user/handle_22.md): Creates new access_token if refresh_token isn't expired and extends refresh_token with one day time also. ### Setup a users 2FA - [POST /user/2fa/disable](https://docs.transportial.com/apis/user/handle_33.md): Get the 2FA QR image and the recovery codes ### Decline an access request - [POST /user/access-request/{id}/decline](https://docs.transportial.com/apis/user/handle_40.md): Decline a pending access request and soft-delete the user record ### User login - [POST /user/login](https://docs.transportial.com/apis/user/handle_46.md): Authenticate a user by logging in ### Create and assign chauffeur to user - [POST /user/{id}/create-chauffeur](https://docs.transportial.com/apis/user/create:chauffeur:user.md): Creates a new Chauffeur from payload and links it to the specified User; User must not already have a chauffeur. ### Get if the e-mail exists yes or no - [POST /user/email/exists/{email}](https://docs.transportial.com/apis/user/handle_83.md): Check if an e-mail is already in use for another user ### Get the user by id - [GET /user/{id}](https://docs.transportial.com/apis/user/handle_94.md): Get a user by the given ID ### Unblock a user - [DELETE /user/{id}](https://docs.transportial.com/apis/user/handle_405.md): Unblock a user from the platform ### Get all the users - [GET /users/{offset}/{amount}](https://docs.transportial.com/apis/user/handle_344.md): Get all users ### Search users by search parameters - [POST /users/{offset}/{amount}](https://docs.transportial.com/apis/user/handle_117.md): Search users by search parameters and ### Get a user's session - [GET /user/{id}/sessions/{offset}/{amount}](https://docs.transportial.com/apis/user/handle_133.md): Get user's sessions ### Request register user - [POST /user/register/request](https://docs.transportial.com/apis/user/handle_138.md): Register a new user ### Recover user login details - [POST /user/recover](https://docs.transportial.com/apis/user/handle_168.md): Authenticate a user by logging in ### Add FCM device - [POST /user/fcm](https://docs.transportial.com/apis/user/handle_170.md): Add a device FCM token for a user. This enables notification sending ### Unblock a user - [POST /user/unblock/{id}](https://docs.transportial.com/apis/user/handle_190.md): Unblock a user from the platform ### Recover 2FA - [POST /user/2fa/recover](https://docs.transportial.com/apis/user/handle_207.md): Recover your account with a recovery code ### Get the login method - [POST /user/login-method](https://docs.transportial.com/apis/user/handle_209.md): Get the login method to be used for this users authentication ### Get if the username exists yes or no - [POST /user/username/exists/{username}](https://docs.transportial.com/apis/user/handle_237.md): Check if the given username is already in use for another user ### Log all user session out - [GET /user/logout/all](https://docs.transportial.com/apis/user/handle_254.md): End the all the sessions of the logged in user. Meaning over all devices the sessions are invalidated ### Approve an access request - [POST /user/access-request/{id}/approve](https://docs.transportial.com/apis/user/handle_284.md): Approve a pending access request, confirming the user and adding them to the platform ### Verify 2FA code - [POST /user/2fa/verify](https://docs.transportial.com/apis/user/handle_308.md): Verify an incoming 2FA code. In case of a first save this endpoint will also enable the 2FA ### Start of recovering password - [POST /user/forgot](https://docs.transportial.com/apis/user/handle_312.md): The start of recovering ### Invite a new user to the platform - [POST /user/invite](https://docs.transportial.com/apis/user/handle_314.md): Invite a new user to the platform through an invitation e-mail, the user has to reset his password. ### Verify e-mail address - [GET /user/{id}/verify/{token}](https://docs.transportial.com/apis/user/handle_323.md): End the current session of the logged in user ### Get pending access requests - [GET /user/access-requests/{offset}/{amount}](https://docs.transportial.com/apis/user/handle_354.md): Returns users who have submitted an access request and are awaiting approval ### User login otp - [POST /user/login:otp](https://docs.transportial.com/apis/user/handle_365.md): Authenticate a user with the OTP ### Log user out - [GET /user/logout](https://docs.transportial.com/apis/user/handle_414.md): End the current session of the logged in user ### Assign chauffeur to user - [POST /user/{id}/assign-chauffeur](https://docs.transportial.com/apis/user/assign:chauffeur:user.md): Links an existing Chauffeur to an existing User; both must not already be linked. ### Get a user active session - [GET /user/sessions](https://docs.transportial.com/apis/user/handle_442.md): Get the currently active sessions for a user ### Setup a users 2FA - [POST /user/2fa/setup](https://docs.transportial.com/apis/user/handle_443.md): Get the 2FA QR image and the recovery codes ### Get a user active session by login token - [GET /user/session](https://docs.transportial.com/apis/user/handle_454.md): Get a user active session by active 'login attempt session''s token. Note: 'login attempt session' is a session for any specific login attemptSuch sessions would usually have short time window, hence endpoint usable only in that short duration. ### Register user - [POST /user/register](https://docs.transportial.com/apis/user/handle_455.md): Register a new user ### Block user - [POST /user/block/{id}](https://docs.transportial.com/apis/user/handle_487.md): Block a user from the platform ### Update logged in user password - [PUT /user/password](https://docs.transportial.com/apis/user/handle_491.md): Update the password of the currently logged in user. The current password has to be known for this change ## DocumentTemplate Visual document template designer for creating CMR, invoices, quotes and custom documents ### Duplicate document template - [POST /documentTemplate/{id}/duplicate](https://docs.transportial.com/apis/documenttemplate/handle_9.md): Create a copy of an existing document template ### Get document templates - [GET /documentTemplates/{offset}/{amount}](https://docs.transportial.com/apis/documenttemplate/handle_36.md): Get a paginated list of document templates ### Search document templates - [POST /documentTemplates/{offset}/{amount}](https://docs.transportial.com/apis/documenttemplate/handle_152.md): Search document templates with filters ### Update document template - [PUT /documentTemplate](https://docs.transportial.com/apis/documenttemplate/handle_260.md): Update an existing document template ### Create document template - [POST /documentTemplate](https://docs.transportial.com/apis/documenttemplate/handle_171.md): Create a new document template ### Get document template - [GET /documentTemplate/{id}](https://docs.transportial.com/apis/documenttemplate/handle_227.md): Get a document template by ID ### Delete document template - [DELETE /documentTemplate/{id}](https://docs.transportial.com/apis/documenttemplate/handle_403.md): Delete a document template (soft delete by default, use ?permanent=true for hard delete) ### Get bindable fields - [GET /documentTemplate/fields/{entityType}](https://docs.transportial.com/apis/documenttemplate/handle_245.md): Get the list of fields that can be bound to template elements for a specific entity type ## Message automation MessageAutomations are communication automation connectors that can use events ### Get MessageAutomations - [GET /messageAutomations/{offset}/{amount}](https://docs.transportial.com/apis/message-automation/handle_250.md): Get a MessageAutomations ### Get MessageAutomations - [POST /messageAutomations/{offset}/{amount}](https://docs.transportial.com/apis/message-automation/handle_12.md): Get a MessageAutomations ### Update MessageAutomation - [PUT /messageAutomation](https://docs.transportial.com/apis/message-automation/handle_112.md): Update MessageAutomation ### Add new MessageAutomation - [POST /messageAutomation](https://docs.transportial.com/apis/message-automation/handle_230.md): Add new MessageAutomation ### Get MessageAutomation tasks - [GET /messageAutomation/{id}/tasks/{offset}/{amount}](https://docs.transportial.com/apis/message-automation/handle_185.md): Get list of MessageAutomation tasks ### Get MessageAutomation - [GET /messageAutomation/{id}](https://docs.transportial.com/apis/message-automation/handle_195.md): Get a MessageAutomation by id ### Delete MessageAutomation - [DELETE /messageAutomation/{id}](https://docs.transportial.com/apis/message-automation/handle_294.md): Delete a MessageAutomation ### Duplicate MessageAutomation - [POST /messageAutomation/{id}/duplicate](https://docs.transportial.com/apis/message-automation/handle_205.md): Duplicate a MessageAutomation ### Get User Message Automation Preferences - [GET /messageAutomation/user-preferences](https://docs.transportial.com/apis/message-automation/handle_257.md): Get all user-enableable message automations with the current user's preference status ### Toggle User Message Automation Preference - [POST /messageAutomation/user-preference](https://docs.transportial.com/apis/message-automation/handle_283.md): Toggle a user's preference for a specific message automation ### Get MessageAutomations - [GET /messageAutomation-templates](https://docs.transportial.com/apis/message-automation/handle_350.md): Get a MessageAutomations ### Generate message automation with AI - [POST /messageAutomation/generate](https://docs.transportial.com/apis/message-automation/generate:messageautomation.md): Use AI to generate a message automation configuration from a text description or documents ### Duplicate message automation template - [POST /messageAutomation-template/{id}/duplicate](https://docs.transportial.com/apis/message-automation/handle_435.md): Duplicate a message automation template ## Chauffeur Chauffeurs are the people who are responsible for controlling a Vehicle. They have schedules, planning and legal responsibilities. ### Update chauffeur timeslot - [PUT /chauffeur/timeslot](https://docs.transportial.com/apis/chauffeur/update:chauffeur:timeslot.md): Update a chauffeur timeslot ### Create chauffeur timeslot allocation - [POST /chauffeur/timeslot](https://docs.transportial.com/apis/chauffeur/create:chauffeur:timeslot.md): Allocate a timeslot in the drivers schedule. ### Get chauffeur vehicles - [GET /chauffeur/{id}/vehicles](https://docs.transportial.com/apis/chauffeur/get:chauffeur:vehicles.md): Get list of vehicles that are related to the chauffeur ### Update chauffeur - [PUT /chauffeur](https://docs.transportial.com/apis/chauffeur/update:chauffeur.md): Update a chauffeur ### Create chauffeur - [POST /chauffeur](https://docs.transportial.com/apis/chauffeur/create:chauffeur.md): Create a new chauffeur ### Get chauffeurs trips - [POST /chauffeurs/trips:byDate/{fromDate}/{toDate}](https://docs.transportial.com/apis/chauffeur/get:chauffeurs:trips.md): Get the trips of chauffeurs ### Delete chauffeur timeslot - [DELETE /chauffeur/timeslot/{id}](https://docs.transportial.com/apis/chauffeur/delete:chauffeur:timeslot.md): Delete a chauffeur timeslot allocation ### Get chauffeur - [GET /chauffeur/{id}](https://docs.transportial.com/apis/chauffeur/get:chauffeur_1.md): Get a chauffeur on id ### Delete chauffeur - [DELETE /chauffeur/{id}](https://docs.transportial.com/apis/chauffeur/delete:chauffeur.md): Delete a chauffeur ### Get chauffeur trip stats - [GET /chauffeur/{id}/trip-stats](https://docs.transportial.com/apis/chauffeur/handle_142.md): Get chauffeur trip stats by id ### Get chauffeur activities and calendar events by datetime range - [GET /chauffeur/{id}/activities-and-events:byDateTime/{fromDate}/{toDate}](https://docs.transportial.com/apis/chauffeur/get:chauffeur:activities-and-events:bydatetime.md): Get the activities and calendar events of a chauffeur within a specific datetime range ### Get chauffeur transportEquipments - [GET /chauffeur/{id}/transportEquipments](https://docs.transportial.com/apis/chauffeur/get:chauffeur:transportequipments.md): Get list of transportEquipments that are related to the chauffeur ### Get chauffeur trips - [GET /chauffeur/{id}/trips/future/{offset}/{amount}](https://docs.transportial.com/apis/chauffeur/get:chauffeur:trips.md): Get the trips of a chauffeur ### Get chauffeurs - [GET /chauffeurs/{offset}/{amount}](https://docs.transportial.com/apis/chauffeur/get:chauffeurs.md): Get list of chauffeurs ### Get chauffeurs - [POST /chauffeurs/{offset}/{amount}](https://docs.transportial.com/apis/chauffeur/search:chauffeurs.md): Search list of chauffeurs based on query and params ### Get chauffeur trips - [GET /chauffeur/{id}/trips/{offset}/{amount}](https://docs.transportial.com/apis/chauffeur/get:chauffeur:trips_1.md): Get the trips of a chauffeur ### Get chauffeurs timeslots - [POST /chauffeurs/timeslots](https://docs.transportial.com/apis/chauffeur/get:chauffeurs:timeslots.md): Get list of chauffeurs timeslots, grouped by chauffeurs ### Get extended chauffeurs - [GET /chauffeurs:extended/{offset}/{amount}](https://docs.transportial.com/apis/chauffeur/get:chauffeurs:extended.md): Get list of extended chauffeurs ### Get extended chauffeurs - [POST /chauffeurs:extended/{offset}/{amount}](https://docs.transportial.com/apis/chauffeur/search:chauffeurs:extended.md): Search list of extended chauffeurs based on query and params ### Get chauffeur - [GET /chauffeur/user/{id}](https://docs.transportial.com/apis/chauffeur/get:chauffeur.md): Get a chauffeur by user id ### Logs the Chauffeur's Current Activity - [POST /chauffeurs/{id}/activity](https://docs.transportial.com/apis/chauffeur/handle_330.md): Ends the chauffeur's current activity and starts a new one, preserving history. This is the correct way to update a chauffeur's live status. ### Get chauffeur trips - [GET /chauffeur/{id}/trips/past/{offset}/{amount}](https://docs.transportial.com/apis/chauffeur/get:chauffeur:trips_2.md): Get the trips of a chauffeur ### Delete chauffeur activity - [DELETE /chauffeur/activity/{id}](https://docs.transportial.com/apis/chauffeur/delete:chauffeur:activity.md): Delete a chauffeur activity allocation ### Get chauffeur timeslots - [GET /chauffeur/{id}/timeslots/{fromDate}/{toDate}](https://docs.transportial.com/apis/chauffeur/get:chauffeur:timeslots.md): Get list of chauffeurs ### Assign a user to an existing chauffeur - [POST /chauffeur/{id}/assign-user](https://docs.transportial.com/apis/chauffeur/assign:user:chauffeur.md): Creates a new user account for an existing chauffeur and sends an invitation to log in. ### Get chauffeur activities - [GET /chauffeur/{id}/activities:byDate/{fromDate}/{toDate}](https://docs.transportial.com/apis/chauffeur/get:chauffeur:activities.md): Get the activities of chauffeur ### Get chauffeur trips - [GET /chauffeur/{id}/trips:byStatus/{status}/{offset}/{amount}](https://docs.transportial.com/apis/chauffeur/get:chauffeur:trips_3.md): Get the trips of a chauffeur ### Get chauffeur trips - [GET /chauffeur/{id}/trips:byDate/{fromDate}/{toDate}](https://docs.transportial.com/apis/chauffeur/get:chauffeur:trips_4.md): Get the trips of a chauffeur ### Create a chauffeur activity - [POST /chauffeur/activity](https://docs.transportial.com/apis/chauffeur/create:chauffeur:activity.md): Register a chauffeur activity that either will happen or has happened ### Get prioritized chauffeur trips - [GET /chauffeur/{id}/trips/prioritized/{offset}/{amount}](https://docs.transportial.com/apis/chauffeur/get:chauffeur:trips:prioritized.md): Get the trips of a chauffeur sorted by status priority ### Get extended chauffeur - [GET /chauffeur:extended/{id}](https://docs.transportial.com/apis/chauffeur/get:chauffeur:extended.md): Get a extended chauffeur on id ## User roles The permissions grouped by a \"Role\", that can be assigned to a user ### Get all the users - [GET /roles/{offset}/{amount}](https://docs.transportial.com/apis/user-roles/handle_362.md): Get all users ### Search all the roles - [POST /roles/{offset}/{amount}](https://docs.transportial.com/apis/user-roles/handle_14.md): Search all the roles based on search parameters ### Update role - [PUT /role](https://docs.transportial.com/apis/user-roles/handle_374.md): Update an existing role ### Create role - [POST /role](https://docs.transportial.com/apis/user-roles/handle_404.md): Create a new role ### Delete role - [DELETE /role](https://docs.transportial.com/apis/user-roles/handle_347.md): Delete an existing role ## StackMap A stackMap models the snapshots of planned stacking across locations. ### Get stackMap - [GET /stack-map/{id}](https://docs.transportial.com/apis/stackmap/handle_15.md): Get a stackMap on id ### Delete stackMap - [DELETE /stack-map/{id}](https://docs.transportial.com/apis/stackmap/handle_228.md): Delete a stackMap ### Calculate and create a new stackMap - [POST /stack-map/calculate](https://docs.transportial.com/apis/stackmap/handle_269.md): Calculate and create a new stackMap based on Vehicle and the Actions. ### Get stackMaps - [GET /stack-maps/{offset}/{amount}](https://docs.transportial.com/apis/stackmap/handle_495.md): Get list of stackMaps ### Search stackMaps - [POST /stack-maps/{offset}/{amount}](https://docs.transportial.com/apis/stackmap/handle_381.md): Search list of stackMaps based on query ### Update stackMap - [PUT /stack-map](https://docs.transportial.com/apis/stackmap/handle_484.md): Update a stackMap ### Create stackMap - [POST /stack-map](https://docs.transportial.com/apis/stackmap/handle_474.md): Create a new stackMap ## Quote Quotes ### Create transport order from quote - [POST /quote/{id}/create:transportOrder](https://docs.transportial.com/apis/quote/handle_16.md): Create transport order entity from an accepted quote ### Generate quote lines - [POST /quote/lines/pricing/{pricingId}](https://docs.transportial.com/apis/quote/handle_23.md): Generate quote lines ### Create quote from Email - [PUT /quote/mail/receiver](https://docs.transportial.com/apis/quote/create:quote:frommail.md): Create quote from Email ### Get all quotes - [GET /quotes/{administration}/{offset}/{amount}](https://docs.transportial.com/apis/quote/handle_84.md): Get all the quotes by offset and amount ### Get all quotes - [POST /quotes/{administration}/{offset}/{amount}](https://docs.transportial.com/apis/quote/handle_396.md): Get all the quotes by offset and amount ### Accept public quote - [POST /quote:public/{id}/accept/{shareCode}](https://docs.transportial.com/apis/quote/handle_88.md): Accept an existing quote ### Send quote - [POST /quote/{id}/send](https://docs.transportial.com/apis/quote/handle_99.md): Send a new quote ### Update quote - [PUT /quote](https://docs.transportial.com/apis/quote/handle_512.md): Create a new quote ### Create quote - [POST /quote](https://docs.transportial.com/apis/quote/handle_108.md): Create a new quote ### Get quote publicly - [GET /quote:public/{id}/{shareCode}](https://docs.transportial.com/apis/quote/handle_119.md): Get quote by ID and shareCode ### Get quote - [GET /quote/{id}](https://docs.transportial.com/apis/quote/handle_134.md): Get quote by ID ### Delete quote - [DELETE /quote/{id}](https://docs.transportial.com/apis/quote/handle_231.md): Delete quote by ID ### Accept quote - [POST /quote/{id}/accept](https://docs.transportial.com/apis/quote/handle_172.md): Accept an existing quote ### Decline quote - [POST /quote/{id}/decline](https://docs.transportial.com/apis/quote/handle_313.md): Decline the quote ### Create quote from documents - [PUT /quote/from-documents](https://docs.transportial.com/apis/quote/create:quote:fromdocuments.md): Create quote from documents ### Get quote activity - [GET /quote/{id}/activity](https://docs.transportial.com/apis/quote/handle_333.md): Get the activity timeline for a quote ### Create invoice from quote - [POST /quote/{id}/create:invoice](https://docs.transportial.com/apis/quote/handle_397.md): Create invoice entity from the quote entity ### Decline public quote - [POST /quote:public/{id}/decline/{shareCode}](https://docs.transportial.com/apis/quote/handle_461.md): Decline the quote ## ScheduleRoute A scheduleRoute is a device that is able to measure a quantity in a certain unit, such as measuring the speed in km/h. ### Get scheduleRoutes - [PUT /scheduleRoute](https://docs.transportial.com/apis/scheduleroute/handle_17.md): Get list of scheduleRoutes ### Create scheduleRoute - [POST /scheduleRoute](https://docs.transportial.com/apis/scheduleroute/handle_188.md): Create a new scheduleRoute ### Get scheduleRoute - [GET /scheduleRoute/{id}](https://docs.transportial.com/apis/scheduleroute/handle_69.md): Get a scheduleRoute on id ### Delete scheduleRoute - [DELETE /scheduleRoute/{id}](https://docs.transportial.com/apis/scheduleroute/handle_146.md): Delete a scheduleRoute ### Get scheduleRoutes - [GET /scheduleRoutes/{offset}/{amount}](https://docs.transportial.com/apis/scheduleroute/handle_278.md): Get the scheduleRoutes with an offset ### Get scheduleRoutes - [POST /scheduleRoutes/{offset}/{amount}](https://docs.transportial.com/apis/scheduleroute/handle_430.md): Get list of scheduleRoutes ## VehicleGroup A VehicleGroup is a group of Vehicle's. Groups can be used to reference a list of vehicles without having to select each individual one. ### Get vehicleGroups - [GET /vehicleGroups/{offset}/{amount}](https://docs.transportial.com/apis/vehiclegroup/get:vehiclegroups.md): Get list of vehicleGroups ### Search vehicleGroups - [POST /vehicleGroups/{offset}/{amount}](https://docs.transportial.com/apis/vehiclegroup/search:vehiclegroups.md): Search list of vehicleGroups ### Get vehicleGroup - [GET /vehicleGroup/{id}](https://docs.transportial.com/apis/vehiclegroup/get:vehiclegroup.md): Get a vehicleGroup on id ### Delete vehicleGroup - [DELETE /vehicleGroup/{id}](https://docs.transportial.com/apis/vehiclegroup/delete:vehiclegroup.md): Delete a vehicleGroup ### Get vehicleGroups - [GET /vehicleGroups/light](https://docs.transportial.com/apis/vehiclegroup/get:vehiclegroups_1.md): Get list of vehicleGroups ### Update vehicleGroup - [PUT /vehicleGroup](https://docs.transportial.com/apis/vehiclegroup/update:vehiclegroup.md): Update a vehicleGroup ### Create vehicleGroup - [POST /vehicleGroup](https://docs.transportial.com/apis/vehiclegroup/create:vehiclegroup.md): Create a new vehicleGroup ## LedgerEntry LedgerEntry ... ### Get LedgerEntries by entity type - [POST /ledgerEntriesByDateRange](https://docs.transportial.com/apis/ledgerentry/get:actions.md): Get list of ledgerEntries ### Get LedgerEntries by entity type - [POST /ledgerEntriesByCategoryAndDateRange](https://docs.transportial.com/apis/ledgerentry/get:actions_3.md): Get list of ledgerEntries ### Get LedgerEntries by entity type - [POST /ledgerEntriesByEntity](https://docs.transportial.com/apis/ledgerentry/get:actions_4.md): Get list of ledgerEntries ## Goods 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. ### Get goodss - [GET /goodss/{offset}/{amount}](https://docs.transportial.com/apis/goods/handle_18.md): Get list of goodss ### Search goods - [POST /goodss/{offset}/{amount}](https://docs.transportial.com/apis/goods/handle_128.md): Search goods ### Get goods - [GET /goods/{id}](https://docs.transportial.com/apis/goods/handle_105.md): Get a goods on id ### Delete goods - [DELETE /goods/{id}](https://docs.transportial.com/apis/goods/handle_300.md): Delete a goods ### Update goods - [PUT /goods](https://docs.transportial.com/apis/goods/handle_204.md): Update a goods ### Create goods - [POST /goods](https://docs.transportial.com/apis/goods/handle_115.md): Create a new goods ## Transaction Transactions ### Get all transactions - [GET /transactions/business/{business}/{offset}/{amount}](https://docs.transportial.com/apis/transaction/handle_20.md): Get all the transactions by offset and amount ### Get all transactions - [GET /transactions/{offset}/{amount}](https://docs.transportial.com/apis/transaction/handle_211.md): Get all the transactions by offset and amount ### Get all transactions - [GET /transactions/user/{user}/{offset}/{amount}](https://docs.transportial.com/apis/transaction/handle_238.md): Get all the transactions by offset and amount ### Get all transactions - [GET /transactions/date/{startDate}/{endDate}](https://docs.transportial.com/apis/transaction/handle_367.md): Get all the transactions by offset and amount ### Get transaction - [GET /transaction/{id}](https://docs.transportial.com/apis/transaction/handle_407.md): Get transaction by ID ## Async Generic asynchronous request results ### Get async request result - [GET /async/result/{requestId}](https://docs.transportial.com/apis/async/handle_21.md): Get the result of any completed async request by its request ID ### Get async request status - [GET /async/status/{requestId}](https://docs.transportial.com/apis/async/handle_160.md): Get the current status of any async request by its request ID ## Terminal Terminal management for term&conditions in forwarded orders ### Get terminal - [GET /terminal/{id}](https://docs.transportial.com/apis/terminal/handle_24.md): Get terminal by ID ### Delete terminal - [DELETE /terminal/{id}](https://docs.transportial.com/apis/terminal/handle_307.md): Delete terminal by ID ### Get terminals - [GET /terminals/{offset}/{amount}](https://docs.transportial.com/apis/terminal/get:terminals.md): Get all terminals ### Search terminals - [POST /terminals/{offset}/{amount}](https://docs.transportial.com/apis/terminal/search:terminals.md): Search all terminals ### Update terminal - [PUT /terminal](https://docs.transportial.com/apis/terminal/handle_370.md): Create a new terminal ### Create terminal - [POST /terminal](https://docs.transportial.com/apis/terminal/handle_219.md): Create a new terminal ## Notification Notification endpoint to notify people, groups or the entire user base of things they might want to know or need to know ### Read notifications - [POST /notification/read](https://docs.transportial.com/apis/notification/handle_28.md): Read notifications by ids ### Update notification - [PUT /notification](https://docs.transportial.com/apis/notification/handle_466.md): Update a new notification ### Create notification - [POST /notification](https://docs.transportial.com/apis/notification/handle_60.md): Create a new notification ### Get notification - [GET /notification/{id}](https://docs.transportial.com/apis/notification/handle_479.md): Get a notification on id ### Delete notification - [DELETE /notification/{id}](https://docs.transportial.com/apis/notification/handle_261.md): Delete a notification ### Received a notification - [GET /notification/{id}/received](https://docs.transportial.com/apis/notification/handle_285.md): Receive a notification by id ### Get notifications - [GET /notifications/{offset}/{amount}](https://docs.transportial.com/apis/notification/handle_364.md): Get list of notifications ### Read notification notification by id - [GET /notification/{id}/read](https://docs.transportial.com/apis/notification/handle_387.md): Get a notification on id ### Read notifications - [POST /notification/received](https://docs.transportial.com/apis/notification/handle_462.md): Read notifications by ids ## Capacity A capacity models the amount of cargo, a schedule can deliver. ### Get capacity - [GET /capacity/{id}](https://docs.transportial.com/apis/capacity/handle_59.md): Get a capacity within a schedule specified by id. ### Update capacity - [PUT /capacity/{id}](https://docs.transportial.com/apis/capacity/handle_182.md): Update a capacity within a schedule specified by id. ### Delete capacity - [DELETE /capacity/{id}](https://docs.transportial.com/apis/capacity/handle_29.md): Delete a capacity specified by id. ### Create capacity - [POST /capacity](https://docs.transportial.com/apis/capacity/handle_331.md): Create a capacity within a schedule specified by id. ### Get capacities - [GET /capacities/{offset}/{amount}](https://docs.transportial.com/apis/capacity/handle_382.md): Get a list of capacities from offset to amount. ## Attribute Object describing a geographic attribute. A attribute can either be a point or an area. ### Get attributes - [GET /attributes/{offset}/{amount}](https://docs.transportial.com/apis/attribute/handle_400.md): Get list of attributes ### Get attributes - [POST /attributes/{offset}/{amount}](https://docs.transportial.com/apis/attribute/handle_30.md): Get list of attributes ### Get attribute - [GET /attribute/{id}](https://docs.transportial.com/apis/attribute/handle_51.md): Get a attribute on id ### Delete attribute - [DELETE /attribute/{id}](https://docs.transportial.com/apis/attribute/handle_433.md): Delete a attribute ### Update attribute - [PUT /attribute](https://docs.transportial.com/apis/attribute/handle_301.md): Update a attribute ### Create attribute - [POST /attribute](https://docs.transportial.com/apis/attribute/handle_441.md): Create a new attribute ### Update attribute - [PUT /attributes](https://docs.transportial.com/apis/attribute/handle_504.md): Update a attribute ## Sensor A sensor is a device that is able to measure a quantity in a certain unit, such as measuring the speed in km/h. ### Get sensor - [GET /sensor/{id}](https://docs.transportial.com/apis/sensor/handle_32.md): Get a sensor on id ### Delete sensor - [DELETE /sensor/{id}](https://docs.transportial.com/apis/sensor/handle_360.md): Delete a sensor ### Get sensor types - [GET /sensor/types](https://docs.transportial.com/apis/sensor/handle_109.md): Get list of sensor types ### Get sensor update - [GET /sensor/{id}/value/{date}](https://docs.transportial.com/apis/sensor/handle_159.md): Get a sensor update for a specific date and time. It will find the closest ### Get sensor values by date range - [GET /sensors/{id}/updates/{start}/{end}](https://docs.transportial.com/apis/sensor/handle_164.md): Get all sensor updates in a date range ### Get sensors - [GET /sensors/{offset}/{amount}](https://docs.transportial.com/apis/sensor/handle_174.md): Get list of sensors ### Get sensors - [POST /sensors/{offset}/{amount}](https://docs.transportial.com/apis/sensor/handle_206.md): Get list of sensors ### Get sensors - [PUT /sensors](https://docs.transportial.com/apis/sensor/handle_289.md): Get list of sensors ### Create sensor - [POST /sensor](https://docs.transportial.com/apis/sensor/handle_343.md): Create a new sensor ## Camera A Camera. ### Get Camera - [GET /vehicle:camera/{id}](https://docs.transportial.com/apis/camera/handle_161.md): Get a camera on id ### Update Camera - [PUT /vehicle:camera/{id}](https://docs.transportial.com/apis/camera/handle_34.md): Update Camera ### Delete Camera - [DELETE /vehicle:camera/{id}](https://docs.transportial.com/apis/camera/handle_42.md): Delete a Camera ### Create new camera for a Vehicle - [POST /vehicle/{vehicle_id}/camera](https://docs.transportial.com/apis/camera/handle_118.md): Create new camera for a Vehicle ### Get Cameras by vehicle Id - [GET /vehicle/{vehicle_id}/cameras](https://docs.transportial.com/apis/camera/handle_489.md): Get list of cameras ## Location Object describing a geographic location. A location can either be a point or an area. ### Get locations - [GET /locations/{offset}/{amount}](https://docs.transportial.com/apis/location/handle_35.md): Get list of locations ### Get locations - [POST /locations/{offset}/{amount}](https://docs.transportial.com/apis/location/handle_179.md): Get list of locations ### Update location - [PUT /location](https://docs.transportial.com/apis/location/handle_82.md): Update a location ### Create location - [POST /location](https://docs.transportial.com/apis/location/handle_178.md): Create a new location ### Get location average action duration - [GET /location/{id}/action/{type}/duration{average}](https://docs.transportial.com/apis/location/handle_87.md): Get the average duration of an action type on the location ### Get location - [GET /location/{id}](https://docs.transportial.com/apis/location/handle_326.md): Get a location on id ### Delete location - [DELETE /location/{id}](https://docs.transportial.com/apis/location/handle_114.md): Delete a location ### Get location actions - [GET /location/{id}/actions/{offset}/{amount}](https://docs.transportial.com/apis/location/handle_127.md): Get the actions that have previously occurred on a location ### Find duplicate locations - [POST /location/duplicates](https://docs.transportial.com/apis/location/handle_150.md): Find duplicate locations based on location object in body ### Geocode from AddressGeoReference - [POST /location/geocode/addressGeoReference](https://docs.transportial.com/apis/location/handle_493.md): Get coordinates (LatLongPointGeoReference) from AddressGeoReference ## TransportOrder The TransportOrder is the top-level entity to model a group of related consignments that might be transported separately, but need to be administered together. ### Update transportOrder - [PUT /transportOrder](https://docs.transportial.com/apis/transportorder/update:transportorder.md): Update a transportOrder ### Create transportOrder - [POST /transportOrder](https://docs.transportial.com/apis/transportorder/create:transportorder.md): Create a new transportOrder ### Accept TransportOrder - [GET /transportOrder/{id}/accept](https://docs.transportial.com/apis/transportorder/accept:transportorder.md): Accept a requested transport order ### Get Trips for TransportOrder (Customer Portal) - [GET /transportOrder/{id}/trips:customer](https://docs.transportial.com/apis/transportorder/get:transportorder:trips:customer.md): Get trips for a transport order. Only requires get:transportOrder permission, suitable for customer portal users. ### Get Trips for TransportOrder - [GET /transportOrder/{id}/trips](https://docs.transportial.com/apis/transportorder/get:transportorder:trips.md): Get all trips (legs) associated with a transport order. Returns trips linked through the order's consignments, sorted by start date. Useful for viewing the execution status of forwarded orders. ### TransportOrder to Tender - [POST /transportOrder/{id}/tender](https://docs.transportial.com/apis/transportorder/transportorder:tender.md): TransportOrder to Tender on id ### Get transportOrders - [POST /transportOrders:extended/{offset}/{amount}](https://docs.transportial.com/apis/transportorder/search:transportorders.md): Get list of transportOrders ### Get transportOrder - [GET /transportOrder/{id}](https://docs.transportial.com/apis/transportorder/get:transportorder.md): Get a transportOrder on id ### Delete transportOrder - [DELETE /transportOrder/{id}](https://docs.transportial.com/apis/transportorder/delete:transportorder.md): Delete a transportOrder ### Cancel TransportOrder - [GET /transportOrder/{id}/cancel](https://docs.transportial.com/apis/transportorder/cancel:transportorder.md): Cancel a requested transport order ### Get extended transportOrder - [GET /transportOrder:extended/{id}](https://docs.transportial.com/apis/transportorder/get:transportorder_1.md): Get a transportOrder on id with extended information ### Get transportOrders with status - [GET /transportOrders/{status}/{offset}/{amount}](https://docs.transportial.com/apis/transportorder/get:transportorder_2.md): Get list of transportOrders with a specific status ### Get transportOrders with status - [GET /transportOrders:extended/{status}/{offset}/{amount}](https://docs.transportial.com/apis/transportorder/get:transportorder_3.md): Get list of transportOrders with a specific status ### Get trips for a shared transport order - [GET /transportOrder/{id}/{shareCode}/trips](https://docs.transportial.com/apis/transportorder/get:transportorder:public:trips.md): Returns trips linked to the transport order, filtered by the share settings visibility configuration ### Get transportOrders - [GET /transportOrders/{offset}/{amount}](https://docs.transportial.com/apis/transportorder/get:transportorder_4.md): Get list of transportOrders ### Get transportOrders - [POST /transportOrders/{offset}/{amount}](https://docs.transportial.com/apis/transportorder/search:transportorders_1.md): Get list of transportOrders ### Get transportOrder - [GET /transportOrder:extended/{id}/{shareCode}](https://docs.transportial.com/apis/transportorder/get:transportorder_5.md): Get a transportOrder on id with extended information ### Create transportOrder from Email - [PUT /transportOrder/mail/receiver](https://docs.transportial.com/apis/transportorder/create:transportorder:frommail.md): Create transportOrder from Email ### Decline TransportOrder - [GET /transportOrder/{id}/decline](https://docs.transportial.com/apis/transportorder/decline:transportorder.md): Decline a requested transport order ### Get transportOrder - [GET /transportOrder/{id}/{shareCode}](https://docs.transportial.com/apis/transportorder/get:transportorder_6.md): Get a transportOrder on id with extended information ### Duplicate transportOrder - [GET /transportOrder/{id}/duplicate](https://docs.transportial.com/apis/transportorder/duplicate:transportorder.md): Duplicate a TransportOrder to a new transport order ### Get transport order activity - [GET /transportOrder/{id}/activity](https://docs.transportial.com/apis/transportorder/handle_437.md): Get the activity timeline for a transport order ### Create transportOrder from documents - [POST /transportOrder/from-documents](https://docs.transportial.com/apis/transportorder/create:transportorder:fromdocument.md): Create a new transportOrder from documents ### Cancel transport orders - [POST /transportOrders/cancel](https://docs.transportial.com/apis/transportorder/handle_457.md): Cancel a list of transport orders ### Forward TransportOrder to Carrier - [POST /transportOrder/{id}/forward](https://docs.transportial.com/apis/transportorder/forward:transportorder.md): Forward an entire transport order to an external carrier. This is a simplified operation that creates a single forwarded trip for the entire order, assigned to the specified capacity contract (external carrier). For splitting into multiple legs with different carriers, use the /split endpoint instead. ### Split TransportOrder into Trips - [POST /transportOrder/{id}/split](https://docs.transportial.com/apis/transportorder/split:transportorder.md): Split a transport order into multiple trips (legs) for forwarding scenarios. This is used when an order needs to be executed by multiple carriers, for example: pickup carrier collects from shipper, line-haul carrier transports between hubs, delivery carrier delivers to consignee. Each leg can be assigned to a different external carrier via a capacity contract. ## Team A Team is a group of Vehicle's. Groups can be used to reference a list of vehicles without having to select each individual one. ### Get settingsGroups - [GET /settingsGroups/{offset}/{amount}](https://docs.transportial.com/apis/team/get:settingsgroups.md): Get list of settingsGroups ### Search settingsGroups - [POST /settingsGroups/{offset}/{amount}](https://docs.transportial.com/apis/team/search:settingsgroups.md): Search list of settingsGroups ### Get teams - [GET /teams/{offset}/{amount}](https://docs.transportial.com/apis/team/get:teams.md): Get list of teams ### Search teams - [POST /teams/{offset}/{amount}](https://docs.transportial.com/apis/team/search:teams.md): Search list of teams ### Update settingsGroup - [PUT /settingsGroup](https://docs.transportial.com/apis/team/update:settingsgroup.md): Update a settingsGroup ### Create settingsGroup - [POST /settingsGroup](https://docs.transportial.com/apis/team/create:settingsgroup.md): Create a new settingsGroup ### Get settingsGroup - [GET /settingsGroup/{id}](https://docs.transportial.com/apis/team/get:settingsgroup_1.md): Get a settingsGroup on id ### Delete settingsGroup - [DELETE /settingsGroup/{id}](https://docs.transportial.com/apis/team/delete:settingsgroup.md): Delete a settingsGroup ### Update team - [PUT /team](https://docs.transportial.com/apis/team/update:team.md): Update a team ### Create team - [POST /team](https://docs.transportial.com/apis/team/create:team.md): Create a new team ### Get team - [GET /team/{id}](https://docs.transportial.com/apis/team/get:team.md): Get a team on id ### Delete team - [DELETE /team/{id}](https://docs.transportial.com/apis/team/delete:team.md): Delete a team ### Get settingsGroup - [GET /settingsGroup/{id}/apply](https://docs.transportial.com/apis/team/get:settingsgroup.md): Get a settingsGroup on id ## ToDo A to-do represents a basic specific task within a lane of a board. ### Get toDos - [GET /todos/user/{user}/{offset}/{amount}](https://docs.transportial.com/apis/todo/handle_37.md): Get list of toDos ### Get toDo - [GET /board/lane/todo/{id}](https://docs.transportial.com/apis/todo/handle_217.md): Get a toDo on id ### Update todo - [PUT /board/lane/todo/{id}](https://docs.transportial.com/apis/todo/handle_45.md): Update a todo ### Delete toDo - [DELETE /board/lane/todo/{id}](https://docs.transportial.com/apis/todo/handle_340.md): Delete a toDo ### Get user statistics - [GET /todo:statistics/user/{id}](https://docs.transportial.com/apis/todo/handle_72.md): Get to do user statistics ### Get toDoComment - [GET /toDo/comment/{id}](https://docs.transportial.com/apis/todo/handle_132.md): Get a toDoComment on id ### Delete toDoComment - [DELETE /toDo/comment/{id}](https://docs.transportial.com/apis/todo/handle_317.md): Delete a toDoComment ### Get toDos - [GET /board/lane/todos/{offset}/{amount}](https://docs.transportial.com/apis/todo/handle_180.md): Get list of toDos ### Get toDos - [POST /board/lane/todos/{offset}/{amount}](https://docs.transportial.com/apis/todo/handle_169.md): Get list of toDos ### Get statistics - [GET /todo:statistics](https://docs.transportial.com/apis/todo/handle_203.md): Get to do statistics ### Get lanes - [GET /board/{id}/lanes/{offset}/{amount}](https://docs.transportial.com/apis/todo/handle_249.md): Get list of lanes ### Update toDoComment - [PUT /toDo/comment](https://docs.transportial.com/apis/todo/handle_368.md): Update a toDoComment ### Create toDoComment - [POST /toDo/comment](https://docs.transportial.com/apis/todo/handle_290.md): Create a new toDoComment ### Get toDoComments - [GET /toDo/{id}/comments/{offset}/{amount}](https://docs.transportial.com/apis/todo/handle_424.md): Get list of toDoComments ### Get toDoComments - [POST /toDo/{id}/comments/{offset}/{amount}](https://docs.transportial.com/apis/todo/handle_341.md): Get list of toDoComments ### Get toDos - [GET /todos:byDateRange/{fromDate}/{toDate}](https://docs.transportial.com/apis/todo/handle_416.md): Get list of toDos ### Get toDos - [GET /todos:byDateRange/user/{user}/{fromDate}/{toDate}](https://docs.transportial.com/apis/todo/handle_497.md): Get list of toDos ### Get toDos - [GET /todos:byEntity/{entityType}/{entityId}/{offset}/{amount}](https://docs.transportial.com/apis/todo/handle_499.md): Get list of toDos ## Constraint Constraints can be stacked and constrain different activities in their context ### Get constraints - [GET /constraints/{offset}/{amount}](https://docs.transportial.com/apis/constraint/create:constraints.md): Get list of constraints ### Get constraint - [GET /constraint/{id}](https://docs.transportial.com/apis/constraint/get:constraint.md): Get a constraint on id ### Delete constraint - [DELETE /constraint/{id}](https://docs.transportial.com/apis/constraint/delete:constraint.md): Delete a constraint ### Update constraint - [PUT /constraint](https://docs.transportial.com/apis/constraint/update:constraint.md): Update a constraint ### Create constraint - [POST /constraint](https://docs.transportial.com/apis/constraint/create:constraint.md): Create a new constraint ## General General reference data sets like Languages, Currencies etc. ### Search Tax Rates - [POST /taxRates/{offset}/{amount}](https://docs.transportial.com/apis/general/handle_38.md): Search tax rates with pagination ### Get Industries - [GET /industries](https://docs.transportial.com/apis/general/handle_125.md): Get all the industries available ### Get Permissions - [GET /permissions](https://docs.transportial.com/apis/general/handle_155.md): Get all the permissions available ### Update Pricing Category - [PUT /pricingCategory/{id}](https://docs.transportial.com/apis/general/handle_166.md): Update an existing pricing category ### Delete Pricing Category - [DELETE /pricingCategory/{id}](https://docs.transportial.com/apis/general/handle_371.md): Delete a pricing category ### Create Tax Rate - [POST /taxRate](https://docs.transportial.com/apis/general/handle_177.md): Create a new tax rate ### Get pricing categories - [GET /pricingCategories](https://docs.transportial.com/apis/general/handle_198.md): Get all the pricing categories available ### Put pricing categories - [PUT /pricingCategories](https://docs.transportial.com/apis/general/handle_281.md): Put all the pricing categories ### Get empty entity structure - [GET /entity/{entityType}](https://docs.transportial.com/apis/general/handle_233.md): Get json empty entity structure by giving ### Get TaxRates - [GET /taxRates](https://docs.transportial.com/apis/general/handle_299.md): Get all the Tax Rates available ### Put TaxRates - [PUT /taxRates](https://docs.transportial.com/apis/general/handle_246.md): Put all the Tax Rates available ### Create Pricing Category - [POST /pricingCategory](https://docs.transportial.com/apis/general/handle_279.md): Create a new pricing category ### Get version history for an entity - [GET /entity:history/{entityType}/{id}/{offset}/{amount}](https://docs.transportial.com/apis/general/handle_321.md): Get version history for an entity ### Get Currencies - [GET /currencies](https://docs.transportial.com/apis/general/handle_363.md): Get all the currencies available ### Update Tax Rate - [PUT /taxRate/{id}](https://docs.transportial.com/apis/general/handle_467.md): Update an existing tax rate ### Delete Tax Rate - [DELETE /taxRate/{id}](https://docs.transportial.com/apis/general/handle_383.md): Delete a tax rate ### Get Languages - [GET /languages](https://docs.transportial.com/apis/general/handle_401.md): Get all the languages available ### Search Pricing Categories - [POST /pricingCategories/{offset}/{amount}](https://docs.transportial.com/apis/general/handle_449.md): Search pricing categories with pagination ### Search any element - [POST /general/{offset}/{amount}](https://docs.transportial.com/apis/general/search:general.md): Search list of consignments by query and multiple parameters ### Creating JSON from value pairs - [PUT /mappingToJson](https://docs.transportial.com/apis/general/handle_509.md): Create JSON object and/or array from the mapping array with the mapping path and value ## Pricing A pricing models the path going from one location to at least one other location. ### Update pricing - [PUT /pricing](https://docs.transportial.com/apis/pricing/handle_295.md): Update a pricing ### Create pricing - [POST /pricing](https://docs.transportial.com/apis/pricing/handle_41.md): Create a new pricing ### Get pricing variable index - [GET /pricingVariableIndex/{id}](https://docs.transportial.com/apis/pricing/handle_486.md): Get a pricing variable index on id ### Delete pricing variable index - [DELETE /pricingVariableIndex/{id}](https://docs.transportial.com/apis/pricing/handle_70.md): Delete a pricing variable index ### Get pricing variable indexes - [GET /pricingVariableIndexes/{offset}/{amount}](https://docs.transportial.com/apis/pricing/handle_81.md): Get list of pricing variable indexes ### Search pricing variable indexes - [POST /pricingVariableIndexes/{offset}/{amount}](https://docs.transportial.com/apis/pricing/handle_470.md): Search list of pricing variable indexes based on query ### Get pricing - [GET /pricing/{id}](https://docs.transportial.com/apis/pricing/handle_215.md): Get a pricing on id ### Delete pricing - [DELETE /pricing/{id}](https://docs.transportial.com/apis/pricing/handle_101.md): Delete a pricing ### Generate pricing modules from documents - [POST /pricing/modules/from-documents](https://docs.transportial.com/apis/pricing/create:pricing:modules:fromdocuments.md): Use AI to analyze documents (rate cards, contracts, price lists) or text descriptions and generate appropriate pricing modules ### Update pricing - [PUT /pricingVariableIndex](https://docs.transportial.com/apis/pricing/handle_291.md): Update a pricing ### Create pricing variable index - [POST /pricingVariableIndex](https://docs.transportial.com/apis/pricing/handle_415.md): Create a new pricing variable index ### Get pricings - [GET /pricings/{offset}/{amount}](https://docs.transportial.com/apis/pricing/handle_390.md): Get list of pricings ### Search pricings - [POST /pricings/{offset}/{amount}](https://docs.transportial.com/apis/pricing/handle_471.md): Search list of pricings based on query ## Invoice Invoices ### Confirm payment for public invoice - [POST /invoice:public/{id}/{shareCode}/confirm-payment](https://docs.transportial.com/apis/invoice/handle_43.md): Verifies a completed Stripe PaymentIntent and marks the invoice as paid. Expects { paymentIntentId } in the request body. ### Get all invoices - [GET /invoices/{administration}/{offset}/{amount}](https://docs.transportial.com/apis/invoice/handle_154.md): Get all the invoices by offset and amount ### Get all invoices - [POST /invoices/{administration}/{offset}/{amount}](https://docs.transportial.com/apis/invoice/handle_57.md): Get all the invoices by offset and amount ### Create payment intent for public invoice - [POST /invoice:public/{id}/{shareCode}/payment-intent](https://docs.transportial.com/apis/invoice/handle_68.md): Creates a Stripe PaymentIntent for paying an invoice via a public share link. Returns the clientSecret and publicKey needed by Stripe.js. ### Get pending approvals - [GET /invoice/pending-approvals](https://docs.transportial.com/apis/invoice/handle_98.md): Get pending invoice approvals for the current user ### Request invoice approval - [POST /invoice/{invoiceId}/request-approval](https://docs.transportial.com/apis/invoice/handle_103.md): Request approval for an IN direction invoice ### Update invoice - [PUT /invoice](https://docs.transportial.com/apis/invoice/handle_145.md): Create a new invoice ### Create invoice - [POST /invoice](https://docs.transportial.com/apis/invoice/handle_513.md): Create a new invoice ### Reject invoice - [POST /invoice/{invoiceId}/reject](https://docs.transportial.com/apis/invoice/handle_201.md): Reject a pending invoice ### Get invoice - [GET /invoice/{id}](https://docs.transportial.com/apis/invoice/handle_419.md): Get invoice by ID ### Delete invoice - [DELETE /invoice/{id}](https://docs.transportial.com/apis/invoice/handle_223.md): Delete invoice by ID ### Approve invoice - [POST /invoice/{invoiceId}/approve](https://docs.transportial.com/apis/invoice/handle_266.md): Approve a pending invoice ### Get invoice activity - [GET /invoice/{id}/activity](https://docs.transportial.com/apis/invoice/handle_315.md): Get the activity timeline for an invoice ### Get available payment providers for a public invoice - [GET /invoice:public/{id}/{shareCode}/payment-providers](https://docs.transportial.com/apis/invoice/handle_325.md): Returns the list of payment providers (stripe, mollie, adyen) configured for the platform of this invoice. ### Send invoice - [POST /invoice/{id}/send](https://docs.transportial.com/apis/invoice/handle_352.md): S a new invoice ### Get invoice publicly - [GET /invoice:public/{id}/{shareCode}](https://docs.transportial.com/apis/invoice/handle_393.md): Get invoice by ID and shareCode ### Create invoice from Email - [PUT /invoice/mail/receiver](https://docs.transportial.com/apis/invoice/create:invoice:frommail.md): Create invoice from Email ### Get all pending approvals - [GET /invoice/all-pending-approvals](https://docs.transportial.com/apis/invoice/handle_417.md): Get all pending invoice approvals for the platform (admin function) ### Create invoice from documents - [PUT /invoice/from-documents](https://docs.transportial.com/apis/invoice/create:invoice:fromdocuments.md): Create invoice from documents ### Send invoice reminder - [POST /invoice/{id}/send:reminder](https://docs.transportial.com/apis/invoice/handle_480.md): Send a invoice reminder ## Integration Update an existing integration test case. ### Update integration test - [PUT /integration/{id}/test/{testId}](https://docs.transportial.com/apis/integration/handle_44.md): Updates the name, description, input, or expected output of a saved test case. ### Delete integration test - [DELETE /integration/{id}/test/{testId}](https://docs.transportial.com/apis/integration/handle_263.md): Permanently removes a saved test case. ### Get integrations - [GET /integrations/{offset}/{amount}](https://docs.transportial.com/apis/integration/handle_141.md): Get list of integrations ### Get integrations - [POST /integrations/{offset}/{amount}](https://docs.transportial.com/apis/integration/handle_55.md): Get list of integrations ### Handle - [GET /integration/{id}/{token}](https://docs.transportial.com/apis/integration/handle_90.md): Create a new integration ### Run integration test - [POST /integration/{id}/test/{testId}/run](https://docs.transportial.com/apis/integration/handle_165.md): Executes the saved test case by feeding its input through the data source mapping and comparing the output against the expected value. ### Set open id authentication token - [PUT /integration/{id}/openId](https://docs.transportial.com/apis/integration/handle_183.md): Enable the authentication flow for OpenId by setting the toke ### Test DataSource mapping - [POST /integration/dataSource/mapping:test](https://docs.transportial.com/apis/integration/handle_252.md): Ability to test the integration DataSource field mapping response ### Generate integration credentials - [POST /integration/generate/credentials](https://docs.transportial.com/apis/integration/handle_258.md): Generate all new integration credentials ### Update integration - [PUT /integration](https://docs.transportial.com/apis/integration/handle_272.md): Update a integration ### Create integration - [POST /integration](https://docs.transportial.com/apis/integration/handle_507.md): Create a new integration ### Upload a template file - [POST /integration/file/upload](https://docs.transportial.com/apis/integration/integration:fileupload.md): Upload a new file ### Test fileTemplate mapping - [POST /integration/fileTemplate/mapping:test](https://docs.transportial.com/apis/integration/handle_324.md): Ability to test the integration fileTemplate field mapping response ### Get integration tests - [GET /integration/{id}/test](https://docs.transportial.com/apis/integration/handle_351.md): Returns all saved test cases associated with the given integration. ### Create integration test - [POST /integration/{id}/test](https://docs.transportial.com/apis/integration/handle_327.md): Saves a new test case (input + expected output) for the given integration. ### Import data - [POST /integration/import/data](https://docs.transportial.com/apis/integration/handle_329.md): Import data from any format through our mapping tool into the platform ### Get integration - [GET /integration/{id}](https://docs.transportial.com/apis/integration/handle_359.md): Get a integration on id ### Delete integration - [DELETE /integration/{id}](https://docs.transportial.com/apis/integration/handle_336.md): Delete a integration ### Handle - [GET /integration/{id}/dataSource/{dataSourceId}/{token}](https://docs.transportial.com/apis/integration/handle_342.md): Create a new integration ### Get manual integration functions - [GET /integration/type/{type}/functions](https://docs.transportial.com/apis/integration/handle_356.md): Get list of manual integration functions ### Generate integration with AI - [POST /integration/generate](https://docs.transportial.com/apis/integration/generate:integration.md): Use AI to generate an integration configuration from a text description or API documentation ### Run all integration tests - [POST /integration/{id}/test/run](https://docs.transportial.com/apis/integration/handle_380.md): Executes every saved test case for the integration and returns a pass/fail summary. The last status of each test is persisted. ### Get integration request logs - [GET /integration/{id}/requestLogs/{offset}/{amount}](https://docs.transportial.com/apis/integration/handle_411.md): Get list of integration request logs ### Handle incoming email - [POST /integration/email](https://docs.transportial.com/apis/integration/handle_422.md): Tne endpoint to receive email data ### Get integration tasks - [GET /integration/{id}/tasks/{offset}/{amount}](https://docs.transportial.com/apis/integration/handle_482.md): Get list of integration tasks ### Get integration logs - [GET /integration/{id}/logs/{offset}/{amount}](https://docs.transportial.com/apis/integration/handle_483.md): Get list of integration logs ### Get integration logs - [GET /integration/{id}/objects/{offset}/{amount}](https://docs.transportial.com/apis/integration/handle_506.md): Get list of integrations ## Lane A lane contains a location and status of a todo task. ### Get lane - [GET /board/lane/{id}](https://docs.transportial.com/apis/lane/handle_192.md): Get a lane on id ### Update Lane - [PUT /board/lane/{id}](https://docs.transportial.com/apis/lane/handle_48.md): Update Lane ### Delete lane - [DELETE /board/lane/{id}](https://docs.transportial.com/apis/lane/handle_318.md): Delete a lane ### Add new Lane in Board - [POST /board/{id}/lane](https://docs.transportial.com/apis/lane/handle_62.md): Add new Lane in a Board ### Update position of Todo in a Lane - [PUT /board/lane/{lane_id}/todo/{id}/change-position/{position}](https://docs.transportial.com/apis/lane/handle_79.md): Update position of Todo in a Lane ### Get lanes - [GET /board/lanes/{offset}/{amount}](https://docs.transportial.com/apis/lane/handle_446.md): Get list of lanes ### Get toDos - [POST /board/lanes/{offset}/{amount}](https://docs.transportial.com/apis/lane/handle_151.md): Get list of toDos ### Update position of Todo in a Lane - [PUT /board/lane/{id}/change-position/{position}](https://docs.transportial.com/apis/lane/handle_163.md): Update position of Todo in a Lane ### Add new Todo in Lane - [POST /board/lane/{id}/todo](https://docs.transportial.com/apis/lane/handle_494.md): Add new Todo in a Lane ## Administration Administrations can be stacked and constrain different activities in their context ### Delete administration - [DELETE /administration/{id}](https://docs.transportial.com/apis/administration/delete:administration.md): Delete a administration ### Get administration - [GET /administration](https://docs.transportial.com/apis/administration/handle_126.md): Get administration by ID ### Update administration - [PUT /administration](https://docs.transportial.com/apis/administration/update:administration.md): Update a administration ### Create administration - [POST /administration](https://docs.transportial.com/apis/administration/create:administration.md): Create a new administration ### Get administrations - [GET /administrations/{offset}/{amount}](https://docs.transportial.com/apis/administration/get:administrations.md): Get list of administrations ### Get administrations - [POST /administrations/{offset}/{amount}](https://docs.transportial.com/apis/administration/search:administrations.md): Search list of administrations based on query and params ## Consignment Consignments can be stacked and constrain different activities in their context ### Get consignment - [GET /consignment:extended/{id}](https://docs.transportial.com/apis/consignment/get:consignment.md): Get a consignment on id ### Split consignments - [POST /consignments/split](https://docs.transportial.com/apis/consignment/split:consignment.md): Previously combined order -> split into unique consignments ### Add documents - [PUT /consignment/{id}/documents](https://docs.transportial.com/apis/consignment/handle_162.md): Add documents to tripp ### Update consignment - [PUT /consignment](https://docs.transportial.com/apis/consignment/update:consignment.md): Update a consignment ### Create consignment - [POST /consignment](https://docs.transportial.com/apis/consignment/create:consignment.md): Create a new consignment ### Get consignment - [GET /consignment/{id}](https://docs.transportial.com/apis/consignment/get:consignment_1.md): Get a consignment on id ### Delete consignment - [DELETE /consignment/{id}](https://docs.transportial.com/apis/consignment/delete:consignment.md): Delete a consignment ### Get consignments - [GET /consignments/{offset}/{amount}](https://docs.transportial.com/apis/consignment/get:consignments.md): Get list of consignments ### Search consignments - [POST /consignments/{offset}/{amount}](https://docs.transportial.com/apis/consignment/search:consignments.md): Search list of consignments by query and multiple parameters ### Combine consignments - [POST /consignments/combine](https://docs.transportial.com/apis/consignment/combine:consignment.md): Combine consignments ### Get extended consignments - [GET /consignments:extended/{offset}/{amount}](https://docs.transportial.com/apis/consignment/get:consignments_1.md): Get extended list of consignments ### Search extended consignments - [POST /consignments:extended/{offset}/{amount}](https://docs.transportial.com/apis/consignment/search:consignments_1.md): Search extended list of consignments by query and multiple parameters ### Cancel consignment - [GET /consignment:cancel/{id}](https://docs.transportial.com/apis/consignment/cancel:consignment.md): Cancel a consignment ## BoardComputer A Boardcomputer is a device that tracks properties of a Vehicle. Values received from a Boardcomputer can be the current location, speed, temperatues etc. ### Get boardComputer - [GET /boardComputer/{id}](https://docs.transportial.com/apis/boardcomputer/get:boardcomputer.md): Get a boardComputer on id ### Delete boardComputer - [DELETE /boardComputer/{id}](https://docs.transportial.com/apis/boardcomputer/delete:boardcomputer.md): Delete a boardComputer ### Update boardComputer - [PUT /boardComputer](https://docs.transportial.com/apis/boardcomputer/update:boardcomputer.md): Update a boardComputer ### Create boardComputer - [POST /boardComputer](https://docs.transportial.com/apis/boardcomputer/create:boardcomputer.md): Create a new boardComputer ### Get boardComputers - [GET /boardComputers/{offset}/{amount}](https://docs.transportial.com/apis/boardcomputer/get:boardcomputers.md): Get list of boardComputers ### Get boardComputers - [POST /boardComputers/{offset}/{amount}](https://docs.transportial.com/apis/boardcomputer/search:boardcomputers.md): Get list of boardComputers ## Booking Object describing a geographic booking. A booking can either be a point or an area. ### Update booking - [PUT /booking](https://docs.transportial.com/apis/booking/handle_139.md): Update a booking ### Create booking - [POST /booking](https://docs.transportial.com/apis/booking/handle_58.md): Create a new booking ### Get booking - [GET /booking/{id}](https://docs.transportial.com/apis/booking/handle_202.md): Get a booking on id ### Delete booking - [DELETE /booking/{id}](https://docs.transportial.com/apis/booking/handle_116.md): Delete a booking ### Get bookings - [GET /bookings/{offset}/{amount}](https://docs.transportial.com/apis/booking/handle_239.md): Get list of bookings ### Get bookings - [POST /bookings/{offset}/{amount}](https://docs.transportial.com/apis/booking/handle_303.md): Get list of bookings ### Carrier booking confirmation webhook - [POST /booking/carrier/{carrierId}/confirm](https://docs.transportial.com/apis/booking/handle_425.md): Receives a booking confirmation from an external ferry or air carrier and updates the corresponding Booking record. ## Document Documents are the base entities to handle all types of external data files and the references to them ### Unverify document - [GET /document/{id}/unverify](https://docs.transportial.com/apis/document/unverify:document.md): Unverify a document on id ### Get documents - [GET /documents/{offset}/{amount}](https://docs.transportial.com/apis/document/get:documents.md): Get list of documents ### Get documents - [POST /documents/{offset}/{amount}](https://docs.transportial.com/apis/document/search:documents.md): Search list of documents based on query and params ### Verify document - [GET /document/{id}/verify](https://docs.transportial.com/apis/document/verify:document.md): Verify a document on id ### Get document - [GET /document/{id}](https://docs.transportial.com/apis/document/get:document.md): Get a document on id ### Delete document - [DELETE /document/{id}](https://docs.transportial.com/apis/document/delete:document.md): Delete a document ### Update document - [PUT /document](https://docs.transportial.com/apis/document/update:document.md): Update a document ### Create document - [POST /document](https://docs.transportial.com/apis/document/create:document.md): Create a new document ## Chauffeur Calendar Events Occurrences Calendar Events API endpoints. ### Get calendar events for a specific chauffeur within a date range. - [GET /chauffeurs/{chauffeurId}/timeslot-occurrences](https://docs.transportial.com/apis/chauffeur-calendar-events-occurrences/getchauffeurcalendarevents.md) ### Get calendar events for a specific chauffeur within a date range. - [GET /chauffeurs/{chauffeurId}/calendar-occurrences](https://docs.transportial.com/apis/chauffeur-calendar-events-occurrences/getchauffeurcalendarevents_1.md) ## Complaint Object describing a geographic Complaint. A Complaint can either be a point or an area. ### Get complaints against a vehicle - [GET /complaints/vehicle/{id}/{offset}/{amount}](https://docs.transportial.com/apis/complaint/handle_13.md): Get list of Complaints ### Get complaints against a user - [GET /complaints/user/{id}/{offset}/{amount}](https://docs.transportial.com/apis/complaint/handle_27.md): Get list of Complaints ### Get complaints against a Chauffeur - [GET /complaints/chauffeur/{id}/{offset}/{amount}](https://docs.transportial.com/apis/complaint/handle_53.md): Get list of Complaints Filtered By Chauffeur ### Get Complaints - [GET /complaints/{offset}/{amount}](https://docs.transportial.com/apis/complaint/handle_501.md): Get list of Complaints ### Get Complaints - [POST /complaints/{offset}/{amount}](https://docs.transportial.com/apis/complaint/handle_74.md): Get list of Complaints ### Get complaints against a vehicle - [GET /complaints/business/{id}/{offset}/{amount}](https://docs.transportial.com/apis/complaint/handle_102.md): Get list of Complaints ### Get Complaint - [GET /complaint/{id}](https://docs.transportial.com/apis/complaint/handle_136.md): Get a Complaint on id ### Delete Complaint - [DELETE /complaint/{id}](https://docs.transportial.com/apis/complaint/handle_256.md): Delete a Complaint ### Update Complaint - [PUT /complaint](https://docs.transportial.com/apis/complaint/handle_240.md): Update a Complaint ### Create Complaint - [POST /complaint](https://docs.transportial.com/apis/complaint/handle_144.md): Create a new Complaint ### Get complaints for a location - [GET /complaints/location/{id}/{offset}/{amount}](https://docs.transportial.com/apis/complaint/handle_358.md): Get list of Complaints ## Routing Everything routing: meaning the routes from A-B supporting multiple modalities ### Calculate a route - [POST /routing/calculate/route](https://docs.transportial.com/apis/routing/handle_78.md): Create a new sensor ## Board Boards contain Lanes and might represent a module of a project or a project itself ### Create board - [POST /board](https://docs.transportial.com/apis/board/create:board.md): Create a new board ### Get boards - [GET /boards/{offset}/{amount}](https://docs.transportial.com/apis/board/get:boards.md): Get list of boards ### Get Boards - [POST /boards/{offset}/{amount}](https://docs.transportial.com/apis/board/search:boards.md): Search list of chauffeurs based on query and params ### Get board - [GET /board/{id}](https://docs.transportial.com/apis/board/get:board.md): Get a board on id ### Update board - [PUT /board/{id}](https://docs.transportial.com/apis/board/update:board.md): Update a board ### Delete board - [DELETE /board/{id}](https://docs.transportial.com/apis/board/delete:board.md): Delete a board ## Event 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. ### Update event - [PUT /event](https://docs.transportial.com/apis/event/update:event.md): Update a event ### Create event - [POST /event](https://docs.transportial.com/apis/event/create:event.md): Create a new event ### Get events - [GET /events/{offset}/{amount}](https://docs.transportial.com/apis/event/create:events.md): Get list of events ### Get events - [POST /events/{offset}/{amount}](https://docs.transportial.com/apis/event/search:events.md): Get list of events ### Get event - [GET /event/{id}](https://docs.transportial.com/apis/event/get:event.md): Get a event on id ### Delete event - [DELETE /event/{id}](https://docs.transportial.com/apis/event/delete:event.md): Delete a event ## Timeslot Booking Endpoints for managing delivery/pickup timeslot bookings ### Create timeslot booking - [POST /timeslot-bookings](https://docs.transportial.com/apis/timeslot-booking/handle_91.md): Creates a new booking for a timeslot. Validates availability and manages capacity with optimistic locking to prevent double-booking. ### Get timeslot booking - [GET /timeslot-bookings/{id}](https://docs.transportial.com/apis/timeslot-booking/handle_111.md): Retrieves a specific booking by ID ### Cancel timeslot booking - [POST /timeslot-bookings/{id}/cancel](https://docs.transportial.com/apis/timeslot-booking/handle_235.md): Cancels a booking and frees up the timeslot capacity ### Get available timeslots - [GET /location-timeslots/available](https://docs.transportial.com/apis/timeslot-booking/handle_373.md): Retrieves available timeslots for a location within a date range. Returns slots with capacity information for date-time picker integration. ## Action Actions can be stacked and constrain different activities in their context ### Get actions - [GET /actions/{offset}/{amount}](https://docs.transportial.com/apis/action/get:actions_1.md): Get list of actions ### Get actions - [POST /actions/{offset}/{amount}](https://docs.transportial.com/apis/action/get:actions_2.md): Get list of actions ### Submit action result - [POST /action/{id}/result](https://docs.transportial.com/apis/action/submit:action:result.md): Submit questionnaire answers for an action result. Answers are validated and processed according to platform configuration, potentially updating action and consignment fields. ### Update action lifeCycle - [PUT /action/{id}/{lifeCycle}](https://docs.transportial.com/apis/action/update:actions.md): Update an actions lifeCycle, this includes all child actions ### Update action - [PUT /action](https://docs.transportial.com/apis/action/update:actions_1.md): Update a action ### Create action - [POST /action](https://docs.transportial.com/apis/action/create:action.md): Create a new action ### Get action - [GET /action/{id}](https://docs.transportial.com/apis/action/get:action.md): Get a action on id ### Delete action - [DELETE /action/{id}](https://docs.transportial.com/apis/action/delete:action.md): Delete a action ### Get action result questionnaire - [GET /action/{id}/result/questionnaire](https://docs.transportial.com/apis/action/get:action:result:questionnaire.md): Get the configured questionnaire for an action's result based on action type and platform settings ### Update action - [PUT /action/{id}/times](https://docs.transportial.com/apis/action/update:actions_2.md): Update a action ## CalendarEvent Calendar events management for vehicles, transport equipment, and chauffeurs ### Update calendar event - [PUT /calendarEvent](https://docs.transportial.com/apis/calendarevent/update:calendarevent.md): Update an existing calendar event ### Create calendar event - [POST /calendarEvent](https://docs.transportial.com/apis/calendarevent/create:calendarevent.md): Create a new calendar event ### Get calendar event - [GET /calendarEvent/{id}](https://docs.transportial.com/apis/calendarevent/get:calendarevent.md): Get a calendar event by id ### Delete calendar event - [DELETE /calendarEvent/{id}](https://docs.transportial.com/apis/calendarevent/delete:calendarevent.md): Delete a calendar event ### Search calendar events - [POST /calendarEvents/search/{offset}/{amount}](https://docs.transportial.com/apis/calendarevent/search:calendarevents.md): Search calendar events with filters ### Get calendar events - [GET /calendarEvents/{offset}/{amount}](https://docs.transportial.com/apis/calendarevent/get:calendarevents.md): Get list of calendar events ## Mail Mails can be stacked and constrain different activities in their context ### Convert mail into TransportOrder - [GET /mail/{id}/toTransportOrder](https://docs.transportial.com/apis/mail/handle_96.md): Convert a mail based on id to a TransportOrder based on the email ### Forward email - [POST /mail/{id}/forward](https://docs.transportial.com/apis/mail/handle_129.md): Forward an existing email ### Star email - [PUT /mail/{id}/star](https://docs.transportial.com/apis/mail/handle_175.md): Star or unstar an email ### Get mail - [GET /mail/{id}](https://docs.transportial.com/apis/mail/handle_229.md): Get a mail on id ### Delete mail - [DELETE /mail/{id}](https://docs.transportial.com/apis/mail/handle_505.md): Delete a mail ### Unlink email - [DELETE /mail/{id}/unlink](https://docs.transportial.com/apis/mail/handle_241.md): Remove a link between an email and a transport order or consignment ### Get linked emails - [GET /mails/linked/{entityType}/{entityId}](https://docs.transportial.com/apis/mail/handle_264.md): Get all emails linked to a specific entity (transportOrder or consignment) ### Update mail - [PUT /mail](https://docs.transportial.com/apis/mail/handle_472.md): Update a mail ### Create mail - [POST /mail](https://docs.transportial.com/apis/mail/handle_267.md): Create a new mail ### Reply to email - [POST /mail/{id}/reply](https://docs.transportial.com/apis/mail/handle_271.md): Reply to an existing email ### Unarchive mail - [GET /mail/{id}/unarchive](https://docs.transportial.com/apis/mail/handle_320.md): Unarchive a mail based on id ### Get mails - [GET /mails/{offset}/{amount}](https://docs.transportial.com/apis/mail/handle_378.md): Get list of mails ### Get mails - [POST /mails/{offset}/{amount}](https://docs.transportial.com/apis/mail/handle_500.md): Get list of mails ### Link email - [POST /mail/{id}/link](https://docs.transportial.com/apis/mail/handle_385.md): Link an email to a transport order or consignment ### Send email - [POST /mail/send](https://docs.transportial.com/apis/mail/handle_392.md): Send a new email ### Archive mail - [GET /mail/{id}/archive](https://docs.transportial.com/apis/mail/handle_436.md): Archive a mail based on id ### Get thread - [GET /mail/thread/{threadId}](https://docs.transportial.com/apis/mail/handle_475.md): Get all emails in a thread ## Fleet Fleets can be stacked and constrain different activities in their context ### Get fleets - [GET /fleets/{offset}/{amount}](https://docs.transportial.com/apis/fleet/handle_262.md): Get list of fleets ### Search fleets - [POST /fleets/{offset}/{amount}](https://docs.transportial.com/apis/fleet/handle_100.md): Get list of search based on search parameters ### Update fleet - [PUT /fleet](https://docs.transportial.com/apis/fleet/handle_176.md): Update a fleet ### Create fleet - [POST /fleet](https://docs.transportial.com/apis/fleet/create:fleet.md): Create a new fleet ### Get fleets - [GET /fleets/light](https://docs.transportial.com/apis/fleet/get:fleets.md): Get list of fleets ### Get fleet - [GET /fleet/{id}](https://docs.transportial.com/apis/fleet/get:fleet.md): Get a fleet on id ### Delete fleet - [DELETE /fleet/{id}](https://docs.transportial.com/apis/fleet/delete:fleet.md): Delete a fleet ## Tire Object describing a geographic Tire. A Tire can either be a point or an area. ### Update Tire - [PUT /tire](https://docs.transportial.com/apis/tire/handle_64.md): Update a Tire ### Create Tire - [POST /tire](https://docs.transportial.com/apis/tire/handle_216.md): Create a new Tire ### Get Tires - [GET /tires/{offset}/{amount}](https://docs.transportial.com/apis/tire/handle_349.md): Get list of Tires ### Get Tires - [POST /tires/{offset}/{amount}](https://docs.transportial.com/apis/tire/handle_104.md): Get list of Tires ### Get Tires - [GET /tires/transportEquipment/{id}/{offset}/{amount}](https://docs.transportial.com/apis/tire/handle_232.md): Get list of Tires against a TransportEquipment ### Get Tires - [GET /tires/vehicle/{id}/{offset}/{amount}](https://docs.transportial.com/apis/tire/handle_274.md): Get list of Tires against a vehicle ### Get Tire - [GET /tire/{id}](https://docs.transportial.com/apis/tire/handle_293.md): Get a Tire on id ### Delete Tire - [DELETE /tire/{id}](https://docs.transportial.com/apis/tire/handle_296.md): Delete a Tire ## Settings The user settings for the system ### Get settings - [GET /settings](https://docs.transportial.com/apis/settings/handle_130.md): Get a users settings ### Update settings - [PUT /settings](https://docs.transportial.com/apis/settings/handle_439.md): Update user settings ## Actor Actors can be stacked and constrain different activities in their context ### Get actor - [GET /actor/{id}](https://docs.transportial.com/apis/actor/get:actor.md): Get a actor on id ### Delete actor - [DELETE /actor/{id}](https://docs.transportial.com/apis/actor/delete:actor.md): Delete a actor ### Update actor - [PUT /actor](https://docs.transportial.com/apis/actor/update:actor.md): Update a actor ### Create actor - [POST /actor](https://docs.transportial.com/apis/actor/create:actor.md): Create a new actor ### Get actors - [GET /actors/{offset}/{amount}](https://docs.transportial.com/apis/actor/get:actors.md): Get list of actors ### Get actors - [POST /actors/{offset}/{amount}](https://docs.transportial.com/apis/actor/search:actors.md): Search list of actors based on query and params ## Type Types ### Update type - [PUT /type](https://docs.transportial.com/apis/type/handle_147.md): Create a new type ### Create type - [POST /type](https://docs.transportial.com/apis/type/handle_218.md): Create a new type ### Get all types - [GET /types/{offset}/{amount}](https://docs.transportial.com/apis/type/handle_319.md): Get all the types by offset and amount ### Get all types - [POST /types/{offset}/{amount}](https://docs.transportial.com/apis/type/handle_353.md): Get all the types by offset and amount ### Get type - [GET /type/{id}](https://docs.transportial.com/apis/type/handle_328.md): Get type by ID ### Delete type - [DELETE /type/{id}](https://docs.transportial.com/apis/type/handle_346.md): Delete type by ID ## Action Schedules Manage standalone operational schedules. ### Get an Action Schedule by ID - [GET /action-schedules/{id}](https://docs.transportial.com/apis/action-schedules/get:actionschedule.md) ### Delete an Action Schedule by ID - [DELETE /action-schedules/{id}](https://docs.transportial.com/apis/action-schedules/delete:actionschedule.md) ### Update an Action Schedule - [PUT /action-schedules](https://docs.transportial.com/apis/action-schedules/update:actionschedule.md) ### Create an Action Schedule - [POST /action-schedules](https://docs.transportial.com/apis/action-schedules/create:actionschedule.md): Schedules a new set of actions, such as a driver swap or vehicle maintenance. ### Get a paginated list of Action Schedules - [GET /action-schedules/{offset}/{amount}](https://docs.transportial.com/apis/action-schedules/get:actionschedules.md) ## Damage Object describing a geographic damage. A damage can either be a point or an area. ### Get damages - [GET /damages/{offset}/{amount}](https://docs.transportial.com/apis/damage/handle_286.md): Get list of damages ### Get damages - [POST /damages/{offset}/{amount}](https://docs.transportial.com/apis/damage/handle_156.md): Get list of damages ### Update damage - [PUT /damage](https://docs.transportial.com/apis/damage/handle_297.md): Update a damage ### Create damage - [POST /damage](https://docs.transportial.com/apis/damage/handle_476.md): Create a new damage ### Get damage - [GET /damage/{id}](https://docs.transportial.com/apis/damage/handle_469.md): Get a damage on id ### Delete damage - [DELETE /damage/{id}](https://docs.transportial.com/apis/damage/handle_458.md): Delete a damage ## Optimization Transport optimization endpoints for creating optimal trips and managing routes ### Re-optimize existing trips - [POST /optimization/reoptimize](https://docs.transportial.com/apis/optimization/reoptimize:trips.md): Re-optimize a set of existing trips when conditions change ### Simulate optimization - [POST /optimization/simulate](https://docs.transportial.com/apis/optimization/simulate:optimization.md): Run optimization without saving results (dry run for testing) ### Get optimization runs - [GET /optimization/runs](https://docs.transportial.com/apis/optimization/get:optimization-runs.md): Retrieve a list of optimization runs with analytics data ### Get optimization run - [GET /optimization/runs/{id}](https://docs.transportial.com/apis/optimization/get:optimization-run.md): Retrieve detailed information about a specific optimization run ### Plan optimal trips - [POST /optimization/plan](https://docs.transportial.com/apis/optimization/plan:trips.md): Create optimal trips from available resources using VRP algorithms ### Insert consignment into existing trips - [POST /optimization/insert-consignment](https://docs.transportial.com/apis/optimization/insert:consignment.md): Add a consignment to existing trips using real-time optimization ## Tachograph Tachograph methods ### Convert tachograph - [POST /tachograph/convert/binary](https://docs.transportial.com/apis/tachograph/convert:tachograph.md): Convert a new tachograph ## Contract Contracts ### Update contract - [PUT /contract](https://docs.transportial.com/apis/contract/handle_226.md): Create a new contract ### Create contract - [POST /contract](https://docs.transportial.com/apis/contract/handle_187.md): Create a new contract ### Get contract by title - [GET /contract/title/{title}](https://docs.transportial.com/apis/contract/handle_191.md): Get contract by ID ### Get contracts - [GET /contracts/{offset}/{amount}](https://docs.transportial.com/apis/contract/get:contracts.md): Get all contracts ### Search contracts - [POST /contracts/{offset}/{amount}](https://docs.transportial.com/apis/contract/search:contracts.md): Search all contracts ### Get contract - [GET /contract/{id}](https://docs.transportial.com/apis/contract/handle_498.md): Get contract by ID ### Delete contract - [DELETE /contract/{id}](https://docs.transportial.com/apis/contract/handle_438.md): Delete contract by ID ## Management The management overviews ### Get financial overview - [GET /management/financial/{administrationId}/{start}/{end}](https://docs.transportial.com/apis/management/handle_199.md): Get the financial overview ### Get operational overview - [GET /management/operational/{start}/{end}](https://docs.transportial.com/apis/management/handle_389.md): Get the operational management overview ### Get operational trip per day - [GET /management/operational/tripsPerDay/{start}/{end}](https://docs.transportial.com/apis/management/handle_453.md): Get the operational management overview ## TQL `TQL` stands for "Transportial Query Language". It's used to be able to run any query from a given JSON request ### Get fields - [GET /tql/fields/{entityType}/{keyword}/{offset}](https://docs.transportial.com/apis/tql/handle_253.md): Get list of toDos ### Execute TQL Query - [POST /tql/query](https://docs.transportial.com/apis/tql/handle_255.md): Execute a TQL query with a list result ### Get fields - [GET /tql/fields/{entityType}](https://docs.transportial.com/apis/tql/handle_337.md): Get list of toDos ### Search for fields - [GET /tql/fields/{entityType}/{keyword}/{offset}/{amount}](https://docs.transportial.com/apis/tql/handle_456.md): Get list of fields that match the given keyword ## Chauffeur Timeslots Chauffeur Timeslot API endpoints. ### Delete an exception for a specific chauffeur timeslot. - [DELETE /chauffeur-timeslots/{timeslotId}/exceptions/{exceptionId}](https://docs.transportial.com/apis/chauffeur-timeslots/deletechauffeuractivityexception.md) ### Get all exceptions for a specific chauffeur timeslot. - [GET /chauffeur-timeslots/{timeslotId}/exception](https://docs.transportial.com/apis/chauffeur-timeslots/getchauffeuractivityexceptions.md) ### Add or update an exception for a specific chauffeur timeslot. - [POST /chauffeur-timeslots/{timeslotId}/exception](https://docs.transportial.com/apis/chauffeur-timeslots/addtimeslotexception.md) ## Certificate Object describing a geographic Certificate. A Certificate can either be a point or an area. ### Get certificates for a Chauffeur - [GET /certificates/chauffeur/{id}/{offset}/{amount}](https://docs.transportial.com/apis/certificate/handle_25.md): Get list of Certificates ### Get Certificates - [GET /certificates/{offset}/{amount}](https://docs.transportial.com/apis/certificate/handle_110.md): Get list of Certificates ### Get Certificates - [POST /certificates/{offset}/{amount}](https://docs.transportial.com/apis/certificate/handle_399.md): Get list of Certificates ### Get Certificate - [GET /certificate/{id}](https://docs.transportial.com/apis/certificate/handle_459.md): Get a Certificate on id ### Delete Certificate - [DELETE /certificate/{id}](https://docs.transportial.com/apis/certificate/handle_196.md): Delete a Certificate ### Get certificates for a Business - [GET /certificates/business/{id}/{offset}/{amount}](https://docs.transportial.com/apis/certificate/handle_384.md): Get list of Certificates ### Update Certificate - [PUT /certificate](https://docs.transportial.com/apis/certificate/handle_406.md): Update a Certificate ### Create Certificate - [POST /certificate](https://docs.transportial.com/apis/certificate/handle_420.md): Create a new Certificate ## Chauffeur Calendar Events Check if a specific chauffeur is available within a date range. ### Check if a specific chauffeur is available within a date range. - [GET /chauffeurs/{chauffeurId}/available](https://docs.transportial.com/apis/chauffeur-calendar-events/ischauffeuravailable.md) ## ServiceCard Object describing a geographic ServiceCard. A ServiceCard can either be a point or an area. ### Update ServiceCard - [PUT /serviceCard](https://docs.transportial.com/apis/servicecard/handle_186.md): Update a ServiceCard ### Create ServiceCard - [POST /serviceCard](https://docs.transportial.com/apis/servicecard/handle_7.md): Create a new ServiceCard ### Get ServiceCard - [GET /serviceCard/{id}](https://docs.transportial.com/apis/servicecard/handle_49.md): Get a ServiceCard on id ### Delete ServiceCard - [DELETE /serviceCard/{id}](https://docs.transportial.com/apis/servicecard/handle_107.md): Delete a ServiceCard ### Get ServiceCards - [GET /serviceCards/chauffeur/{id}/{offset}/{amount}](https://docs.transportial.com/apis/servicecard/handle_52.md): Get list of ServiceCards ### Get ServiceCards - [GET /serviceCards/{offset}/{amount}](https://docs.transportial.com/apis/servicecard/handle_63.md): Get list of ServiceCards ### Get ServiceCards - [POST /serviceCards/{offset}/{amount}](https://docs.transportial.com/apis/servicecard/handle_421.md): Get list of ServiceCards ## Ban Object describing a geographic Ban. A Ban can either be a point or an area. ### Get bans filtered by business - [GET /bans/business/{id}/{offset}/{amount}](https://docs.transportial.com/apis/ban/handle_85.md): Get list of Bans ### Get Ban - [GET /ban/{id}](https://docs.transportial.com/apis/ban/handle_86.md): Get a Ban on id ### Delete Ban - [DELETE /ban/{id}](https://docs.transportial.com/apis/ban/handle_236.md): Delete a Ban ### Get Bans - [GET /bans/{offset}/{amount}](https://docs.transportial.com/apis/ban/handle_122.md): Get list of Bans ### Get Bans - [POST /bans/{offset}/{amount}](https://docs.transportial.com/apis/ban/handle_510.md): Get list of Bans ### Get bans filtered by chauffeur - [GET /bans/chauffeur/{id}/{offset}/{amount}](https://docs.transportial.com/apis/ban/handle_123.md): Get list of Bans ### Get bans filtered by actor - [GET /bans/actor/{id}/{offset}/{amount}](https://docs.transportial.com/apis/ban/handle_311.md): Get list of Bans ### Update Ban - [PUT /ban](https://docs.transportial.com/apis/ban/handle_418.md): Update a Ban ### Create Ban - [POST /ban](https://docs.transportial.com/apis/ban/handle_450.md): Create a new Ban ## Alert ### Ignore alert - [PUT /alert/{id}/ignore](https://docs.transportial.com/apis/alert/handle_19.md): Ignore a alert on id ### Solve alert - [PUT /alert/{id}/solve](https://docs.transportial.com/apis/alert/handle_54.md): Solve a alert on id ### Get alerts - [GET /alerts](https://docs.transportial.com/apis/alert/handle_56.md): Get list of alerts ### Get entities alerts - [POST /alerts](https://docs.transportial.com/apis/alert/handle_444.md): Get entities list of alerts ### Get alerts - [GET /alerts/{entityType}/{entityId}](https://docs.transportial.com/apis/alert/handle_93.md): Get list of alerts ### Get alerts - [GET /alerts/{entityType}/{entityId}/{offset}/{amount}](https://docs.transportial.com/apis/alert/handle_200.md): Get list of alerts ### Get alert - [GET /alert/{id}](https://docs.transportial.com/apis/alert/handle_242.md): Get a alert on id