Event Update

1 min

EventUpdate key can be used for providing event or status updates to the FourKites load. Fields in eventUpdate to be used for sending an update depend on type of mode update

Single event update (i.e. Single hash of eventUpdate is allowed per one Load update in the API request, it cannot be an array (Only Exception - multiple events can be passed for Ocean mode loads in oceanDataHash)

Field Specifications

Attribute	Type	Description	Example	Mandatory (M)/ Optional (O)
statusCode	String	It indicates the load event status code	"AF"	O
statusDescription	String	It indicates the load event status message	"Picked Up"	O
statusReasonCode	String	Enter the reason codes. Currently, there are no specific codes. Carriers can add any string value. A carrier can update reason codes at a load level or stop level. To update reason codes at a stop level, the corresponding stopReferenceId or stopSequence of the stop should also be specified	"Severe_Weather_Conditions"	O
eventTimeStamp	String	The timestamp in ISO 8601 format at which carrier sends the status code or reason code. If no time stamp is received, then the current time stamp will be taken as the event time stamp.	"2017-11-23T07:55:00Z"	O
ecta	Object	Carrier can send ECTA (European Chemical Transport Association) event codes in this object key Note: This is applicable only for LTL mode loads	{ "Status": "Booking confirmation", "Timestamp": "2021-06-03T14:30:00Z", "StatusDescription": "Booking confirmation" }	O
city	String	Enter the city name of the load event	"Chicago"	O
state	String	Enter the 2 digit state code of the load event	"IL"	O
country	String	Enter the 2 digit county code	"US"	O
pickupTime	String	It indicates the time when the load was picked up Note: This is applicable only for LTL mode loads	"2017-11-23T07:55:00Z"	O
deliveryTime	String	It indicates the time when the load was delivered Note: This is applicable only for LTL mode loads	"2017-11-23T07:55:00Z"	O
delivered	boolean	Enter true or false. If the load is delivered, delivered flag should be set to true. If the load is not delivered, delivered flag need not be included. This is JSON boolean field	True or False	O
oceanDataHash	Object	Enter Ocean event tracking update if applicable in this object key Note: This is applicable only for Ocean/Intermodal mode loads Also OceanContainer is mandatory in "assignmentUpdate" Key	{ "city": "City", "state": "State Code", "country": "Country Code", "event_timezone": "UTC", "event_source": "api", "event_date_time": "YYYY-MM-DDTHH:MM:SSZ", "ocean_container_number": "ocean_container_number", "update_action": "Ocean event code" }	O
vesselLocation	String	Note: This is applicable only for Ocean/Intermodal mode loads Also OceanContainer is mandatory in "assignmentUpdate" Key		O
railEventCode	String	It indicates the rail event code Note: This is applicable for only Rail mode loads	"X6"	O
shipmentStatusIndicator	String	It indicates the status indicator of the shipment Note: This is applicable for only Rail mode loads	"X6"	O
shipmentStatus	String	It indicates the status of the shipment Note: This is applicable for only Rail mode loads	"AR"	O
failedLoads	String			O
airDataHash	Object	Enter Air event tracking update if applicable in this object key Note: This is applicable only for Air mode loads		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