Passer au contenu principal

[GCL] API Logistique - Suivi

Juliana Maciel Maruri da Cunha avatar
Écrit par Juliana Maciel Maruri da Cunha
Mis à jour cette semaine

Obtenez les détails de suivi d'un colis et son statut actuel.

Retourner le shortUid de la commande et les points de contrôle qui indiquent le statut actuel et les mises à jour du colis.

GET /v1/tracking/{trackingNumber}

Exemple de demande

/v1/tracking/EXMPL0001234TRCKNUM

Exemple de réponse de réussite

{  "shortUid": "EXMPL0001234",  "trackingNumber": "EXMPL0001234TRCKNUM",  "trackingUrl": "https://mydhl.express.dhl/no/en/tracking.html#/results?id=EXMPL0001234TRCKNUM",  "shipmentMethodUid": "dhl_express_worldwide",  "shipmentMethodName": "DHL Express Worldwide",  "carrierUid": "dhl_express",  "carrierName": "DHL Express",  "weightInGrams": "460",  "checkpoints": [    {      "status": 6,      "message": "Delivered",      "description": "Delivered",      "location": "LONDON-GBR, United Kingdom",      "createdAt": "2024-07-29T18:16:06Z",      "expectedDeliveryDate": "",      "statusUid": "delivered",      "signedBy": "aftership"    },    {      "status": 2,      "message": "Shipment is out with courier for delivery",      "description": "Out for Delivery",      "location": "LONDON-GBR, United Kingdom",      "createdAt": "2024-07-29T08:58:40Z",      "expectedDeliveryDate": "",      "statusUid": "out_for_delivery",      "signedBy": "aftership"    },    {      "status": 1,      "message": "Arrived at DHL Sort Facility LONDON-HEATHROW-GBR",      "description": "Arrival scan",      "location": "LONDON-HEATHROW-GBR, United Kingdom",      "createdAt": "2024-07-29T00:35:29Z",      "expectedDeliveryDate": "",      "statusUid": "in_transit",      "signedBy": "aftership"    },    {      "status": 1,      "message": "Scheduled to depart on the next planned movement",      "description": "Departure Scan",      "location": "EAST MIDLANDS-GBR, United Kingdom",      "createdAt": "2024-07-28T12:02:21Z",      "expectedDeliveryDate": "2024-07-30",      "statusUid": "in_transit",      "signedBy": "aftership"    },    {      "status": 1,      "message": "Customs clearance status updated. Note - The Customs clearance process may start while the shipment is in transit to the destination.",      "description": "Customs clearance started",      "location": "EAST MIDLANDS-GBR, United Kingdom",      "createdAt": "2024-07-26T13:00:23Z",      "expectedDeliveryDate": "2024-07-30",      "statusUid": "in_transit",      "signedBy": "aftership"    },    {      "status": 1,      "message": "Shipment has departed from a DHL facility ULM-DEU",      "description": "Departure Scan",      "location": "ULM-DEU, Germany",      "createdAt": "2024-07-25T16:41:58Z",      "expectedDeliveryDate": "2024-07-30",      "statusUid": "in_transit",      "signedBy": "aftership"    },    {      "status": 1,      "message": "Shipment picked up",      "description": "Acceptance scan",      "location": "ULM-DEU, Germany",      "createdAt": "2024-07-25T14:21:55Z",      "expectedDeliveryDate": "2024-07-30",      "statusUid": "in_transit",      "signedBy": "aftership"    }  ]}

Exemple de réponse d'erreur

{  "trackingNumber": "EXMPL0001234TRCKNUM",  "code": "TRACKING_DETAILS_NOT_FOUND",  "message": "Tracking details not found.",  "details": null}

Demande

Paramètre

Type

Description

trackingNumber (obligatoire)

chaîne

Le numéro de suivi du colis fourni par le transporteur

Réponse réussie

Paramètre

Type

Description

shortUid (obligatoire)

chaîne

Un identifiant court unique pour la réponse

trackingNumber (obligatoire)

chaîne

Le numéro de suivi du colis

trackingUrl (facultatif)

chaîne

URL de suivi du colis par le transporteur

shipmentMethodUid (facultatif)

chaîne

UID du mode d'expédition utilisé pour livrer le colis

shipmentMethodName (facultatif)

chaîne

Nom du mode d'expédition utilisé pour livrer le colis

carrierUid (facultatif)

chaîne

UID du transporteur utilisé pour livrer le colis

carrierName (facultatif)

chaîne

Nom du transporteur utilisé pour livrer le colis

weightInGrams (facultatif)

chaîne

Poids du colis en grammes

checkpoints (facultatif)

CheckPoint[]

Un tableau d'objets CheckPoint (peut être vide)

CheckPoint

Paramètre

Type

Description

status (obligatoire)

nombre

Numéro d'identification du statut

statusUid (obligatoire)

chaîne

UID du statut (voir StatusEnum)

message (obligatoire)

chaîne

Message d'état

description (facultatif)

chaîne

Description du statut

location (facultatif)

chaîne

Emplacement actuel du colis (adresse)

createdAt (obligatoire)

chaîne

Statut créé le (RFC3339)

expectedDeliveryDate (facultatif)

chaîne

Date de livraison prévue (YYYY-MM-DD). Exemple : 2024-01-21

signedBy (obligatoire)

chaîne

Quel fournisseur/service l'a signé

StatusEnum

Valeur du statut

Description

enregistré

Représente le statut enregistré

En transit

Représente le statut « En transit »

En cours de livraison

Représente le statut « En cours de livraison »

tentative échouée

Représente le statut de tentative échouée

exception d'expédition

Représente le statut d'exception d'expédition

Disponible pour le retrait

Représente le statut « disponible pour le retrait »

livré

Représente le statut livré

expédié

Représente le statut expédié

retourné

Représente le statut de retour

non récupéré

Représente le statut non récupéré

Réponse d'erreur

Paramètre

Type

Description

Numéro de suivi

chaîne

Le numéro de suivi du colis

code

chaîne

Code d'erreur

message

chaîne

Message d'erreur

details (facultatif)

Détails de l'erreur de réponse

Détails supplémentaires sur l'erreur

ResponseErrorDetails

Paramètre

Type

Description

code

chaîne

Code d'erreur.

message

chaîne

Message d'erreur

Référence (facultatif)

chaîne

ID de référence.


📝 Pas ce dont vous aviez besoin ?

Aidez-nous à améliorer cet article, envoyez-nous un e-mail à [email protected] — veuillez inclure le titre de l'article.

Avez-vous trouvé la réponse à votre question ?