API Tracking light
Emplacement : API
Droits
Ouverture de cette API aux CONS
URL de consultation
- Prod — URL : https://gw.apis.ci5.io/p/tracking-light
- Non prod — URL : https://[env].gw.apis.ci5.io/p/tracking-light
Il faut remplacer [env] par l’environnement souhaité (en minuscule et avec le séparateur tiret pour mco-mgi et dev-mgi)
Exemple pour PREPROD : https://preprod.gw.apis.ci5.io/p/tracking-light
Requête
Possibilité de recherche sur :
- La référence cargo : cargoRef
-
La référence du document de transport : transportDocumentReference
- Référence booking pour l’export
- Référence BL pour l’import
Modèle de message :
{ "userId": "adresse mail du user", (*) "cargoRef": "référence du cargo" }
ou
{ "userId": "adresse mail du user", (*) "transportDocumentReference": "reference du BL ou Booking" }
(*) userId est obligatoire
Si plusieurs résultats sont trouvés, Ci5 va identifier celui dont l’annonce est la plus récente (prise en compte de la date de création du BL ou date de création du booking).
Exemples de message envoyé :
{ "userId": "email@email.com", "transportDocumentReference": "BL123456" }
{ "userId": "email@email.com", "cargoRef": "CMAU0035961" }
Résultats
Calcul du transport mode pour chaque cargo :
gateOut.transportMode =
si tracking.isGateOut = false → null
sinon si inlandTransport depuis le terminal → moyen de transport du call inland
sinon si constat MR GateOut avec un carrier transportMode → mrGateOut.transportMode
sinon si communauté inland → “Road Transport”
sinon null
Exemple de réponse :
json { "transportDocuments": [ { "cargoSetReference": "EBIBL_US3596_1", "cargoSetType": "BL", "port": { "code": "FRFOS", "label": "Fos-sur-mer", "countryCode": "FR" }, "eta": "2025-06-25T23:00:00.000Z", "etd": "2025-06-27T22:00:00.000Z", "preCallNumber": "EBICA_US3596_1", "conveyance": { "registration": "9714678", "name": "NAVIGARE BELLUS", "flag": "MH", "callSign": "V7A4358" }, "terminal": { "code": "TL111", "label": "Terminal location 111", "areaCode": "FOS", "managerCode": "MANAGER1" }, "trackings": [ { "cargo": { "id": 103988, "createdCommunity": "MRS", "reference": "EBICUS35961", "type": "CONTAINER", "sizeType": "22G0", "packageType": "PC" }, "gateIn": { "stateDate": "2025-06-26T12:32:12.166Z", "state": "OK" }, "gateOut": { "stateDate": "2025-06-26T12:32:23.437Z", "state": "OK", "transportMode": "Road Transport" }, "load": { "stateDate": null, "state": "NA" }, "discharge": { "stateDate": "2025-06-26T12:32:12.166Z", "state": "OK" }, "direction": "IMPORT", "locationCode": "TL111" } ] } ] }
Référence :
Source : https://mgi-team.atlassian.net/wiki/spaces/DOCI5/pages/4307353603