Aller au contenu

GetJob

Renvoie un dossier, trouvé par sa référence, avec tous ses ordres de travail. Utilisez-le pour suivre un dossier créé avec CreateJob, ou pour copier un dossier dans votre propre système. Pour lire un ordre de travail par son identifiant, utilisez GetWO.

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

GET /api/v1/GetJob?Num=EXBL2610045
Token: your-token
Paramètre Obligatoire Signification
Num Oui La référence du dossier (champ d’en-tête TD), par exemple le numéro du connaissement, telle que TrakIT l’enregistre : sans espaces. Les majuscules n’ont pas d’importance. Ce n’est pas l’identifiant du dossier.

Sans Num, la requête n’atteint pas le point de terminaison, et TrakIT répond avec le statut HTTP 404 (voir Erreurs).

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
Num n’est pas vide. ... not supplied, commençant par le nom abrégé que votre installation donne à la référence du dossier : par défaut T/D not supplied
Un dossier a cette référence. No such record

En cas de succès, RetInfo est le dossier. RowsAffected et Identity valent 0. Created est en UTC, sans fuseau horaire (voir Dates et heures).

{
"Code": 1,
"Info": "",
"RetInfo": {
"JobID": 10457,
"Num": "EXBL2610045",
"Customer": "Example Trading Ltd",
"Shipper": "Example Exports Co",
"Receiver": "Example Trading Ltd",
"RevDate": null,
"JobType": "Door to Door",
"CargoType": "FCL",
"Commodity": "Ceramic tiles",
"Incoterms": "CIF",
"Created": "2026-10-19T08:41:27.13",
"WFSerial": "IMPSEA/26/0412",
"Workflow": "Import Sea Freight",
"WFType": "Import",
"WOCount": 2,
"WOList": [
{ "WorkOrderID": 48211, "Workflow": "Import Sea Freight", "...": "..." },
{ "WorkOrderID": 48212, "Workflow": "Import Sea Freight", "...": "..." }
]
},
"RowsAffected": 0,
"Scalar": null,
"Identity": 0
}

Les libellés en gras sont ceux de l’en-tête du dossier et des champs d’en-tête.

Champ Signification
JobID L’identifiant du dossier.
Num La référence du dossier (Transport Document, ou le nom que votre installation lui donne).
Customer, Shipper, Receiver Les noms des entités Customer, Shipper et Receiver, ou null. Leurs identifiants figurent sur chaque ordre de travail : CustomerID, ShipperID, ReceiverID.
RevDate La date de constatation des produits et des charges du dossier, à minuit, ou null.
JobType Les noms des types de dossier du dossier (Job Type), séparés par une virgule et une espace. Vide s’il n’en a aucun.
CargoType Le Cargo Type sous forme de nom, comme FCL ou BreakBulk : voir Types de marchandise. Vide si le dossier n’en a pas.
Commodity La marchandise des ordres de travail du dossier qui ne sont pas annulés. Si elles diffèrent, la dernière dans l’ordre alphabétique.
Incoterms Les Incoterms, séparés par des virgules, ou null.
Created Le moment où le dossier a été créé, en UTC.
WFSerial Le Workflow Serial du dossier, son numéro de série dans son workflow, ou null si le workflow ne numérote pas ses dossiers.
Workflow Le nom du workflow.
WFType Le type du workflow : Import, Export, RoundTrip ou NonShipment.
WOCount Le nombre d’ordres de travail du dossier qui ne sont pas annulés.
WOList Tous les ordres de travail du dossier, y compris ceux qui sont annulés, par ordre d’identifiant. Chacun est un objet ordre de travail, le même que celui que renvoie GetWO.