Carrier ETA Update

4 min

When the Carrier ETA for a load changes by 15 minutes or more, the following notification will be triggered.

Note: Carrier ETA Update will be triggered for TL, LTL, Parcel, Ocean & Air load modes. For Carrier ETA specific to Ocean & Air load modes, refer to the Stop ETA Update article.

Note: Get in touch with your Customer Success Manager at FourKites to have this callback notification enabled for your company

 {
    "Carrier": "carrierxyz",
    "EncryptedAccessToken": "VjN8Zmtud3NoaXBwZXJ8ZGVjZjEyZTctMGVmMi00NTAzLWJhYTgtYjI5MmRmYTAzYTczfFNUT1BMRVZFTHxma253c2hpcHBlcnx8ODYxMXwxODA3NA",
    "FourKitesLoadId": 8611,
    "dataSource": "fourkites-x",
    "LoadNumber": "Load123",
    "MessageType": "CARRIER_ETA_UPDATED",
    "ProNumber": null,
    "ReferenceNumbers": [
        "GLOG Refnum: C003859078",
        "9002643011-P92"
    ],
    "Scac": "FKNWTLSCAC",
    "Shipper": "shipper123",
    "StopName": "Stop XYZ",
    "StopReferenceId": null,
    "StopSequence": 2,
    "StopType": "delivery",
    "Tags": [
        "0000729113",
        "1739107469813659",
    ],
    "Timestamp": "2020-09-18T04:00:00+02:00",
    "Timezone": "Europe/Rome",
    "TimezoneOffset": 7200,
    "TimezoneShortName": "CEST"
}

Field Definitions

Field Name	Description	Key Always Present?	Value Always Present?	Data Type	Max Length
MessageType	Indicates the type of the message	Yes	Yes	String	1024
FourKitesLoadId	Unique load identifier from FourKites system	Yes	Yes	Number	20
LoadNumber	Unique shipment identifier from shipper's system	Yes	Yes	String	65535
ProNumber	Shipment's PRO #	Yes	No	Number	10
Scac	Unique SCAC of the shipper / carrier network used during load creation	Yes	Yes	Alpha/Numeric	4
Shipper	Name of the shipper as in FourKites	Yes	Yes	String	No max, but realistically, not longer than 200 characters
Carrier	Name of the carrier as in FourKites	Yes	Yes	String	1024
Tags	List of tags associated with the load (empty list when tags are not present)	Yes	No	Array of string	50 for each tag
ReferenceNumbers	List of additional reference numbers associated with the load (empty list when no reference numbers are associated with the load)	Yes	Yes	Array of string	No max
StopReferenceId	Reference ID of the stop provided during load creation	Yes	No	String	1024
StopSequence	Sequence number of the particular stop	Yes	Yes	Number	10
StopName	Name of the stop provided during load creation	Yes	Yes	String	No max
StopType	Stop type - pickup, delivery	Yes	Yes	String	1024
Timestamp	Carrier Estimated Arrival Time for the stop in stop's local time (in ISO 8601 format with local time offset to UTC)	Yes	Yes	String in DateTime format	30
TimeZone	Local Timezone of the stop in which Timestamp is specified.	Yes	Yes	String	50
TimezoneShortName	Short name of Timezone of the stop in which "Timestamp" is specified.	Yes	Yes	String	5
TimezoneOffset	Number of seconds local time zone is ahead of UTC time. Negative for Western hemisphere time zones.	Yes	Yes	[+/-]Digits	10
EncryptedAccessToken	The access token that would be used to create an encrypted URL.	Only for Delivery stops	Only for Delivery stops	String	2048

Note: By default, this callback will be sent if the Carrier ETA changes on a load by 15 minutes or more. However, if ETA Update Frequency and ETA Change Frequencies are set for your company, this callback will be sent only if the change times match the set frequencies. Below is an explanation of how ETA Update and Change Frequencies work.

ETA Change/Update Frequency

If ETA Change/Update Frequencies are set for your company, the callback will be sent only if both the following conditions are satisfied:

The change in ETA is more than the ETA Change Frequency.

Example: If you set this to 60 minutes, then you will receive a Carrier ETA Update callback only when the Carrier ETA changes by 60 minutes or more.

The time between the last sent Carrier ETA Update callback and the current time when the Carrier ETA changes is equal to or more than the Update Frequency.

Example: If you set the update frequency to 60 minutes, then you will receive a Carrier ETA Update callback only if the time between the last sent Carrier ETA Update callback and the current time when the Carrier ETA changes is 60 minutes or more.

Note: Reach out to your Customer Success Manager at FourKites to set the ETA Change Frequency and ETA Update Frequency for your company