FourKites Late Reason Code
This callback is triggered when "Late Reason Codes" are computed for a load by FourKites.
{
"MessageType": "LATE_REASON_CODE",
"FourKitesLoadId": 1234,
"LoadNumber": "BOL12345",
"ProNumber": "PRO123",
"Shipper": "test-shipper",
"StopReferenceId": "S123",
"StopName": "STOP_123",
"StopType": "delivery",
"ReasonCode": [{
"LongDescription": "The load encountered an extended delay for crossing an international border"
"ReasonCodeName": "cross_border_delay",
"ShortDescription": "Unattributed Transit Time",
"TimeImpact": "2hrs 14mins",
"ReasonCodeRank": 1
}, {
"LongDescription": "The load encountered planned event(s) such as concerts, sporting or political events along the route"
"ReasonCodeName": "event_delay",
"ShortDescription": "Unattributed Transit Time",
"TimeImpact": "2hrs 14mins",
"ReasonCodeRank": 2
}],
"Tags": ["Temp", "Inbound"],
"Timestamp": "2015-10-01T16:00:00-05:00",
"Timezone": "America/New_York",
"TimezoneShortName": "EST",
"TimezoneOffset" : -18000
}Field Definitions
Field Name | Description | Key Always Present? | Value Always Present? | Conditions for the Key to be Present | Data Type | Max Length |
|---|---|---|---|---|---|---|
Shipper | Unique shipper ID from FourKites | Yes | Yes | N/A | String | No max, but realistically, not longer than 200 characters |
FourKitesLoadId | Unique load identifier from FourKites system if the load was successfully created (IsSuccess = true). The field will be null if the load creation failed in FourKites | Yes | No | TrackingId will be mapped to FourKitesLoadId | Number | 20 |
LoadNumber | Unique shipment identifier from shipper's system | Yes | Yes | N/A | String | 65535 |
ProNumber | Shipment's PRO # | Yes | No | N/A | Number | 10 |
Shipper | Unique shipper ID from FourKites | Yes | Yes | N/A | String | No max, but realistically, not longer than 200 characters |
Tags | List of tags associated with the load (empty list when tags are not present) | Yes | No | N/A | Array of string | 50 for each tag |
ReferenceNumbers | List of additional reference numbers associated with the load | Yes | Yes | N/A | Array of string | No max |
StopReferenceId | Reference ID of the stop provided during load creation | Yes | No | N/A | string | 1024 |
StopName | Name of the stop provided during load creation. | Yes | Yes | N/A | String | No max |
StopType | Stop type - pickup, terminal, delivery | Yes | Yes | N/A | String | 1024 |
ReasonCodeName | Reason why the stop is delayed | Yes | Yes | N/A | String | |
ShortDescription | Short Description of the reason why the stop is delayed | Yes | Yes | N/A | String | |
LongDescription | Description of the reason why the stop is delayed | Yes | Yes | N/A | String | 1024 |
ReasonCodeRank | Order of the reason code among the list of other reason codes for delay | Yes | No | N/A | Number | |
TimeImpact | Number of hours and minutes by which the stop is delayed | Yes | Yes | N/A | String | 30 |
Timezone | Local Timezone of the stop in which Timestamp is specified. | If the arrival time is null, then the timezone will not be present | If the arrival time is not null then the value will be present. | N/A | String | 50 |
Timestamp | Time when the truck arrived at the stop in stop's local time (in ISO 8601 format with local time offset to UTC) | Yes | Yes | Mapped to EventTime. Event Time received will be converted to the timezone specific to the customer. | String in DateTime format | |
TimezoneShortName | Short name of Timezone of the stop in which "Timestamp" is specified. | Yes | Yes | N/A | String | 5 |
TimzoneOffset | Number of seconds local timezone is ahead of UTC time. Negative for western hemisphere timezones. | Yes | Yes | N/A | [+/-]Digits | 10 |
Note:
- LATE_REASON_CODE gets computed on stop arrival and is recalculated for each re-entry.
- You may get LATE_REASON_CODE message multiple times for a single stop.
List of available Late reason codes:
ReasonCodeName | ShortDescription |
|---|---|
Late Pickup | The carrier asset arrived late for the pickup appointment |
Inefficient Route | Alternative routes were available that could have resulted in faster transit |
Traffic Congestion | The load encountered traffic congestion along the route |
Construction Delay | The load encountered construction event(s) along the route |
Weather Delay | The load encountered weather event(s) along the routed |
Planned Event | The load encountered planned event(s) such as concerts, sporting or political events along the route |
Cross Border Delay | The load encountered an extended delay for crossing an international border |
Travel Ban Delay | The driver encountered national travel bans requiring a transit break |
Unattributed Transit Delay | The transit time took longer than expected given the route conditions |
Insufficient Transit Plan | The appointments did not account for sufficient transit time for the load |
Extended Dwell Time | A previous stop's dwell time has caused late arrival for subsequent stops. |
Stop Re-entry | Driver was instructed to exit and re-enter the facility at a later point |
