Position d'une expédition
La réponse de l'endpoint GET /shipment de la Container Tracking API localise une expédition de trois façons : les coordonnées actuelles de l'expédition, la dernière position AIS du navire qui la transporte, et le statut et les events de ses conteneurs. Les deux premières placent l'expédition sur une carte ; la troisième indique où elle en est de son trajet.
Coordonnées actuelles (recommandé)
Pour placer un conteneur sur une carte, utilisez routeData.coordinates dans la réponse de GET /shipment : c'est la position actuelle du conteneur.
- Quand le conteneur est à bord d'un navire,
coordinatesest la position du navire. - Sinon,
coordinatesest la dernière position connue du conteneur, en général son dernier lieu.
routeData.routeSegments liste les positions successives du trajet de l'expédition, qui tracent ce trajet sur une carte. routeData n'est renvoyé que quand le paramètre de requête route vaut true, sa valeur par défaut.
{
"routeData": {
"routeSegments": [
{
"path": [
{ "lat": 29.76328, "lng": -95.36327, "updatedAt": null },
{ "lat": 53.551052, "lng": 8.570912, "updatedAt": null },
{ "lat": 53.53615, "lng": 8.59298, "updatedAt": null }
],
"routeType": "SEA"
}
],
"coordinates": { "lat": 47.08643, "lng": -11.237754 }
}
}
Position AIS du navire
La réponse de GET /shipment porte aussi les données AIS du navire dans routeData.ais, quand les paramètres de requête route et ais valent tous deux true. Quand ais.status vaut OK, ais.data.lastVesselPosition donne la dernière position du navire. Son champ updatedAt indique quand cette position a été reçue, pour que vous jugiez si elle est assez récente pour votre usage.
{
"ais": {
"status": "OK",
"data": {
"lastEvent": {
"description": "Vessel departure",
"date": "2023-11-11T07:09:00Z",
"voyage": "344E"
},
"dischargePort": null,
"vessel": {
"name": "MAERSK OHIO",
"imo": 9298698,
"callSign": "KABP",
"mmsi": 367775000,
"flag": "US"
},
"lastVesselPosition": {
"lat": 51.28157,
"lng": 4.253457,
"updatedAt": "2023-11-28T10:28:00Z"
}
}
}
}
Coordonnées ou position AIS
Les deux positions viennent de sources différentes :
ais.data.lastVesselPositionvient des données AIS, la géolocalisation du navire par satellite ;routeData.coordinatesvient des données de la compagnie maritime.
Statut et events
Pour situer une expédition par son avancement plutôt que sur une carte, utilisez le statut et les events de l'expédition.
Pour une vérification rapide, metadata.shippingStatus donne le statut résumé de l'expédition : PLANNED, IN_TRANSIT, DELIVERED ou UNKNOWN.
{
"metadata": {
"shipmentType": "CT",
"shipmentNumber": "MSKU0496560",
"sealine": "MAEU",
"sealineName": "Maersk",
"shippingStatus": "IN_TRANSIT",
"updatedAt": "2023-11-28T11:24:59Z"
}
}
Pour le détail, chaque entrée de containers liste les events du conteneur. Chaque event donne un lieu, une installation, un code d'event, un statut et une date : le dernier event réel indique où se trouve le conteneur et ce qui lui est arrivé.
{
"number": "MSKU0496560",
"isoCode": "45G1",
"status": "IN_TRANSIT",
"events": [
{
"location": {
"name": "Houston",
"state": "Texas",
"country": "United States",
"countryCode": "US",
"locode": "USHOU",
"coordinates": { "lat": 29.76328, "lng": -95.36327, "updatedAt": null },
"timezone": "America/Chicago"
},
"facility": {
"name": "Houston Barbours Cut Terminal",
"countryCode": "US",
"locode": "USUQF",
"bicCode": "USUQFGDQQ",
"smdgCode": null,
"coordinates": { "lat": null, "lng": null, "updatedAt": null }
},
"description": "Gate out",
"eventType": "EQUIPMENT",
"eventCode": "GTOT",
"status": "CEP",
"date": "2023-11-07T11:16:00Z",
"isActual": true,
"isAdditionalEvent": false,
"routeType": "LAND",
"transportType": null,
"vessel": null,
"voyage": null
}
]
}
La page Codes de statut et d'event liste chaque code d'event et chaque statut qu'un event de conteneur peut porter.