Comprendre l'API du Cigo Tracker : Un Guide Essentiel

Un Travail est un terme général utilisé dans Cigo Tracker pour décrire une destination, comme un Client, où vos Opérateurs peuvent effectuer une livraison, un appel de service, une installation, ou diverses Actions de Travail (voir l'explication sur 'Action de Travail' ci-dessous).

Lorsqu'un travail est créé via l'API, sa valeur de statut initiale est en attente. Si vous vous connectez à Cigo, vous pouvez trouver ce travail en ouvrant le menu latéral et en naviguant vers la page de l'Outil d'Importation. Une fois sur la page de l'Outil d'Importation, vous trouverez vos enregistrements créés par l'API sous l'onglet 'Revoir les enregistrements de l'Intégration API'.

Le dispatcheur utilisera généralement l'Outil d'Importation pour valider et examiner les travaux à venir avant de les dispatcher aux véhicules. En un coup d'œil, il peut vérifier si l'adresse de chaque travail sera correctement géocodée et si la chaîne d'adresse est valide.

Cependant, si cette étape n'est pas nécessaire pour votre intégration, vous pouvez ignorer l'Outil d'Importation lors de la création d'un travail via l'API en définissant skip_staging sur true (pour plus de détails, reportez-vous à la section POST Créer un nouveau travail).

La gestion efficace des processus de travail est essentielle pour garantir des opérations fluides au sein de toute entreprise de logistique ou de livraison. Cigo Tracker offre un système complet pour surveiller et gérer le statut des travaux, répondant aux besoins nuancés de telles entreprises. Les statuts de travail dans Cigo Tracker reflètent le cycle de vie d'un travail de sa création à son achèvement, démontrant une transparence et un contrôle à chaque étape.

Un travail peut se voir attribuer un nombre quelconque d'Actions. Ces Actions servent de liste de tâches pour l'Opérateur arrivant sur site (par exemple, chez un client). Les Actions ont des types (par exemple, livraison, installation, service, etc.) et d'autres attributs, tels que le temps de manipulation (le temps estimé pour réaliser l'action).

Les statuts des actions de travail varient de :

Lorsque vous créez un nouveau travail, un profil Client existant est soit lié, soit créé. Les profils clients sont créés ou mis à jour en fonction des champs de prénom, de nom, de numéro de téléphone et d'adresse d'un Travail.

Lorsque vous créez un Travail pour la première fois, vous pouvez lui attribuer un Identifiant de Référence Client. Lorsque vous créez de nouveaux Travaux attribués au même Identifiant de Référence Client, ils resteront tous associés au même Client.

Non, vous ne pouvez pas. Dans l'interface web, il y a quelques éléments que vous pouvez mettre à jour sur un profil client existant, mais cela n'est actuellement pas disponible via l'API.

Afin de prévenir l'entrée de commandes en double dans Cigo Tracker, nous empêchons la saisie de commandes avec les mêmes informations de base. Par exemple, si vous avez une commande avec le même prénom, nom, adresse et date de livraison, nous la détectons comme un travail en double et empêchons sa création.

Ce comportement par défaut peut ne pas convenir à votre entreprise si vous pouvez recevoir plusieurs commandes par jour du même client. Dans ce cas, définir un identifiant de référence unique lors du processus de création du Travail vous permettra de contourner cette restriction. Si vous disposez d'un identifiant de commande unique provenant d'un système externe (par exemple, Shopify), vous pouvez l'utiliser dans votre champ reference_id, et Cigo Tracker ignorera la vérification des doublons.

Si vous n'avez pas spécifié skip_staging : true dans votre appel POST pour créer un Travail, il sera créé dans le staging status.

Vous ne pourrez trouver ce Travail qu'en vous connectant au portail web de Cigo Tracker, en ouvrant le menu latéral et en naviguant vers la page de l'Outil d'Importation. Une fois sur la page de l'Outil d'Importation, vous trouverez vos enregistrements de Travail créés sous l'onglet 'Revoir les enregistrements de l'Intégration API'.

Les prises en charge et les dépôts sont générés automatiquement par Cigo Tracker. Chaque prise en charge et chaque dépôt sont directement liés à une action de travail grâce à son identifiant d'emplacement d'arrêt stop_location_id.

Par exemple, si une tâche a une action de type 'prise en charge' avec un identifiant d'emplacement d'arrêt stop_location_id valide, une fois qu'un itinéraire est créé par votre répartiteur, une prise en charge sera automatiquement générée pour indiquer qu'elle doit être effectuée avant la tâche liée.

Un itinéraire est une liste détaillée d'arrêts de route ordonnés, comprenant son point de départ initial et son point de retour final, l'heure de départ estimée, ainsi que l'opérateur(s) et le véhicule assignés.

Un arrêt, ou arrêt de route, est simplement un emplacement géographique sur un itinéraire et peut être soit un travail, un enlèvement ou une livraison.

Un Opérateur est une personne assignée à un Itinéraire. Par exemple, si votre entreprise s'occupe de la livraison de marchandises, vous pourriez déjà les appeler en interne "Chauffeurs", contrairement aux "Techniciens" dans d'autres industries. Les Opérateurs interagissent avec Cigo Tracker via notre application mobile.

Un Dispatcher est un utilisateur de la plateforme web qui peut créer des itinéraires, des emplois (jobs) et des actions, et qui a un accès direct à la zone de staging (à l'intérieur de Cigo Tracker, la zone de staging est appelée "l'Import Tool").

Pour clarification, la majorité des valeurs de temps et de date-heure de l'API sont présentées en GMT (UTC+00:00), sauf indication contraire.

Découvrez ce diagramme illustrant les concepts clés, offrant une représentation visuelle de la manière dont les ressources et les relations entre les concepts expliqués sont interconnectées.