Stop Updation

2 min

Below is a sample of the callback that will be sent when a stop is updated (Earliest Appointment Time, Latest Appointment Time, Appointment Time, Earliest Want Time, Latest Want Time, Stop Name, Stop Address, City, State, Postal Code,Stop Type, Stop Sequence, Stop Timezone)

{
  "Action": "UPDATE",
  "EarliestAppointmentTime": "2020-05-25T01:00:00.000Z",
  "EarliestWantTime": "2020-05-25T01:00:00.000Z",
  "EncryptedAccessToken": "VjN8c2hpcHBlci1iYWxhfDIxZjhmZjkhNS1hZGE2LTgyYmExOTRkZTE5Mg",
  "EncryptedUrl": "https://app-dev.fourkites.com/#/integrations/trackLoad/v2/VjN8c2hpcHBlci1iYWxhfDIxZjhmZjkhNS1hZGE2LTgyYmExOTRkZTE5Mg",
  "FourKitesLoadId": 23623,
  "LatestAppointmentTime": "2020-05-25T02:00:00.000Z",
  "LatestWantTime": "2020-05-25T02:00:00.000Z",
  "LoadNumber": "File_4180",
  "MessageType": "STOP_AMEND",
  "ProNumber": null,
  "Shipper": "shipper-bala",
  "StopName": "PS GENEVA PLANT",
  "StopPONumbers": [
    "PO123",
    "8297",
    "PO356"
  ],
  "StopReferenceId": "D101",
  "StopReferenceNumbers": [
    "ref1",
    "ref2"
  ],
  "StopSequence": 1,
  "StopType": "pickup",
  "Timestamp": "2020-03-06T10:08:55+00:00",
  "Timezone": "Central Time (US & Canada)",
  "TimezoneOffset": -21600,
  "TimezoneShortName": "CST",
  "UpdatedStopFields": [
    "StopType"
  ]
}

Field Definitions

Field Name	Description	Key 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	N/A	String	Max 20
FourKitesLoadId	Unique load identifier of the load from the FourKites system that the stop belongs to	Yes	N/A	Number	20
LoadNumber	Unique shipment identifier from shipper's system	Yes	N/A	String	65535
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
EarliestAppointmentTime	Earliest Appointment Time of the stop. If not a window, both Earliest and Latest Appointment times will be the same.	Yes	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	N/A	String	30
StopPONumbers	PO Numbers associated with the stop	Yes	N/A
StopReferenceNumbers	List of reference numbers associated with the particular stop	Yes	N/A	Array	no max size
StopSequence	Sequence number of the particular stop	Yes	N/A	Number	10
StopReferenceId	Reference ID of the stop provided during load creation	Yes	N/A	string	1024
StopName	Name of the stop provided during load creation.	Yes	N/A	String	No max
StopType	The stop type for which the ETA corresponds	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	Time when one of the three actions was performed that triggered the callback	Yes	The UpdatedAt Value will be converted to UTC and will be mapped to TimeStamp	String in DateTime format
TimeZone	Local Timezone of the stop in which Timestamp is specified	Yes	N/A	String	50
TimezoneShortName	Will be hard coded to "UTC"	Yes	N/A	String	5
TimezoneOffset	Number of seconds local timezone is ahead of UTC time. Negative for western hemisphere timezones.	Yes	N/A	[+/-]Digits	10
EncryptedAccessToken	The access token that would be used to create an encrypted URL.	Yes	N/A	String	2048
EncryptedUrl	Encrypted URL of the stop which is unique and which can be used to access details of the stop. This will be mapped only for delivery stop.	No	N/A	String	1024
UpdatedStopFields		Yes	N/A
StopAlias		Yes	N/A
EarliestWantTime		Yes	N/A	String	30 max
LatestWantTime		Yes	N/A	String	30
TerminalName		No	If it's an ocean load	String
CreatedBy	This applies only for FourKites X loads.	No		String	1024
StopUnlocode	It indicates the UNLOCODE of the stop	No	If the transportation mode is ocean or the stopType is Port of Loading, then we will create a new field called stopUnlocode.	String