GetWO

Renvoie un ordre de travail par son identifiant : son en-tête, ses services, ses événements et ses champs de données avec leurs valeurs, ses KPI et ses actifs. Utilisez-le pour lire les ordres de travail que CreateJob a créés, ou ceux que GetWOListByUpdated liste comme modifiés. Pour lire en une fois tous les ordres de travail d’un dossier, utilisez GetJob ; pour ne lire que certains événements et champs de données, utilisez GetSeqData.

Comment se connecter et lire la réponse : Authentification, Réponses.

GET /api/v1/GetWO?ID=48211
Token: your-token

Paramètre	Obligatoire	Signification
ID	Oui	L’identifiant de l’ordre de travail, un nombre entier.

Sans ID, la requête n’atteint pas le point de terminaison, et TrakIT répond avec le statut HTTP 404. Un ID qui n’est pas un nombre entier reçoit lui aussi un statut d’erreur HTTP au lieu de la réponse habituelle. Voir Erreurs.

Règles

Règle	Info en cas d’échec
L’en-tête Token contient un jeton valide.	Token missing in header, Token invalid or expired, ou une autre réponse listée dans Jeton de connexion
L’utilisateur est un administrateur système avec un accès à l’API.	API User must be SysAdmin with API Access

Réponse

En cas de succès, RetInfo est l’ordre de travail. RowsAffected et Identity valent 0.

Vérifiez RetInfo avant de le lire : il vaut null quand aucun ordre de travail n’a cet identifiant.

{
  "Code": 1,
  "Info": "",
  "RetInfo": {
    "WorkOrderID": 48211,
    "Workflow": "Import Sea Freight",
    "WFType": "Import",
    "JobID": 10457,
    "Job": "EXBL2610045",
    "JobType": "Door to Door",
    "ContNum": "ABCU1234560",
    "TypeCode": "22G1",
    "ContLength": 20,
    "SealNum": "SL778812",
    "Commodity": "Ceramic tiles",
    "LocationList": "Example Port - Container Terminal; Example City - Customer Warehouse",
    "ParentWO": null,
    "Resp": "JSMITH",
    "CarrierID": 1187,
    "CustomerID": 3021,
    "ShipperID": 3022,
    "ReceiverID": 3021,
    "AgentID": null,
    "ClAgentID": 2304,
    "TransID": 2210,
    "RetTransID": null,
    "Weight": 21450.500,
    "Volume": null,
    "Status": 0,
    "Responsible": "John Smith",
    "Trans": "Example Haulage Ltd",
    "RetTrans": null,
    "Services": [
      { "ServiceID": 4, "ServiceName": "Customs Clearance" },
      { "ServiceID": 6, "ServiceName": "Delivery" }
    ],
    "Events": [
      { "Name": "Vessel Arrival", "Code": "VSLARR", "Value": "2026-10-20 06:30", "Remarks": null, "Updated": "2026-10-20T07:02:11.483", "UpdatedBy": "JSMITH" },
      { "Name": "Gate Out", "Code": "GATEOUT", "Value": "", "Remarks": null, "Updated": null, "UpdatedBy": null }
    ],
    "Data": [
      { "Name": "Delivery Order No", "Code": "DONUM", "Value": "DO-55120", "Remarks": null, "Updated": "2026-10-20T09:15:40.12", "UpdatedBy": "JSMITH" }
    ],
    "KPIs": [
      { "KPI": "Arrival to Gate Out", "FromDate": "2026-10-20T06:30:00", "ToDate": null, "Target": 72, "Actual": 30 }
    ],
    "Assets": []
  },
  "RowsAffected": 0,
  "Scalar": null,
  "Identity": 0
}

Objet ordre de travail

GetJob renvoie ses ordres de travail sous la même forme. Les libellés en gras sont ceux des champs d’en-tête.

Champ	Signification
WorkOrderID	L’identifiant de l’ordre de travail.
Workflow, WFType	Le nom et le type du workflow : Import, Export, RoundTrip ou NonShipment.
JobID, Job	L’identifiant et la référence du dossier.
JobType	Les noms des types de dossier du dossier, séparés par une virgule et une espace. Vide s’il n’en a aucun.
ContNum	Container No., ou une chaîne vide.
TypeCode	Load Type : le code du type de chargement, ou null.
ContLength	La longueur en pieds que représente le code du type de chargement, par exemple 20 pour 22G1 et 45 pour L5G1. 0 sans type de chargement, ou quand le code ne donne pas de longueur.
SealNum	Seal Number, ou une chaîne vide.
Commodity	Commodity, ou une chaîne vide.
LocationList	La liste des lieux sous forme de texte : chaque lieu après sa zone géographique parente, Parent - Location, séparés par ; . Vide si l’ordre de travail n’en a pas.
ParentWO	L’identifiant de l’ordre de travail à partir duquel celui-ci a été créé, son ordre de travail parent, ou null.
Resp, Responsible	Responsible Person : l’identifiant utilisateur et le nom de l’utilisateur.
CarrierID	Carrier : l’identifiant de l’entité, ou 0 s’il n’y en a pas.
CustomerID, ShipperID, ReceiverID	Le Customer, le Shipper et le Receiver du dossier : des identifiants d’entités, ou null.
AgentID, ClAgentID	Bond Agent et Clearing Agent : des identifiants d’entités, ou null.
TransID, Trans	Transporter : l’identifiant et le nom de l’entité, ou null.
RetTransID, RetTrans	Return Transporter : l’identifiant et le nom de l’entité, ou null.
Weight	Weight, en kilogrammes.
Volume	Volume, en mètres cubes, ou null.
Status	Le statut de l’ordre de travail sur la page Ordre de travail, sous forme de nombre : 0 Active, 1 Abandoned, 2 Cancelled, 3 Closed par un utilisateur, une intégration ou une action, 4 Closed par TrakIT lui-même, une fois les événements et les données requis renseignés ou après l’abandon de l’ordre de travail.
Services	Les services de l’ordre de travail : ServiceID et ServiceName. Une liste vide s’il n’en a aucun.
Events	Tous les événements de l’ordre de travail, enregistrés ou non, dans l’ordre du workflow. Voir ci-dessous.
Data	Tous les champs de données de l’ordre de travail, renseignés ou non, dans l’ordre du workflow, avec les mêmes champs que Events.
KPIs	Les KPI de l’ordre de travail. Voir ci-dessous.
Assets	Les actifs affectés à l’ordre de travail, dans l’ordre de leur affectation : AssetID, AssetName, AssetSerial, et TypeID, l’identifiant du type d’actif. Une liste vide s’il n’en a aucun.

Chaque élément de Events et de Data :

Champ	Signification
Name	Le nom de l’événement ou du champ de données.
Code	Son code. GetSeqData et SaveSeqData acceptent ce code.
Value	La valeur, sous forme de texte, ou une chaîne vide. Pour un événement, la date et l’heure telles qu’elles ont été enregistrées, par exemple 2026-10-20 06:30, ou NA (sans objet) ou TBA (à communiquer).
Remarks	Les remarques, ou null.
Updated	Le moment où la valeur a été enregistrée pour la dernière fois, en UTC, ou null si elle ne l’a jamais été.
UpdatedBy	L’identifiant utilisateur de l’utilisateur qui l’a enregistrée, ou null.

Chaque élément de KPIs :

Champ	Signification
KPI	Le nom du KPI.
FromDate, ToDate	Les moments entre lesquels court le KPI, comme dans l’onglet KPIs de l’ordre de travail, ou null tant qu’ils ne sont pas connus.
Target	Le temps accordé, en heures, ou null. Pour un KPI en heures ouvrées, une journée compte 8 heures.
Actual	Le temps pris jusqu’ici, en heures, ou null.