Tour

Die Tour fast alle für die Erfüllung von N Sendungen notwendigen Informationen zusammen. Neben den Sendungen, sind das Informationen zum Fahrzeug/Anhänger, Fahrer, Zeitspanne und Ausführungsdatum, Stopps, Transportpunkte (inkl. Aufgaben für den Fahrer) sowie Checklisten und Vorkommnisse der ganzen Tour.

Abhängig davon ob im Kundensystem Verkaufsaufträge mit einer Tour referenziert werden oder nicht können Informationen zur Erfüllung der Sendungen auch einzeln von GET Shipment abgeholt werden.

In aller Regel wird nur der GET tour Request benötigt, je nach Workflow können die calculateTour und releaseTour Endpunkte Sinn machen, Touren über POST tour anzulegen wird nicht empfohlen. In dem Falle sollte besser mit Rahmentouren und automatischer Generierung bei Import gearbeitet werden. Das erlaubt auch den Disponenten noch spontan bereits richtig aufgesetzte Touren hinzuzufügen.

Neben den GET Endpunkten können im Enpunkt Tour auch diverse tourspezifische Aktionen ausgelöst werden, wie das berechnen, optimieren oder freigeben einer Tour.

Endpunkte

POST /x4gateway/v1/import/tour

sowie
GET /x4gateway/v1/import/tour/{id} --> normaler GET Request mittels ID
GET /x4gateway/v1/import/tour --> GET Request mittels RefID
GET /x4gateway/v1/import/tour/getId/{refId} --> Tour-ID anhand Tour-RefID ausfindig machen
GET /x4gateway/v1/import/tour/getshipments --> liefert nur die in der Tour enthaltenen Sendungen zurück. Veraltet, besser über GET tour oder Endpunkt Shipment.
PUT /x4gateway/v1/import/tour --> UPDATE Request mittels ID oder RefID
DELETE /x4gateway/v1/import/tour/{id} --> normaler DELETE Request mittels ID

weitere Endpunkte für Touraktionen:
POST /x4gateway/v1/import/tour/{id}/appendShipment --> die mitgesendete Sendung wird der Tour zugewiesen
POST /x4gateway/v1/import/tour/{id}/appendShipments --> die mitgesendeten Sendungen werden der Tour zugewiesen
POST /x4gateway/v1/import/tour/allocateShipmentsToTour --> falls die Sendungen bereits importiert wurden können sie mittels ID's zugewiesen werden
POST /x4gateway/v1/import/tour/{id}/calculateTour --> löst die Berechnung der Tour aus (Responsetime kann je nach Komplexität mehrere Minuten betragen)
POST /x4gateway/v1/import/tour/calculateTours --> löst die Berechnung aller Touren mittels Tourdatum aus (Responsetime kann je nach Komplexität mehrere Minuten betragen)
POST /x4gateway/v1/import/tour/{id}/optimizeTour --> --> löst die Optimierung der Tour aus (Responsetime kann je nach Komplexität mehrere Minuten betragen)
POST /x4gateway/v1/import/tour/optimizeTours --> löst die Optimierung aller Touren mittels Tourdatum aus (Responsetime kann je nach Komplexität mehrere Minuten betragen)
POST /x4gateway/v1/import/tour/{id}/releaseTour --> löst die Tourfreigabe aus
POST /x4gateway/v1/import/tour/{id}/unreleaseTour --> löst die Tourrücknahme aus

Request

{
	"refId": "string",
	"name": "string",
	"note": "string",
	"driverId": "string",						//in der Regel entweder per ID
	"driverRefId": "string",					//oder per RefID, nicht benötigt
	"driver": {},								//wenn der Fahrer als Objekt referenziert wird
	"vehicle": {},
	"trailer": {},
	"shipments": [{}],						//alle in der Tour enthaltenen Sendungen werden als neue Sendungen angelegt
	"startVehiclePoi": {},						//Fahrzeugstandort Start
	"endVehiclePoi": {},						//Fahrzeugstandort Ende
	"startDepotPoi": {},						//Startdepot
	"endDepotPoi": {},						//Enddepot
	"fixedTourStartTime": "2026-02-27T07:12:42.636Z",
	"fixStartTime": "string",					//in Minuten
	"earliestTourStart": "string",				//in Minuten
	"latestTourEnd": "string",					//in Minuten
	"pickupDate": "2026-02-27T07:12:42.636Z",
	"fromDate": "2026-02-27T07:12:42.636Z",
	"tillDate": "2026-02-27T07:12:42.636Z",
	"generationModel": 0,						//Tourgenerationsmodell
	"isCommissioned": true,					//eine kommissionierte Tour kann nicht berechnet oder optimiert werden
	"attachments": [{}]
}

Verwendete Enum's: Tourgenerierungsmodell.

Response

Die Response-Struktur ist analog der Request-Struktur, und alle Informationen welche im POST gesendet wurden, sowie vom System ergänzte Informationen, werden zurückgemeldet.

Dabei ist die ID / Tour-ID eine wichtige Information, die ideallerweise im Vorsystem gemerkt wird.