TrackingEvent
A location or tracking update derived from carrier communication.
- eventenum
Source requiredHow the tracking data was obtained
values- 4
K I T E S - C
A R R I E R _ A P I - H
I G H W A Y - M
A C R O P O I N T - P44
- eventenum
Type requiredType of tracking event
values- D
E L A Y E D - I
N F O - P
I C K E D _ U P - P
I N G - D
R I V E R _ A T _ P I C K U P - D
R I V E R _ A T _ D E L I V E R Y - D
E L I V E R E D - C
O V E R E D - D
I S P A T C H E D
- event
Utc required- Type: string · InputDateTimeUtcFormat: date-time
Event time in UTC, or with a specific timezone offset
- cityType: string
- countryType: string
- dispatcherType: object
Contact information for a person associated with a tracking event.
- emailType: string
Email address of the contact.
- idType: string
Identifier of the contact in the TMS system.
- nameType: string
Full name of the contact.
- phoneType: string
Phone number in E.164 format (e.g., +12081234567) or common local format. Supports US, CA, MX, PH.
- phoneType: string
Extension Phone number extension (numeric only).
- driverType: object
Contact information for a person associated with a tracking event.
- emailType: string
Email address of the contact.
- idType: string
Identifier of the contact in the TMS system.
- nameType: string
Full name of the contact.
- phoneType: string
Phone number in E.164 format (e.g., +12081234567) or common local format. Supports US, CA, MX, PH.
- phoneType: string
Extension Phone number extension (numeric only).
- eventType: stringenum
Code Optional EDI 214 tracking status code.
values- A
A - A
B - A
F - A
G - A
M
- event
Local Time - Type: string · InputDateTimeUtcFormat: date-time
Local time of the event, in the timezone of the event.
- latitudeType: number
- longitudeType: number
- next
Eta Utc - Type: string · InputDateTimeUtcFormat: date-time
Next estimated arrival time in UTC, or with a specific timezone offset
- nextType: integer
Sequence Next stop sequence number
- notesType: string
Free-text context from the carrier communication
- postalType: string
Code - stateType: string
Or Province - temperatureType: number
F Temperature in Fahrenheit (if available)