Location Update
LocationUpdate key can be used for providing latest GPS coordinates updates to the FourKites load. latitude, longitude, and locatedAt - combined are mandatory fields when updating Location data. deliveredAt field if populated - will mark the Load as delivered completely and cannot be updated afterwards
Single GPS update (i.e. Single hash of locationUpdate) is allowed per one Load update in the API request, it cannot be an array.
Field Specifications
Attribute | Type | Description | Example | Mandatory (M)/ Optional (O) |
|---|---|---|---|---|
latitude | String | Enter the latitude of the truck's current location The only accepted format of lat/long by FOURKITES® is the "Decimal Degrees" format. For example, 41.8781 (lat) and -87.6298 (long) | "41.898274" | M |
longitude | String | Enter the longitude of the truck's current location The only accepted format of lat/long by FOURKITES® is the "Decimal Degrees" format. For example, 41.8781 (lat) and -87.6298 (long) | "-88.028452" | M |
locatedAt | String | Enter the timestamp at which the latitude and longitude values were recorded for location. This field is usually given along with the latitude/longitude values. If no value is given, the current time will be considered as locatedAt value | "2017-11-23T07:55:00Z" | M |
city | String | Enter the city name of the truck's current location | "Chicago" | O |
state | String | Enter the 2 digit state code of the truck location | "IL" | O |
deliveredAt | String | Enter the time at which the shipment was delivered at the final consignee, given in ISO 8601 format. This value is usually provided to indicate that a load was delivered. If no value is given, deliveredAt will default to the current time | "2017-11-23T07:55:00Z" | O |
timeZone | String | It indicates the current time zone of "ALL" the provided datetime update If value not provided, then the time zone of the timestamp will be UTC by default | "UTC" | O |