Tracking

Les URLs publiques de suivi de livraison

IMX met à disposition de ses clients le site https://suivi.imxpostal.fr qui permet, après authentification, de récupérer le suivi de l’ensemble des colis confiés à IMX, avec des fonctionnalités de filtre (par statut de livraison, par pays, par date, etc.) et d’exportation au format Excel.

IMX met également à disposition de ses clients des URLS publiques permettant un suivi individuel, colis par colis. Ces URLS sont publiques, elles ne requièrent pas d’authentification. De ce fait, elle ne donnent pas d’informations confidentielles comme les noms et adresses des destinataires.

Ces adresses sont construites :

• soit à partir d’un préfixe de quatre lettres, qui est une contraction de votre code client (fourni par IMX) et de votre propre référence pour le colis. Par exemple, l’url HTML du colis du client TEST ayant comme référence 2011521268112 est https://suivi.imxpostal.fr/colis/suivi/TEST2011521268112/html/. Ce type d'URL n'est pas conseillé si le client ne peut garantir l'unicité de la référence client ou dans le cas de process internes impliquant des appels multiples au webservice IMX pour la même référence ;
• soit à partir de l’identifiant IMX (numérique, sept ou huit chiffres). Cet identifiant est disponible dans le champ tracking_data.imx_tracking_id de la réponse du webservice d'annonce de colis. Par exemple, l’url HTML du colis ayant comme référence interne chez IMX 8805170 est : https://suivi.imxpostal.fr/colis/suivi/8805170/html/

La partie suivante de l'URL est construite avec quatre modalités :

• html
• redirect
• redirect2
• json

Le json est un format informatique pour la mise à jour de systèmes d'information. Les trois autres formats sont destinés à la construction d'URLs à transmettre au client final.

Format HTML

Le suivi est disponible sous format HTML, et disponible dans les langues suivantes en français, anglais, allemand, italien ou polonais. Le choix de la langue est automatique en fonction des préférences du navigateur mais peut être forcé en rajoutant le code iso-2 de la langue en bout d'URL.

• langue du navigateur : https://suivi.imxpostal.fr/colis/suivi/9920436/html/
• anglais forcé : https://suivi.imxpostal.fr/colis/suivi/9920436/html/en/
• allemand forcé : https://suivi.imxpostal.fr/colis/suivi/9920436/html/de/

Par défaut, cette page s'affiche avec un logo IMX. Il est possible de la personnaliser pour se rappocher de la chartre graphique du client avec les éléments suivants :

• un logo, qui sera traité pour un rendu avec 100px de hauteur ;
• une feuille de style basique ;
• un texte de pied de page (un texte par langue).

Format redirect

Ce format ne correspond pas à une page construite et hebergée chez IMX France. Il s'agit d'une redirection HTTP vers le site de tracking du distributeur du colis le plus proche possible du client final.

Si le numéro du distributeur est disponible et qu’un suivi en ligne est disponible, l’URL redirige de façon transparente vers le site du distributeur. Dans le cas contraire, l’URL renvoie le suivi HTML disponible sur suivi.imxpostal.fr.

Exemple : https://suivi.imxpostal.fr/colis/suivi/TEST2011521268112/redirect/

Supposont que le colis correspond à celle URL (le colis référence 2011521268112 du client TEST) ait été confié à Colissimo, qui l'a traité sous le numéro 9L000123483. Dans ce cas, l'URL précédente est un redirection permanente vers l'url :

https://www.laposte.fr/outils/suivre-vos-envois?code=9L000123483

Cette redirection garantie une information locale mais, dans le cas d'une expédition internationale, le distributeur final peut ne prendre connaissance du colis qu'après passage de frontière, avec le risque d'afficher pendant un certain temps une information type "colis inconnu".

Pour palier ce défaut, nous conseillons à nos clients d'utiliser plutôt le format redirect2.

Format redirect2

Ce format est un hybride entre les deux précédents. Il renvoie :

• une page hébergée par IMX France tant que le colis n'est pas encore transmis à un distributeur disposant de sa propre source de tracking.
• une redirection vers le site du distributeur dès que le premier scan de ce distributeur est connu par IMX.

Le suivi est donc immédiatement disponible dès la déclaration du colis chez IMX, mais il est transféré à un distributeur proche du destinataire dès que possible.

Le format redirect2 est équivalent au format html (avec les mêmes possibilités de personnalisation) en début de parcours du colis, et au format redirect en fin de parcours.

Format JSON

Le suivi est également disponible sous format JSON, encodé en UTF-8, pour les traitements automatisés.

{
    "colis": [
        {
            "id": "7893814",
            "reference": "7892555",
            "statut": "a quitté le centre de tri d'IMX",
            "statut_code": "cc2",
            "date_statut": "2020-09-03 09:05:45",
            "carrier": "colissimo_ftl_access",
            "carrier_statut_code_1": null,
            "carrier_statut_code_2": null,
            "carrier_statut_code_3": null,
            "carrier_statut_description": null,
            "tracking_events": [
                {
                    "statut": "a quitté le centre de tri d'IMX",
                    "statut_code": "cc2",
                    "date_statut": "2020-09-03 09:05:45",
                    "carrier_code_1": null,
                    "carrier_code_2": null,
                    "carrier_code_3": null,
                    "carrier_description": null,
                    "carrier_descripion": null
                },
                {
                    "statut": "est prêt à quitter le centre de tri d'IMX",
                    "statut_code": "cc",
                    "date_statut": "2020-09-02 11:24:06",
                    "carrier_code_1": null,
                    "carrier_code_2": null,
                    "carrier_code_3": null,
                    "carrier_description": null,
                    "carrier_descripion": null
                }
            ],
            "tracking_summary": {
                "tracking_url": "",
                "warnings": false,
                "event_datetimes": {
                    "ordered": "2020-09-02T11:13:50.165664",
                    "collected": null,
                    "in-imx-hub": "2020-09-02T11:24:06.573324",
                    "leaving-imx-hub": null,
                    "notified": null,
                    "back-to-sender": null,
                    "delivered": null
                }
            }
        }
    ]
}

Exemples

• https://suivi.imxpostal.fr/colis/suivi/TEST7892555/json/ pour un appel avec préfixe client et référence
• https://suivi.imxpostal.fr/colis/suivi/7893814/json/ pour un appel avec l'identifiant SMC.

Structure de la réponse

L'objet JSON renvoyé contient une unique clé colis correspondant à la liste des colis matchant l'identifiant ou la référence donné dans l'URL. En règle générale, cette liste contient un unique élément.

Les champs disponibles pour chaque colis sont :

• id : identifiant IMX du colis
• reference : identifiant client du colis
• statut_code : code indiquant le dernier statut ou événement du colis (voir référence infra)
• statut : libellé du dernier statut ou événement, dans la langue par défaut du navigateur. Par défaut, pour les programmes d’automation type curl ou wget, il s’agit de l’anglais.
• date_statut : date du dernier statut ou événement, au format YYYY-mm-dd HH:MM:SS
• carrier : code identifiant le partenaire d'IMX chargé de la distribution
• carrier_statut_code_1: code de tracking du partenaire distributeur
• carrier_statut_code_2: éventuel code secondaire de tracking du partenaire distributeur
• carrier_statut_code_3: éventuel code tertiaire de tracking du partenaire distributeur
• carrier_statut_description: descriptif du statut de distribution du partenaire
• tracking_events : liste de l'intégralité des évenements ou statuts disponibles pour le colis, dans l'ordre chronologique inversé. Les champs disponibles sont:
  • carrier_code_1, carrier_code_1, carrier_code_1: code de tracking du partenaire distributeur
  • date_statut: date de l'événement ou du statut, au format YYYY-mm-dd HH:MM:SS
  • statut: libellé du statut ou événement
  • statut_code: code du statut ou de l'événement (voir référence infra)
• tracking_summary : objet contenant des données d'historique de suivi du colis, sous forme normalisée. Il contient :
  • warnings: indique si le colis est dans un état d'anomalie
  • tracking_url: URL de tracking. IMX essaye de fournir l'URL du distributeur local quand celle-ci est disponible
  • event_datetimes: objet contenant les dates fonctionnelles du colis (voir référence infra des événements normalisés). Si la date est null, l'événement ne s'applique pas au colis, ou celui-ci ne s'est pas encore appliqué.

Liste des statuts

Les statuts disponibles sont les suivants :

Code	Description
c0	Erreur
ca	Annoncé client
ca0	Traité par le client
ca1	Départ Hub client
ca2	Retenu douanes
ca3	Douanes OK
cb	Réceptionné IMX
cc	Traité IMX
cc2	Départ IMX
cc3	Remise distributeur local
cc4	Remise distributeur local (c4)
cc5	Remise distributeur local (c5)
cd	En cours de livraison
ce	Destinataire avisé
cj	Déposé en relais par l'expéditeur
ck	Collecté à domicile
cu	Mis à disposition en relais
cp0	Contre-temps livraison
cp1	Perdu-Volé-Détruit
cp3	NPAI
cp6	Refusé
cp7	Problème d'adresse
cp8	Retour IMX
cv	Retour soldé
cw	Remis à la Poste
cx	Retour distributeur
cy	Retour client
cz	Livré

Liste des status ou événements normalisés

Pour chaque colis, IMX considére un jeu d'événements qui correspondent à une chronologie normalisée.

Code	Description
ordered	Date de commande ou de création du colis
collected	Date de collecte du colis (s'applique uniquement aux colis déposés en point-relais)
in-imx-hub	Date de réception du colis par IMX
leaving-imx-hub	Date de départ du colis du hub d'IMX
international-departure	Date de départ pour le pays de destination (s'applique uniquement aux colis internationaux)
international-transit	Première date d'avis de transit international (idem)
international-arrival	Date d'arrivée dans le pays de destination (idem)
back-to-sender	Date de mise en retour du colis (s'applique uniquement aux colis impossibles à livrer)
available-for-delivery-pickup	Date d'avis de mise en disposition en relais (s'applique uniquement aux colis livrés en point-relais)
notified	Date de la première tentative de livraison à domicile
delivered	Date de remise au destinataire

Liens avec le Web Service

En cas de succès, la fonction declare_parcel du Web Service IMX indique dans sa réponse l’URL HTML de suivi du colis qui vient d’être généré dans le champs tracking_data.imx_tracking_url.