Suivi d'une lettre
Renvoie l'ensemble des étapes de distribution connues pour un courrier, de la plus récente à la plus ancienne.
Le suivi est uniquement disponible pour les affranchissements relatifs à un courrier suivi. Ces affranchissements sont les suivants :
- Lettre recommandée (simple ou avec accusé de réception)
- Lettre verte avec suivi
- Lettre performance avec suivi
Les informations de suivi regroupent à la fois les étapes franchies chez nous (validation de la prise en compte de la commande et de la matérialisation de votre courrier) puis l'ensemble des étapes franchies côté La Poste une fois votre courrier déposé dans le circuit de distribution.
Vous trouverez l'ensemble de ces étapes dans le champ "événements" en allant à droite dans la partie "Response samples" et en cliquant sur "Expand all".
➤ Vous pouvez très bien consulter manuellement le statut d'une lettre en allant sur le site de La Poste et en tapant son numéro de suivi (par exemple : 2C16296102784, car l'UID est un identifiant propre à Service Postal). A savoir : chez La Poste, les informations sont accessibles pendant 2 mois, puis disparaissent. Chez Service Postal, nous conservons vos informations de suivi sans limite de temps, pour l'ensemble des courriers de nos clients API.
🕵 La tentation, avec un tel endpoint, est de l'appeler à intervalles réguliers pour savoir si le statut d'un courrier a changé, et ce pour l'ensemble de vos courriers en cours. Nous déconseillons ce genre de pratique, pour plusieurs raisons :
- cela fait peser de la charge inutile côté infrastructure hébergeant l'API
- cela oblige à émettre des appels HTTP côté client pour lesquels l'énorme majorité d'entre eux seront infructueux (pas de changement de statut)
- nous disposons d'un service de webhook dédié à ce cas d'usage !
Request
- Base URL: https://sandbox-api.servicepostal.com
- URL: https://sandbox-api.servicepostal.com/lettres/{uid}/suivi
- Auth: none declared
Path parameters
L'uid de la lettre
Response
Opération réussie
Example response
{
"numero_suivi_laposte": "2C17299359124",
"evenements": [
{
"date_statut": "26-05-2023 00:00:00",
"code_statut": "pris_en_charge",
"type_statut": "la_poste",
"message_statut": "Pris en charge"
},
{
"date_statut": "26-05-2023 00:00:00",
"code_statut": "pris_en_charge",
"type_statut": "la_poste",
"message_statut": "En cours de traitement"
},
{
"date_statut": "26-05-2023 00:00:00",
"code_statut": "attente_retrait_guichet",
"type_statut": "la_poste",
"message_statut": "Attend d'être retiré au guichet"
},
{
"date_statut": "26-05-2023 00:00:00",
"code_statut": "distribue_destinataire_en_lot",
"type_statut": "la_poste",
"message_statut": "Distribué en lot au destinataire"
},
{
"date_statut": "26-05-2023 00:00:00",
"code_statut": "distribue_destinataire",
"type_statut": "la_poste",
"message_statut": "Distribué au destinataire"
},
{
"date_statut": "26-05-2023 00:00:00",
"code_statut": "distribue_expediteur",
"type_statut": "la_poste",
"message_statut": "Distribué à l'expéditeur"
},
{
"date_statut": "26-05-2023 00:00:00",
"code_statut": "retour_expediteur",
"type_statut": "la_poste",
"message_statut": "Retourné à l'expéditeur"
},
{
"date_statut": "26-05-2023 00:00:00",
"code_statut": "ar_scanne",
"type_statut": "service_postal",
"message_statut": "AR scanné par Service Postal",
"pnd": false,
"url": "<URL de votre AR scanné en Jpeg>"
},
{
"date_statut": "26-05-2023 00:00:00",
"code_statut": "courrier_produit",
"type_statut": "service_postal",
"message_statut": "Courrier imprimé et produit par Service Postal"
},
{
"date_statut": "26-05-2023 00:00:00",
"code_statut": "soumis",
"type_statut": "service_postal",
"message_statut": "Courrier soumis à Service Postal"
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.