Stop level updates
StopUpdates key can be used to provide any stop level (pickup, delivery or terminal) updates to the FourKites load. Any of the relevant fields below can be used to update the Load stop. Given “stopSequence” or “stopReferenceId” or “postalCode” - any one of these fields are mandatory required on the API request for “stopUpdate” to identify the stop of the load.
Field Specifications
Attribute | Type | Description | Example | Mandatory (M)/ Optional (O) |
|---|---|---|---|---|
appointmentTime | String | It indicates the scheduled appointment time at the stop in the stop's local timezone in ISO 8601 format | "2017-11-23T07:55:00Z" | O |
earliestAppointmentTime | String | Enter the earliest scheduled arrival time for the stop in stop's local timezone, given in ISO 8601 format. To update a stop's appointment time, the stopSequence or the stopReferenceId should also be specified. If you wish to provide a single appointment time and not a time range, use the same value here as with latestAppointmentTime | "2017-11-23T07:55:00Z" | O |
latestAppointmentTime | String | Enter the latest scheduled arrival time for the stop in stop's local timezone, given in ISO 8601 format. To update a stop's appointment time, the stopSequence or the stopReferenceId should also be specified. If you wish to provide a single appointment time and not a time range, use the same value here as with earliestAppointmentTime | "2017-11-23T07:55:00Z" | O |
stopSequence | String | Enter the stop sequence of the stop. The stopSequence is used to identify the stop for which the appointment time or status reason code is updated. Note: This stop sequence you specify should be present at the stop in the load (BOL) mentioned. For example, if you wish to update the appointment time or reason code for a stop with stop sequence 2, enter the value as 2 | "2" | M |
stopReferenceId | String | Enter the stop reference ID of the stop in the load for which the appointment time should be updated. The stopSequence is used to identify the stop for which the appointment time or status reason code is updated. Note: The stop reference ID you specify should be present at the stop in the load (BOL) mentioned. For example, if you wish to update the appointment time or reason code for a stop with stop reference id 1234, enter the value as 1234 | "1234" | M |
postalCode | String | It indicates the postal/zip code of the stop | "75201" | M |
statusCode | String | It indicates the status code for processing stop level event Note: The stopSequence or the stopReferenceId should also be specified | "AF" | O |
statusDescription | String | It indicates the status message for processing stop level event Note: The stopSequence or the stopReferenceId should also be specified | "Stop name pickedup" | O |
eventTimeStamp | String | It indicates the date time for processing stop level event Note: The stopSequence or the stopReferenceId should also be specified | "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 |