Stop Created

3 min

When a stop is created for a load, the following notification will be POSTed to the callback URL.

Request Parameter

{
	"Action": "CREATE",
	"EarliestAppointmentTime": null,
	"EarliestWantTime": null,
	"EncryptedAccessToken": "VjN8ZWNvbGFifGE4MGMxYjVjLTI3ZjktNGUxZS04OTkwLTBhMjE4ZDg0ZTg4NXxlY29sYWI",
	"FourKitesLoadId": 360994999,
	"LatestAppointmentTime": null,
	"LatestWantTime": null,
	"LoadNumber": "13489382",
	"MessageType": "STOP_AMEND",
	"ProNumber": "351142173",
	"ReferenceNumbers": [
		"13489382",
		"ContID: US10",
		"TIBCOID: RNLO202310132200",
		"1016303587",
		"4513420357",
		"4513420370",
		"Dlvry#: 4513420357",
		"Dlvry#: 4513420370"
	],
	"Shipper": "test shipper",
	"StopName": "KNOXVILLE, TN",
	"StopPONumbers": null,
	"StopReferenceId": null,
	"StopReferenceNumbers": [],
	"StopSequence": 3,
	"StopStatus": "not_tracking",
	"StopType": "transfer",
	"Timestamp": "2023-10-12T21:52:01+00:00",
	"Timezone": null,
	"TimezoneOffset": 0,
	"TimezoneShortName": "UTC"
}

Field Description

Field Name	Description	Key Always Present?	Value Always Present?	Conditions for the Key to be present	Data Type	Max Length
Action	Indicates the action that triggered the callback. Possible values are Create/Update/Delete.	Yes	Yes	N/A	String	Max 20
FourKitesLoadId	Unique load identifier of the load from the FourKites system that the stop belongs to	Yes	Yes	N/A	Number	20
LoadNumber	Unique shipment identifier from shipper's system	Yes	Yes	N/A	String	65535
ProNumber	Shipment's PRO #	Yes	No	N/A	Number	10
Shipper	Unique shipper ID from FourKites	Yes	Yes	N/A	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	N/A	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	N/A	String	30
StopPONumbers	PO Numbers associated with the stop	Yes	No	N/A
StopReferenceNumbers	List of reference numbers associated with the particular stop	Yes	No	N/A	Array	no max size
StopSequence	Sequence number of the particular stop	Yes	Yes	N/A	Number	10
StopReferenceId	Reference ID of the stop provided during load creation	Yes	No	N/A	string	1024
StopName	Name of the stop provided during load creation.	Yes	No	N/A	String	No max
StopType	The stop type for which the ETA corresponds	Yes	Yes	1. If the transportation mode is ocean and if the stopType is pickup, it will be mapped as Port of Loading 2. If the stopType is transfer for an Ocean load, it will be mapped as TranshipmentPort. 3. If the load is Air, and if the stopType is pickup then the field will be mapped as as origin airport. 4. If the load is Air, and if the stopType is Delivery then the field will be mapped as destination airport. 5. If the load is Air, and if the stopType is transfer then the field will be mapped as hub airport. 6. If the transportation mode is not ocean and air, it will be mapped directly to the value sent by the customer during load creation.	String	1024
Timestamp		Yes	Yes	N/A	String in DateTime format
TimeZone		Yes	Yes	N/A	String	50
TimezoneShortName		Yes	Yes	N/A	String	5
TimezoneOffset	Number of seconds local timezone is ahead of UTC time. Negative for western hemisphere timezones.	Yes	Yes	N/A	[+/-]Digits	10
EncryptedAccessToken	The access token that would be used to create an encrypted URL.	Yes	Yes	N/A	String	2048
EncryptedUrl		Only for delivery stop	Only for delivery stop	Only if the delivery stop is created then we will mark the encryptedURL.	String	1024
StopStatus		No	No	N/A
EarliestWantTime		Yes	No	N/A	String	30 max
LatestWantTime		Yes	No	N/A	String	30
stopUnlocoded	It indicates the UNLOCODE of the stop	No	No	If the transportation mode is ocean or the stopType is Port of Loading, then we will create a new field called stopUnlocode.	String
ReferenceNumbers	Array of additional reference numbers associated with the load (empty list when no reference numbers are associated with the load)		No	N/A	Array	no max