Load Deletion

2 min

The Load Deletion callback is sent as soon as FourKites successfully deletes a load. This can be used to help reconcile other downstream systems with the confirmed FourKites deletion.

{
    "FourKitesLoadId": 126607831,
    "LoadNumber": "C95FA191",
    "MessageType": "LOAD_DELETED",
    "dataSource": "fourkites-x",
    "ProNumber": null,
    "ReferenceNumbers": [
        "8275T",
        "ref2"
    ],
    "Scac": "CC79",
    "Shipper": "cytc-company-new",
    "Tags": [
        "Temp",
        "Frozen"
    ],
    "Timestamp": "2021-06-22T14:14:57+00:00",
    "Timezone": "Etc/UTC",
    "TimezoneOffset": 0,
    "TimezoneShortName": "UTC"
}

Field Definitions

All FourKites callbacks follow a strict schema and all JSON keys will be present on all messages. The Required indicator on fields refers to whether the key can be null or empty. If marked as "O" then the following conditions are possible:

String: a literal null value will be used if the field is "O" and does not have a value

Array: an empty array [] will be used if the field is "O" and does not have any values

Integer: a literal null value will be used if the field is "O" and does not have a value

Field Name	Description	Key Always Present?	Conditions for the Key to be Present	Data Type	Max Length
FourKitesLoadId	Unique load identifier from FourKites system if the load was successfully updated (IsSuccess = true). The field will be null if the load updation failed in FourKites	Yes	Tracking ID will be mapped to FourKitesLoadId	Number	20
LoadNumber	Unique shipment identifier from shipper's system	Yes	N/A	String	65535
ProNumber	Shipment's PRO #	Yes	N/A	Number	10
ReferenceNumbers	Array of additional reference numbers associated with the load (empty list when no reference numbers are associated with the load)	Yes	N/A	Array of string	No max
Scac	SCAC or identifier for the carrier	Yes	N/A	Alpha/Numeric	4
Shipper	Unique shipper ID from FourKites	Yes	N/A	String	No max, but realistically, not longer than 200 characters
Tags	Array of tags associated with the load (empty list when tags are not present)	Yes	N/A	Array of string	50 for each tag
Timestamp	Timestamp associated with the location in the message (in ISO 8601 format in UTC)	Yes	Timestamp will be converted to UTC.	String in DateTime format	30
Timezone	Will be hard coded to "Etc/UTC" to indicate timestamp is in UTC	Yes	Timezone the event was logged. Since load deletion is not time zone specific, this will always be "Etc/UTC"	String	50
TimezoneOffset	Will be hard coded to 0	Yes	Since load deletion is not time zone specific, this will always be 0	[+/-]Digits	10
TimezoneShortName	Since load deletion is not time zone specific, this will always be "UTC"	Yes	N/A	String	5
BillofLading	It indicates the bill of lading associated with the load.	Yes	For Ocean Loads.	String	1024
BookingNumber	It indicates the shipping line's booking number.	Yes	For Ocean Loads.	String	1024
VesselName	It indicates the name of the vessel carrying the load.	Yes	For Ocean Loads.	String	1024
ContainerType	It indicates whether the container is a general, high cube, Reefer, etc., type of container.	Yes	For Ocean Loads.	String	1024
ContainerNumber	Container Number of the ocean load	Yes	For Ocean Loads.	String	1024
VoyageNumber	It indicates the unique identifier given for the voyage.	Yes	For Ocean Loads.
CreatedBy	This applies only for FourKites X loads.	Yes, if it's a FourKites X load.	The CreatedBy field will be available and sent only for FourKites X licensed customers — this is to identify between FourKites X and non FourKites X loads.	String	1024