GetShipment

Renvoie les ordres de travail d’un dossier, trouvé grâce à la référence du dossier : pour chaque ordre de travail, son conteneur ou son ID de chargement, sa taille, son poids et sa marchandise, ainsi que le dernier événement que le client peut voir. Utilisez-le pour afficher l’avancement d’un dossier dans un autre système, comme une page de suivi ; le widget de suivi public de TrakIT affiche les mêmes informations. L’API appelle un dossier une expédition.

Pour suivre où se trouvent les conteneurs d’un client, utilisez GetAssetLocation ou GetList. Dans TrakIT, les mêmes détails figurent dans l’en-tête de l’ordre de travail, où Customer Status indique le dernier événement que le client peut voir.

Comment envoyer la clé et lire la réponse : Clés d’API, Réponses.

GET /api/public/GetShipment?Num=EXL-2610-0042
APIKey: your-api-key

Envoyez la clé dans l’en-tête APIKey. La clé doit être autorisée à obtenir des expéditions (public.getshipment) ; le support TrakIT s’en charge.

Paramètre	Obligatoire	Signification
Num	Oui	La référence du dossier. Lettres, chiffres, /, - et _ uniquement. Les espaces au début et à la fin sont supprimés, et les majuscules n’ont pas d’importance.

Num doit figurer dans la chaîne de requête : sans lui, TrakIT répond avec le statut HTTP 404.

Règles

Règle	Info en cas d’échec
La requête a un en-tête APIKey.	API Key Missing
La clé est active et autorisée à obtenir des expéditions.	Key is disabled, not recognized or permission denied
Num ne contient que des lettres, des chiffres, /, - et _.	Invalid Number Specified

Réponse

En cas de succès, Code vaut 1, RetInfo liste les ordres de travail du dossier, un élément pour chacun, dans l’ordre de leurs identifiants, et RowsAffected indique leur nombre. Tous les ordres de travail du dossier sont listés, quel que soit leur statut, y compris ceux qui sont clôturés ou annulés.

Quand aucun dossier n’a cette référence, Code vaut tout de même 1 : RetInfo est une liste vide et RowsAffected vaut 0.

{
  "Code": 1,
  "Info": "",
  "RetInfo": [
    {
      "WorkOrderID": 48211,
      "Corridor": "Import Full",
      "Container": "ABCU1234560",
      "Manifest": null,
      "Size": 40,
      "Weight": 18450.0,
      "Commodity": "Cocoa beans",
      "LastEvent": "Discharged",
      "LastEventDate": "2026-10-19T14:20:00"
    }
  ],
  "RowsAffected": 1,
  "Scalar": null,
  "Identity": 0
}

Champ	Signification
WorkOrderID	L’identifiant de l’ordre de travail.
Corridor	Le nom du workflow du dossier.
Container	Le numéro du conteneur, si l’ordre de travail en a un.
Manifest	L’ID de chargement, si l’ordre de travail en a un.
Size	La longueur du conteneur, en pieds, par exemple 20 ou 40.
Weight	Le poids, en kilogrammes.
Commodity	La marchandise.
LastEvent	Le dernier événement que le client peut voir : son nom externe s’il en a un, sinon son nom. null quand l’ordre de travail n’a pas encore d’événement de ce type. Les événements que voient les clients se définissent dans le réglage External Access de chaque événement : voir les champs des événements.
LastEventDate	La date et l’heure de cet événement, en UTC. Voir Dates et heures.