Stop/Address Geofence Update
A Callback update is sent if any stop geofence is updated on a load that has not been delivered or expired.
Request Parameter
{
"FourKitesLoadId": 360426856,
"GeofencePoints": null,
"GeofenceRadius": "1610",
"LoadNumber": "44899978",
"MessageType": "STOP_GEOFENCE_UPDATE",
"ProNumber": null,
"ReferenceNumbers": [
"INDY5DT03-311INDY5DT03-311101720231330"
],
"Scac": "VNLO",
"Shipper": "ryder-lms",
"StopName": "ELSA LLC",
"StopReferenceId": "129696465",
"StopSequence": 1,
"Tags": [
"Account:Subaru",
"ProviderLoadId:",
"LoadId:LMS_44899978",
"SourceTM:LMS"
],
"Timestamp": "2023-10-11T14:37:49+00:00",
"UpdatedBy": "apiuser-4707"
}Field Description
Field Name | Description | Key Always Present? | Conditions for the Key to be Present | Data Type | Max Length |
|---|---|---|---|---|---|
LoadNumber | Unique shipment identifier from shipper's system | Yes | N/A | String | 65535 |
StopName | Name of the stop | Yes | N/A | String | No max |
Address | | Yes | N/A | | |
UpdatedBy | Indicates the user id of the user who updated the geofence. | Yes | N/A | String | 1024 |
Timezone | | Yes | N/A | String | 50 |
FourKitesLoadId | Unique load identifier from FourKites system | Yes | TrackingId will be mapped to FourKitesLoadId | Number | 20 |
ProNumber | Shipment's PRO # | Yes | N/A | Number | 10 |
Shipper | Unique shipper ID from FourKites | Yes | N/A | String | No max, but realistically, not longer than 200 characters |
Scac | SCAC of the carrier assigned to the shipment/load | Yes | N/A | Alpha/Numeric | 4 |
Tags | List of tags associated with the load (empty list when tags are not present) | Yes | N/A | 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 | N/A | Array of string | No max |
StopReferenceId | Reference ID of the stop provided during load creation | Yes | N/A | string | 1024 |
StopSequence | The stop's sequence on a load. Lower values indicate earlier scheduled stop completion. If stop sequence is present for one stop on a load, it must be present for all stops on a load. It is recommended ”but not required” to begin the stop sequence at 1 and increment by 1 for additional stops. | Yes | N/A | Number | 10 |
StopName | Name of the stop | Yes | N/A | String | No max |
GeofenceRadius | | Yes | N/A | String | |
GeofencePoints | | Yes | N/A | String | 1024 |
Timestamp | | Yes | Timestamp will be converted to UTC before getting mapped. | String in DateTime format | 30 |