Load Creation

2 min

The Load Creation callback is sent as soon as FourKites successfully creates a load. This can be used to help reconcile other downstream systems with the confirmed FourKites creation, along with saving the FourKites generated loadId (referred to in the callback as FourKitesLoadId)

{
    "EncryptedAccessToken": "VjJ8Y3l0Yy1jb21wYW55LW5ld3w0ZmQxYzBjYi00MTEyLTQ2YjYtODU5OC0xOTExNzc0MjFmYWF8Y3l0Yy1jb21wYW55LW5ldw",
    "EncryptedUrl": "https://app.fourkites.com/beta/eurl/VjJ8Y3l0Yy1jb21wYW55LW5ld3w0ZmQxYzBjYi00MTEyLTQ2YjYtODU5OC0xOTExNzc0MjFmYWF8Y3l0Yy1jb21wYW55LW5ldw",
    "Errors": [],
    "deliveryNumbers": ["DN001", "DN002"],
    "masterTrackingNumber": "MTN12345",  
    "BargeId": "IN016574",
    "BargeStatus": "false",
    "CurrentPosition": "OH 123 T",
    "FourKitesLoadId": 123654314,
    "dataSource": "fourkites-x",
    "IsSuccess": true,
    "LoadNumber": "2DB85AEB",
    "MessageType": "LOAD_CREATION",
    "ProNumber": "4638",
    "ReferenceNumbers": [
        "TU-2945",
        "80982",
        "94BC8"
    ],
    "Scac": "CC79",
    "Shipper": "cytc-company-new",
    "StorageStatus": "empty",
    "Tags": [
        "temp",
        "field2",
        "Inbound"
    ],
    "Timestamp": "2021-06-03T17:08:33+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?	Value Always Present?	Condition for Key to be Present	Data Type	Max Length
EncryptedAccessToken	A token which can be appended to a FourKites URL host to create a "shared shipment status" URL. Please contact FourKites for more information	Yes	No	N/A	String	2048
EncryptedUrl	Shared shipment status URL which provides a link to a web page showing the current status of a load. No authentication is necessary to access the link	Yes	No	If EncryptedAccessToken is present or not null we will mapped to EncryptedUrl.	String	2048
Errors	A list of any errors creating the load. If this has a list of errors it means that load creation failed and a FourKitesLoadId will not be generated	Yes	No	N/A	Array	65535
deliveryNumbers	It indicates that the load has delivery number values	No	No	If the values are available	String	No Limit
masterTrackingNumber	It indicates that the load has master tracking number value	No	No	If the value is available	String	No Limit
BargeId	It indicates the barge Load Identifier	Yes	Yes	If the load is barge load	String	No Limit
BargeStatus	It indicates barge status as true or false	Yes	No	If the load is barge load	String	No Limit
CurrentPosition	Indicates the barge Mile marker	Yes	No	If the load is barge load	String	No Limit
FourKitesLoadId	Will always be present unless there were issues creating the load. If the load was not created, the IsSuccess flag will be false and no FourKitesLoadId will be generated	Yes	No	TrackingID will be mapped to FourKitesLoadId	Int64	9
IsSuccess	Indicates whether the load was successfully created	Yes	Yes	The key will always be present, but if the load creation is unsuccessful, it will be "false".	Boolean
LoadNumber	Customer supplied Load Number. This is populated on the Create Load API	Yes	Yes	N/A	String	65535
ProNumber	PRO Number associated with the load	Yes	No	N/A	String	65535
ReferenceNumbers	List of unique identifiers for the load. These can be used to search for the load the platform	Yes	No	N/A	Array
Scac	SCAC or identifier for the carrier	Yes	No	N/A	String
Shipper	Unique permalink for the company. This is generated by FourKites and is unique for each company	Yes	No	N/A	String	No max, but realistically, not longer than 200 characters
StorageStatus	Barge storage is Full/ Empty	Yes	No	If the load is barge load	String	No limit
Tags	List of categories or labels for the load	Yes	No	N/A	Array	65535
Timestamp	Time that the load was created	Yes	Yes	Value will be in UTC	ISO8601 Date/Time
Timezone	Timezone the event was logged. Since load creation is not time zone specific, this will always be "Etc/UTC"	Yes	Yes	N/A	String
TimezoneOffset	Since load creation is not time zone specific, this will always be 0	Yes	Yes	N/A	Int32
TimezoneShortName	Since load creation is not time zone specific, this will always be "UTC"	Yes	Yes	N/A	String
BillOfLading	MBOL or HBOL provided for tracking the shipment	For Ocean Loads	For Ocean Loads	These fields will be mapped only for Ocean-specific loads.	String
BookingNumber	Booking number provided for tracking the shipment	For Ocean Loads	For Ocean Loads	N/A	String
ContainerNumber	Number of the container in which the shipment is loaded	For Ocean Loads	For Ocean Loads	N/A	String
ContainerType	Type of the container in which the shipment is loaded	For Ocean Loads	For Ocean Loads	N/A	String
VesselName	Name of the vessel the shipment is currently loaded on	For Ocean Loads	For Ocean Loads	N/A	String
VoyageNumber	Number of the voyage for the vessel the shipment is currently loaded on	For Ocean Loads	For Ocean Loads	N/A	String
ConsignmentEncryptedAccessToken		Yes	Yes	Will be mapped only if the ConsignmentEncryptedAccessToken is not null	String

Shared Shipment Status URL

One common use of the Load Creation callback is to store and share the "Share Shipment Status" URL (also referred to as the "eURL", or encrypted URL). This link is contained in the EncryptedUrl field and can be given to customers, internal users, and other personnel who may need to track a load in FourKites, but should not be accessing all of your organization's data.

By making this data available upon load creation, it is ready to share with customers and other stakeholders of the shipment in time to track the active load. Once the load starts tracking, the URL's display will automatically refresh with the latest tracking data/milestones - no need to fetch or update the URL itself.

For more information on the "Share Shipment Status" URL, please visit the product documentation: Share Shipment Status