Skip to content
TrakIT documentation

GetJob

Returns one job, found by its reference, with all its work orders. Use it to follow a job you created with CreateJob, or to copy a job into your own system. To read one work order by its ID, use GetWO.

How to sign in and read the response: Authentication, Responses.

GET /api/v1/GetJob?Num=EXBL2610045
Token: your-token
Parameter Required Meaning
Num Yes The job reference (header field TD), for example the bill of lading number, as TrakIT stores it: without spaces. Capitals do not matter. This is not the job’s ID.

Without Num, the request does not reach the endpoint, and TrakIT answers with HTTP status 404 (see Errors).

Rules

Section titled “Rules”
Rule Info when it fails
The Token header holds a valid token. Token missing in header, Token invalid or expired, or another answer listed in Login token
The user is a system administrator with API access. API User must be SysAdmin with API Access
Num is not empty. ... not supplied, starting with your installation’s short name for the job reference: by default T/D not supplied
A job has that reference. No such record

Response

Section titled “Response”

On success, RetInfo is the job. RowsAffected and Identity are 0. Created is in UTC, without a time zone (see Dates and times).

{
  "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
}

The labels in bold are those of the job header and the header fields.

Field Meaning
JobID The job’s ID.
Num The job reference (Transport Document, or your installation’s name for it).
Customer, Shipper, Receiver The names of the Customer, Shipper and Receiver entities, or null. Their IDs are on each work order: CustomerID, ShipperID, ReceiverID.
RevDate The job’s revenue and expense recognition date, at midnight, or null.
JobType The names of the job’s job types (Job Type), separated by a comma and a space. Empty when it has none.
CargoType The Cargo Type as a name, such as FCL or BreakBulk: see Cargo types. Empty when the job has none.
Commodity The commodity of the job’s work orders that are not cancelled. When they differ, the last one in alphabetical order.
Incoterms The Incoterms, separated by commas, or null.
Created When the job was created, in UTC.
WFSerial The job’s Workflow Serial, its serial number in its workflow, or null if the workflow does not number its jobs.
Workflow The workflow’s name.
WFType The workflow’s type: Import, Export, RoundTrip or NonShipment.
WOCount The number of the job’s work orders that are not cancelled.
WOList All the job’s work orders, cancelled ones included, in order of ID. Each is a work order object, the same as GetWO returns.