1. Introduction
L'endpoint Delivery History permet aux utilisateurs de Woop d'obtenir tous les évènements de livraison associés à une commande donnée afin d'obtenir une exhaustivité des données.
2. Valeur Métier
✅ Amélioration de la transparence : Permet d’accéder à l’historique complet des événements de livraison d’une commande, renforçant la visibilité pour vous et les équipes logistiques.
✅ Optimisation du service client : En fournissant un suivi détaillé des statuts de livraison, les équipes support peuvent réagir plus rapidement aux demandes et réduire le nombre de réclamations.
✅ Réduction des coûts opérationnels : Une meilleure traçabilité des commandes diminue les erreurs, les litiges et les renvois inutiles, optimisant ainsi la logistique et les coûts associés.
✅ Expérience client améliorée : Grâce à un suivi précis et accessible via API, les clients bénéficient d’une expérience fluide et rassurante.
3. Endpoint API
Méthode : GET
URL : /orders/{{externalOrderId}}/deliveries/{{externalDeliveryId}}/events
4. Paramètres de requête (Query Params)
| Nom | Type | Description |
|---|---|---|
orderId |
string | Identifiant unique de la commande |
deliveryId |
string | Identifiant unique de la livraison |
5. Réponse de l'API
La réponse est un objet JSON contenant les détails de la livraison et son historique d'événements.
Exemple de réponse
{
"deliveryId": "string",
"orderId": "string",
"carrierName": "string",
"trackingUrl": "string", // (optionnel)
"events": [
{
"status": "string",
"subStatus": "string", // (optionnel)
"carrierEvent": "string", // (optionnel)
"date": "Date",
"comment": "string", // (optionnel)
"appointment": "string", // (optionnel)
"additionalData": "string", // (optionnel)
"team": "string" // (optionnel)
}
],
"parcelsEvents": [ // (optionnel)
[
{
"parcelId": "string",
"carrierEvent": "string",
"carrierCode": "string",
"comment": "string", // (optionnel)
"origin": "API",
"date": "2025-02-14T13:57:01.202Z"
}
]
]
}6. Description des champs de réponse
6.1 Champs principaux
| Champ | Type | Description |
deliveryId |
string | Identifiant unique de la livraison |
orderId |
string | Identifiant unique de la commande |
carrierName |
string | Nom du transporteur |
trackingUrl |
string | URL de suivi de la commande (optionnel) |
events |
array | Liste des événements de la livraison |
parcelsEvents |
array | Liste des événements liés aux colis (optionnel) |
6.2 Structure des événements (events)
| Champ | Type | Description |
status |
string | Statut de la livraison |
subStatus |
string | Sous-statut de la livraison (optionnel) |
carrierEvent |
string | Événement déclaré par le transporteur (optionnel) |
date |
Date | Date de l'événement |
comment |
string | Commentaire associé à l'événement (optionnel) |
appointment |
string | Rendez-vous de livraison (optionnel) |
additionalData |
string | Données supplémentaires (optionnel) |
team |
string | Équipe en charge de l'événement (optionnel) |
6.3 Structure des événements de colis (parcelsEvents)
| Champ | Type | Description |
parcelId |
string | Identifiant du colis |
carrierEvent |
string | Événement du transporteur |
carrierCode |
string | Code du transporteur |
comment |
string | Commentaire de l'événement (optionnel) |
origin |
string | Source de l'événement (ex: API) |
date |
Date | Date de l'événement |
7. Conclusion
Cet endpoint permet aux utilisateurs de Woop d'accéder à une traçabilité complète des livraisons et des colis associés à une commande. Il facilite ainsi le suivi des statuts, l'optimisation de la logistique et l'amélioration de l'expérience client.