En utilisant notre API pour planifier les livraisons, vous pouvez par exemple permettre à vos clients de planifier une livraison tout en finalisant un achat sur votre site web. Cela réduit le nombre de fois que vous devez interagir avec vos clients et offre une expérience agréable et intégrée.
Aperçu
- Mise en place dans Urbantz
- Documentation API
- Processus
1. Mise en place dans Urbantz
La planification de livraisons par API nécessite l’existence d’un Flux de type Planning. Vous trouverez des informations détaillées dans cet article à ce sujet.
2. Documentation API
Notre documentation API est disponible ici et comprend quatre sections appelées "Get timeslots" (créneaux horaires), "Reserve a timeslot" (réservation de créneau horaire), "Confirm a reservation" (confirmer une réservation) et "Cancel a reservation" (Annuler une réservation) qui sont à consulter pour la planification par API.
3. Processus
L’illustration ci-dessous montre le processus de planification par API.
Votre service peut, par exemple lors de la validation d'une commande sur votre site web, envoyer une demande de disponibilité de créneau horaire à Urbantz. Cette requête doit contenir certains paramètres particuliers spécifiés dans notre documentation API. Urbantz retournera une liste de créneaux horaires disponibles avec un ensemble d’informations, parmi lesquelles un identifiant de créneau horaire et une configuration, un entrepôt et les caractéristiques de départ et d'arrêt qui doivent être utilisés plus tard pour réserver un créneau horaire, ainsi que des informations sur la capacité déjà utilisée.
La réservation d’un créneau horaire est la prochaine étape. Lors de cette étape de la capacité sera réservée, mais aucune tâche ne sera créée. Urbantz retournera entre autres un "numéro de réservation" (timeslotReservationId) correspondant à la plage horaire choisie qui devra être utilisé lors de l'annonce effective de la tâche.
ℹ️ Les réservations ne sont pas affichées dans Urbantz. Ces informations ne sont disponibles qu’à l’aide de requêtes API.
Une fois que votre client a finalisé son achat sur votre site web, vous pouvez procéder à une annonce de tâche en utilisant le "numéro de réservation" (timeslotReservationId).
La réservation sera transformée en tâche, et les méthodes habituelles pour changer les propriétés de la tâche s’appliquent désormais (supprimer, mettre à jour etc.).
❗️ Si le processus d’achat est abandonné par votre client, les créneaux horaires doivent activement être libérés en utilisant l’identifiant de réservation, sinon, la capacité restera bloquée. Il n’y a pas de processus de libération automatique de créneaux.
ℹ️ Si voulu, une réservation peut être forcée pour surcharger une plage horaire, par exemple, si plusieurs clients essaient de réserver la même tranche horaire, mais qu'il n’y a de la capacité que pour une seule.
Ce paramètre est par défaut 'false', changez-le en 'true' si opérationnellement parlant vous avez la capacité de surcharger des plages horaires.
Consultez également notre documentation API sur la réservation de créneaux horaires ici.