GetShipment

Returns the work orders of one job, found by its job reference: for each work order, its container or load ID, size, weight and commodity, and the latest event the customer can see. Use it to show a job’s progress in another system, such as a tracking page; TrakIT’s public tracking widget shows the same details. The API calls a job a shipment.

To follow where a customer’s containers are, use GetAssetLocation or GetList. In TrakIT, the same details are in the work order’s header, where Customer Status shows the latest event the customer can see.

How to send the key and read the response: API keys, Responses.

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

Send the key in the APIKey header. The key must be allowed to get shipments (public.getshipment); TrakIT Support sets this up.

Parameter	Required	Meaning
Num	Yes	The job reference. Letters, digits, /, - and _ only. Spaces at either end are removed, and capitals don’t matter.

Num must be in the query string: without it, TrakIT answers HTTP 404.

Rules

Rule	Info when it fails
The request has an APIKey header.	API Key Missing
The key is active and allowed to get shipments.	Key is disabled, not recognized or permission denied
Num has only letters, digits, /, - and _.	Invalid Number Specified

Response

On success, Code is 1, RetInfo lists the job’s work orders, one entry each, in the order of their IDs, and RowsAffected is their number. Every work order of the job is listed, whatever its status, including closed and cancelled ones.

When no job has that reference, Code is still 1: RetInfo is an empty list and RowsAffected is 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
}

Field	Meaning
WorkOrderID	The work order’s ID.
Corridor	The name of the job’s workflow.
Container	The container number, if the work order has one.
Manifest	The load ID, if the work order has one.
Size	The container’s length in feet, for example 20 or 40.
Weight	The weight, in kilograms.
Commodity	The goods.
LastEvent	The latest event the customer can see: its external name if it has one, otherwise its name. null when the work order has no such event yet. Which events customers see is set in each event’s External Access: see event fields.
LastEventDate	The date and time of that event, in UTC. See Dates and times.