Tournée

La tournée regroupe toutes les informations nécessaires à l'exécution de N envois. Outre les envois, cela comprend les informations sur le véhicule/remorque, le chauffeur, la période et la date d'exécution, les arrêts, les points de transport (y compris les tâches pour le chauffeur) ainsi que les listes de contrôle et les incidents de toute la tournée.

Selon que les commandes clients dans le système client sont référencées à une tournée ou non, les informations d'exécution des envois peuvent également être récupérées individuellement via GET Shipment.

En règle générale, seule la requête GET tour est nécessaire. Selon le workflow, les endpoints calculateTour et releaseTour peuvent être pertinents. La création de tournées via POST tour n'est pas recommandée — il est préférable de travailler avec des tournées cadres et la génération automatique lors de l'import, ce qui permet aussi aux dispatchers d'ajouter spontanément des tournées déjà correctement configurées.

En plus des endpoints GET, l'endpoint tour permet également de déclencher diverses actions spécifiques à la tournée, comme le calcul, l'optimisation ou la libération d'une tournée.

Endpoints

POST /x4gateway/v1/import/tour

ainsi que
GET /x4gateway/v1/import/tour/{id} --> requête GET normale via ID
GET /x4gateway/v1/import/tour --> requête GET via RefID
GET /x4gateway/v1/import/tour/getId/{refId} --> trouver l'ID tournée via RefID tournée
GET /x4gateway/v1/import/tour/getshipments --> retourne uniquement les envois contenus dans la tournée. Obsolète, mieux utiliser GET tour ou l'endpoint Shipment.
PUT /x4gateway/v1/import/tour --> requête UPDATE via ID ou RefID
DELETE /x4gateway/v1/import/tour/{id} --> requête DELETE normale via ID

Endpoints supplémentaires pour les actions sur la tournée :
POST /x4gateway/v1/import/tour/{id}/appendShipment --> l'envoi transmis est assigné à la tournée
POST /x4gateway/v1/import/tour/{id}/appendShipments --> les envois transmis sont assignés à la tournée
POST /x4gateway/v1/import/tour/allocateShipmentsToTour --> si les envois ont déjà été importés, ils peuvent être assignés via leurs IDs
POST /x4gateway/v1/import/tour/{id}/calculateTour --> déclenche le calcul de la tournée (le temps de réponse peut être de plusieurs minutes selon la complexité)
POST /x4gateway/v1/import/tour/calculateTours --> déclenche le calcul de toutes les tournées via date de tournée (le temps de réponse peut être de plusieurs minutes)
POST /x4gateway/v1/import/tour/{id}/optimizeTour --> déclenche l'optimisation de la tournée (le temps de réponse peut être de plusieurs minutes)
POST /x4gateway/v1/import/tour/optimizeTours --> déclenche l'optimisation de toutes les tournées via date de tournée (le temps de réponse peut être de plusieurs minutes)
POST /x4gateway/v1/import/tour/{id}/releaseTour --> déclenche la libération de la tournée
POST /x4gateway/v1/import/tour/{id}/unreleaseTour --> déclenche le rappel de la libération

Request

{
	"refId": "string",
	"name": "string",
	"note": "string",
	"driverId": "string",						//en général soit par ID
	"driverRefId": "string",					//soit par RefID, non requis
	"driver": {},								//lorsque le chauffeur est référencé comme objet
	"vehicle": {},
	"trailer": {},
	"shipments": [{}],						//tous les envois contenus dans la tournée sont créés comme nouveaux envois
	"startVehiclePoi": {},						//lieu de départ du véhicule
	"endVehiclePoi": {},						//lieu de fin du véhicule
	"startDepotPoi": {},						//dépôt de départ
	"endDepotPoi": {},						//dépôt de fin
	"fixedTourStartTime": "2026-02-27T07:12:42.636Z",
	"fixStartTime": "string",					//en minutes
	"earliestTourStart": "string",				//en minutes
	"latestTourEnd": "string",					//en minutes
	"pickupDate": "2026-02-27T07:12:42.636Z",
	"fromDate": "2026-02-27T07:12:42.636Z",
	"tillDate": "2026-02-27T07:12:42.636Z",
	"generationModel": 0,						//modèle de génération de tournée
	"isCommissioned": true,					//une tournée commissionnée ne peut être ni calculée ni optimisée
	"attachments": [{}]
}

Énumérations utilisées : Modèle de génération de tournée.

Response

La structure de la réponse est analogue à la structure de la requête ; toutes les informations envoyées dans le POST ainsi que les informations complétées par le système sont renvoyées.

L'ID / l'ID tournée est une information importante qui devrait idéalement être mémorisée dans le système source.