Stop Deletion
When a stop is deleted for a load, the following notification will be POSTed to the callback URL.
Request Parameter
{
"Action": "DELETE",
"EarliestAppointmentTime": "2023-10-23T00:00:00.000Z",
"EarliestWantTime": "2023-10-23T23:59:59.000Z",
"EncryptedAccessToken": "VjN8ZWNvbGFifHxlY29sYWI",
"EncryptedUrl": "https://app.fourkites.com/beta/eurl/VjN8ZWNvbGFifHxlY29sYWI",
"FourKitesLoadId": 360020730,
"LatestAppointmentTime": "2023-10-23T23:59:00.000Z",
"LatestWantTime": "2023-10-23T23:59:59.000Z",
"LoadNumber": "13450532",
"MessageType": "STOP_AMEND",
"ProNumber": null,
"ReferenceNumbers": [
"13450532",
"TIBCOID: USPS202310121006",
"1016280188",
"4513400633",
"Dlvry#: 4513400633"
],
"Shipper": "ecolab",
"StopName": "FOUR POINTS HOTEL DKSHV LA INTRNTL ARPRT",
"StopPONumbers": null,
"StopReferenceId": null,
"StopReferenceNumbers": [
"Dlvry#: 4513400633",
"PO#: Kitchen - Clara",
"SO#: 133271143",
"SoldTo: 506470396",
"CustType: 3",
"ShipTo: 506470396"
],
"StopSequence": 2,
"StopStatus": null,
"StopType": "delivery",
"Timestamp": "2023-10-12T21:50:22+00:00",
"Timezone": "America/Los_Angeles",
"TimezoneOffset": -25200,
"TimezoneShortName": "PDT"
}Field Description
Field Name | Description | Key Always Present? | Value Always Present? | Data Type | Max Length |
|---|---|---|---|---|---|
Action | Indicates the action that triggered the callback. Possible values are Create/Update/Delete. | Yes | Yes | String | Max 20 |
FourKitesLoadId | Unique load identifier of the load from the FourKites system that the stop belongs to | Yes | Yes | Number | 20 |
LoadNumber | Unique shipment identifier from shipper's system | Yes | Yes | String | 65535 |
ProNumber | Shipment's PRO # | Yes | | Number | 10 |
Shipper | Unique shipper ID from FourKites | Yes | Yes | String | No max, but realistically, not longer than 200 characters |
EarliestAppointmentTime | Earliest Appointment Time of the stop. If not a window, both Earliest and Latest Appointment times will be the same. | Yes | No | String | 30 |
LatestAppointmentTime | Latest Appointment Time of the stop. If not a window, both Earliest and Latest Appointment times will be the same. | Yes | No | String | 30 |
StopPONumbers | PO Numbers associated with the stop | Yes | No | | |
StopReferenceNumbers | List of reference numbers associated with the particular stop | Yes | No | Array | no max size |
StopSequence | Sequence number of the particular stop | Yes | Yes | Number | 10 |
StopReferenceId | Reference ID of the stop provided during load creation | Yes | No | string | 1024 |
StopName | Name of the stop provided during load creation. | Yes | No | String | No max |
Timestamp | Time when one of the three actions was performed that triggered the callback | Yes | Yes | String in DateTime format | |
TimeZone | Local Timezone of the stop in which Timestamp is specified | Yes | Yes | String | 50 |
TimezoneShortName | Will be hard coded to "UTC" | Yes | Yes | String | 5 |
TimezoneOffset | Number of seconds local timezone is ahead of UTC time. Negative for western hemisphere timezones. | Yes | Yes | [+/-]Digits | 10 |
EncryptedAccessToken | The access token that would be used to create an encrypted URL. | Yes | Yes | String | 2048 |
EncryptedUrl | Encrypted URL of the stop which is unique and which can be used to access details of the stop | Only for delivery stop | Only for delivery stop | String | 1024 |
StopType | Stop type - * Pickup |
- Terminal
- port_of_loading (not common)
- transhipment_port
- port_of_discharge
- place_of_delivery
- Origin Airport
- Hub Airport
- Destination Airport
- Delivery | Yes | Yes | String | 1024 |
