---
title: Callbacks Data Dictionary Table
slug: fourkites-api-reference/callbacks-data-dictionary-table
createdAt: 2026-08-12T11:47:36.000Z
---
| Callback | MessageType | Field Name | Description | Key Always Present? | Value Always Present? | Condition for Key to be Present | Data Type | Max Length | Default Value |
| --------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ | ------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------ | ------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------- | --------------------------------------------------------- | ------------------------- |
| Stop File Upload | STOP\_FILE\_UPLOAD | DocumentType | Type of file that was uploaded. Possible values are "Proof Of Delivery" for POD and "Return Receipt" for Return Orders. | Yes | No | | String | 50 | |
| Stop File Upload | STOP\_FILE\_UPLOAD | FileUrl | Url for downloading/viewing the file. This Url will be active only for 24 hours and the customers are advised to download the file as soon as they receive this message instead of relying on the Url. | Yes | Yes | The value could just be File URL for some, and depending on the ask, it could be File URL and base64. | String containing url | 2048 | Always non empty |
| Stop File Upload | STOP\_FILE\_UPLOAD | FourKitesLoadId | Unique load identifier from FourKites system if the load was successfully created (IsSuccess = true). The field will be null if the load creation failed in FourKites | Yes | Yes | TrackingID will be mapped to FourKitesLoadId | Number | 20 | |
| Stop File Upload | STOP\_FILE\_UPLOAD | LoadNumber | Unique shipment identifier from shipper's system | Yes | Yes | | | 65535 | Always required from user |
| Stop File Upload | STOP\_FILE\_UPLOAD | ProNumber | Shipment's PRO # | Yes | No | | Number | 10 | |
| Stop File Upload | STOP\_FILE\_UPLOAD | ReferenceNumbers | List of additional reference numbers associated with the load (empty list when no reference numbers are associated with the load) | Yes | No | | Array of string | No max | |
| Stop File Upload | STOP\_FILE\_UPLOAD | Scac | Scac of the Carrier | Yes | No | | Alpha/Numeric | 4 | |
| Stop File Upload | STOP\_FILE\_UPLOAD | Shipper | Unique shipper ID from FourKites | Yes | No | | Alpha/Numeric | No max, but realistically, not longer than 200 characters | Shipper Name |
| Stop File Upload | STOP\_FILE\_UPLOAD | SignerName | | Yes | No | | String | 65535 | |
| Stop File Upload | STOP\_FILE\_UPLOAD | StopName | Name of the stop provided during load creation. | Yes | Yes | | Alpha/Numeric | No max, but realistically, not longer than 200 characters | |
| Stop File Upload | STOP\_FILE\_UPLOAD | StopReferenceId | | Yes | No | | String | 65535 | null |
| Stop File Upload | STOP\_FILE\_UPLOAD | StopReferenceNumbers | List of reference numbers associated with the particular stop | Yes | No | | Array of string | No max | |
| Stop File Upload | STOP\_FILE\_UPLOAD | StopSequence | Stop Sequence - 1 | Yes | No | | int | 5 | Always non empty |
| Stop File Upload | STOP\_FILE\_UPLOAD | StopType | Stop type - pickup, delivery | Yes | Yes | | String | 50 | Always present |
| Stop File Upload | STOP\_FILE\_UPLOAD | Tags | List of tags associated with the load (empty list when tags are not present) | Yes | No | | Array of string | 50 for each tag | \[] |
| Stop File Upload | STOP\_FILE\_UPLOAD | Timestamp | Time when the file was uploaded for the stop in CarrierLink in stop's local time (in ISO 8601 format with local time offset to UTC) | Yes | No | uploadedAt time will be mapped to Timestamp. If there is no timezone, the Timestamp field will be blank. | String in DateTime format | 30 | |
| Stop File Upload | STOP\_FILE\_UPLOAD | Timezone | Local Timezone of the stop in which Timestamp is specified. | Yes | No | | String | 50 | |
| Stop File Upload | STOP\_FILE\_UPLOAD | TimezoneOffset | Number of seconds local time zone is ahead of UTC time. Negative for western hemisphere time zones. | Yes | No | | \[+/-]Digits | 10 | Always non empty |
| Stop File Upload | STOP\_FILE\_UPLOAD | TimezoneShortName | Short name of Timezone of the stop in which "Timestamp" is specified. | Yes | No | If Timestamp or Timezone is nil then TimezoneShortName will be empty | String | 5 | |
| Stop File Upload | STOP\_FILE\_UPLOAD | CreatedBY | CreatedBy field is specific to FourKites X. | | | 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 | 65535 | Always non empty |
| Load Creation | LOAD\_CREATION | 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 | | String | 2048 | Always non empty |
| Load Creation | LOAD\_CREATION | 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 the EncryptedAccessToken is present then the EncryptedUrl field will also be present. | String | 2048 | Always non empty |
| Load Creation | LOAD\_CREATION | 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 | | Array | 65535 | |
| Load Creation | LOAD\_CREATION | 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 | Number | 20 | |
| Load Creation | LOAD\_CREATION | 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 | | FALSE |
| Load Creation | LOAD\_CREATION | LoadNumber | Customer supplied Load Number. This is populated on the Create Load API | Yes | Yes | | String | | Always present |
| Load Creation | LOAD\_CREATION | ProNumber | PRO Number associated with the load | Yes | No | | String | | null |
| Load Creation | LOAD\_CREATION | ReferenceNumbers | List of unique identifiers for the load. These can be used to search for the load the platform | Yes | No | | Array | | Empty Array |
| Load Creation | LOAD\_CREATION | Scac | SCAC or identifier for the carrier | Yes | No | | String | | null |
| Load Creation | LOAD\_CREATION | Shipper | Unique permalink for the company. This is generated by FourKites and is unique for each company | Yes | No | | String | | Shipper Name |
| Load Creation | LOAD\_CREATION | Tags | List of categories or labels for the load | Yes | No | | Array | | Empty Array |
| Load Creation | LOAD\_CREATION | Timestamp | Time that the load was created | Yes | Yes | Value will be in UTC | ISO8601 Date/Time | | |
| Load Creation | LOAD\_CREATION | Timezone | Timezone the event was logged. Since load creation is not time zone specific, this will always be "Etc/UTC" | Yes | Yes | | String | | |
| Load Creation | LOAD\_CREATION | TimezoneOffset | Since load creation is not time zone specific, this will always be 0 | Yes | Yes | | Int32 | 10 | Always non empty |
| Load Creation | LOAD\_CREATION | TimezoneShortName | Since load creation is not time zone specific, this will always be "UTC" | Yes | Yes | | String | | |
| Load Creation | LOAD\_CREATION | 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 | | null |
| Load Creation | LOAD\_CREATION | BookingNumber | Booking number provided for tracking the shipment | For Ocean Loads | For Ocean Loads | | String | | null |
| Load Creation | LOAD\_CREATION | ContainerNumber | Number of the container in which the shipment is loaded | For Ocean Loads | For Ocean Loads | | String | | null |
| Load Creation | LOAD\_CREATION | ContainerType | Type of the container in which the shipment is loaded | For Ocean Loads | For Ocean Loads | | String | | |
| Load Creation | LOAD\_CREATION | VesselName | Name of the vessel the shipment is currently loaded on | For Ocean Loads | For Ocean Loads | | String | | |
| Load Creation | LOAD\_CREATION | VoyageNumber | Number of the voyage for the vessel the shipment is currently loaded on | For Ocean Loads | For Ocean Loads | | String | | null |
| Load Creation | LOAD\_CREATION | ConsignmentEncryptedAccessToken | | Yes | Yes | Will be mapped only if the ConsignmentEncryptedAccessToken is not null | String | | Always non empty |
| Location Update | LOCATION\_UPDATE | City | Nearest city to the location update. Will be approximate if not an exact location | Yes | No | | String | | |
| Location Update | LOCATION\_UPDATE | Country | Country associated with the location update | Yes | No | | String | | |
| Location Update | LOCATION\_UPDATE | FourKitesLoadId | FourKites generated unique Load ID | Yes | No | TrackingId will be mapped to FourKitesLoadId | Number | 20 | |
| Location Update | LOCATION\_UPDATE | Latitude | Decimal latitude of the location update | Yes | Yes | | Int64 | | |
| Location Update | LOCATION\_UPDATE | LoadNumber | Customer supplied Load Number. This is populated on the Create Load API | Yes | Yes | | String | | Always Present |
| Location Update | LOCATION\_UPDATE | Location | The name of the current location. Oftentimes this is supplied by the carrier, but can also be the latitude/longitude coordinates if not supplied | Yes | Yes | | String | | |
| Location Update | LOCATION\_UPDATE | Longitude | Decimal longitude of the location update | Yes | Yes | | Int64 | | |
| Location Update | LOCATION\_UPDATE | OdometerReading | Odometer reading associated with the check call (provided only for loads moved by dedicated carriers) | Yes | No | | | | |
| Location Update | LOCATION\_UPDATE | ProNumber | PRO Number associated with the load | Yes | No | | String | | |
| Location Update | LOCATION\_UPDATE | ReferenceNumbers | List of unique identifiers for the load. These can be used to search for the load the platform | Yes | No | | String | | \[] |
| Location Update | LOCATION\_UPDATE | Scac | SCAC or identifier for the carrier | Yes | No | | String | | |
| Location Update | LOCATION\_UPDATE | Shipper | Unique permalink for the company. This is generated by FourKites and is unique for each company | Yes | No | | String | | Shipper Name |
| Location Update | LOCATION\_UPDATE | State | State/province associated with the location update | Yes | No | | String | | Always non empty |
| Location Update | LOCATION\_UPDATE | Tags | List of categories or labels for the load | Yes | No | | Array | 50 for each tag | \[] |
| Location Update | LOCATION\_UPDATE | Timestamp | Time that the location update was received. This will be in the local time of the location ping | Yes | Yes | The LocatedAt time will be mapped to Timestamp after converting it to customer specific Timezone. | ISO8601 Date/Time | | |
| Location Update | LOCATION\_UPDATE | Timezone | Time zone in which the location was logged | Yes | Yes | | String | | |
| Location Update | LOCATION\_UPDATE | TimezoneOffset | Numeric offset (in seconds) of the time zone in which the location was logged | Yes | No | This will be mapped based on the Timestamp received. The Timestamp will be converted to a specific timezone and will be mapped to TimezoneOffset | Int32 | | Always non empty |
| Location Update | LOCATION\_UPDATE | TimezoneShortName | Time zone short name in which the location was logged | Yes | No | If Timestamp or Timezone is nil then TimezoneShortName will be empty | String | | |
| Location Update | LOCATION\_UPDATE | StatusCode | | No | Yes | Carrier should not be null and the field parcel provider should not be null. If it is not null, StatusCode key will be present in the callback payload and the value will always be X6. | String | 1024 | Always non empty |
| Location Update | LOCATION\_UPDATE | deviceID | DeviceID assigned to the load | No | No | For the deviceID field to be present, the tracking method should be received as device id from the customer. Only in that case, the device id will be mapped. | String | | |
| Location Update | LOCATION\_UPDATE | ReportingRailroad | | No | No | ReportingRailRoad will be mapped based on the additional data received from the customer -- this should not be be null. This is a feature\_flag | String | 4 at max | null |
| Location Update | LOCATION\_UPDATE | LoadedEmpty | Rail car loaded empty | No | No | LoadedEmpty field will be mapped based on the additional data & Loaded/Empty status from the customer -- this should not be be null. This is a feature\_flag | String | | |
| Location Update | LOCATION\_UPDATE | RailStation | Latest Rail Station on the load | No | No | RailStation field will be mapped based on the additional data & station name from the customer -- this should not be be null. This is a feature\_flag | String | | |
| Location Update | LOCATION\_UPDATE | TrainID | Train's Unique ID | No | No | TrainID will be mapped based on the additional data & trainID from the customer -- this should not be be null. This is a feature\_flag | String | | |
| Location Update | LOCATION\_UPDATE | RailEventCode | | No | No | RailEventCode will be mapped based on the additional data & event code from the customer -- this should not be be null. This is a feature\_flag | String | | |
| Location Update | LOCATION\_UPDATE | RailDestinationStation | Rail destination stop name given on the load | No | No | RailDestinationStation will be mapped based on the additional data & destinationCity from the customer -- this should not be be null. This is a feature\_flag | String | 30 at max | |
| Location Update | LOCATION\_UPDATE | RailDestinationState | Destination State of the rail leg of the load | No | No | RailDestinationState will be mapped based on additional data & destinationState from the customer -- this should not be be null. This is a feature\_flag | String | 2 at max | |
| Location Update | LOCATION\_UPDATE | ReceivedDateTime | | No | No | ReceivedDateTime will be mapped based on the additional data & sentTimeStamp from the customer -- this should not be be null. This is a feature\_flag | String | | |
| Location Update | LOCATION\_UPDATE | RailEvent | Latest Rail Event on the load | No | No | - feature\_flag | String | 4 at max | |
| Location Update | LOCATION\_UPDATE | RailEquipment | Rail Equipment Number assigned to the load | No | No | RailEquipment will be mapped if railEquipmentIntials & RailEquipmentNumber are received from the customer -- this should not be be null. Provided the fields received are hyphenated. - feature\_flag | | | |
| Location Update | LOCATION\_UPDATE | BookingNumber | Booking number provided for tracking the shipment | Yes | Yes | These keys will be present only for Ocean-specific loads. | String | 1024 | null |
| Location Update | LOCATION\_UPDATE | VoyageNumber | Number of the voyage for the vessel the shipment is currently loaded on | Yes | Yes | | String | | null |
| Location Update | LOCATION\_UPDATE | VesselName | Name of the vessel the shipment is currently loaded on | Yes | Yes | | String | | null |
| Location Update | LOCATION\_UPDATE | ContainerType | Type of the container in which the shipment is loaded | Yes | Yes | | String | 1024 | null |
| Location Update | LOCATION\_UPDATE | ContainerNumber | Number of the container in which the shipment is loaded | Yes | Yes | | String | 1024 | null |
| Location Update | LOCATION\_UPDATE | BillOfLading | MBOL or HBOL provided for tracking the shipment | Yes | Yes | | String | 1024 | null |
| Location Update | LOCATION\_UPDATE | Country | | Yes | No | | String | | |
| Location Update | LOCATION\_UPDATE | CreatedBY | This applies only for FourKites X loads. | | | 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 | Always non empty |
| Stop ETA Updated | STOP\_ETA\_UPDATED | FourKitesLoadId | FourKites generated unique Load ID | Yes | No | TrackingID will mapped to FourKites Load ID | Number | 20 | |
| Stop ETA Updated | STOP\_ETA\_UPDATED | LoadNumber | Customer supplied Load Number. This is populated on the Create Load API | Yes | No | | String | | Always Present |
| Stop ETA Updated | STOP\_ETA\_UPDATED | ProNumber | PRO Number associated with the load | Yes | No | | String | | |
| Stop ETA Updated | STOP\_ETA\_UPDATED | ReferenceNumbers | List of unique identifiers for the load. These can be used to search for the load the platform | Yes | No | | Array of string | no max | null |
| Stop ETA Updated | STOP\_ETA\_UPDATED | Scac | SCAC or identifier for the carrier | Yes | No | | String | | |
| Stop ETA Updated | STOP\_ETA\_UPDATED | Shipper | Unique permalink for the company. This is generated by FourKites and is unique for each company | Yes | Yes | | String | | Shipper Name |
| Stop ETA Updated | STOP\_ETA\_UPDATED | StopName | Stop name which had the ETA updated (the stop for which the ETA corresponds) | Yes | Yes | | String | | |
| Stop ETA Updated | STOP\_ETA\_UPDATED | StopReferenceId | The stop reference ID for which the ETA corresponds | Yes | No | | String | | null |
| Stop ETA Updated | STOP\_ETA\_UPDATED | StopSequence | The stop sequence for which the ETA corresponds. Depending upon whether your organization is creating loads with a stop sequence as an integer or string, that will determine what value is exported back out on the callback | Yes | No | | int | | Always non empty |
| Stop ETA Updated | STOP\_ETA\_UPDATED | StopStatus | Status of the current stop the ETA was calculated for. Valid values: on\_track \| delayed \| at\_facility \| completed | Yes | No | | String | | not\_tracking |
| Stop ETA Updated | STOP\_ETA\_UPDATED | StopType | The stop type for which the ETA corresponds | Yes | No | 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 | | Always present |
| Stop ETA Updated | STOP\_ETA\_UPDATED | Tags | List of categories or labels for the load | Yes | No | | Array of string | | \[] |
| Stop ETA Updated | STOP\_ETA\_UPDATED | TerminalName | Terminal within the port at which the container will be discharged | Yes | No | | String | | |
| Stop ETA Updated | STOP\_ETA\_UPDATED | Timestamp | The new ETA for the stop. NOTE: this is different from other callbacks as this is not when the ETA was generated, but it is the ETA itself | Yes | No | Timestamp will be in stop's local time. EstimatedArrivalTime is the required field that will be mapped to Timestamp. | String in DateTime format | | |
| Stop ETA Updated | STOP\_ETA\_UPDATED | Timezone | Time zone of the ETA. This will be in the local time of the stop | Yes | No | The timezone of the stop's location | String | | |
| Stop ETA Updated | STOP\_ETA\_UPDATED | TimezoneOffset | Numeric time zone offset (in seconds) of the ETA. This will be in the local time of the stop | Yes | No | | \[+/-]Digits | | Always non empty |
| Stop ETA Updated | STOP\_ETA\_UPDATED | TimezoneShortName | Time zone short name of the ETA. This will be in the local time of the stop | Yes | No | | String | | |
| Stop ETA Updated | STOP\_ETA\_UPDATED | 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 | Only for Delivery stops | Only for Delivery stops | To map this field the EncryptedAccessToken should not be null and stop type should be delivery. | String | 2048 | Always non empty |
| Stop ETA Updated | STOP\_ETA\_UPDATED | EncryptedUrl | Encrypted URL of the load which is unique and which can be used to access details of the load | Only for Delivery stops | Only for Delivery stops | Only if the delivery stop is created then we will mark the encryptedURL. - feature\_flag | String containing url | 2048 | Always non empty |
| Stop ETA Updated | STOP\_ETA\_UPDATED | StopUnlocode | It indicates the UNLOCODE of the stop | No | No | - If the transportation mode is ocean or the stopType is Port of Loading, then a new field called stopUnlocode will be mapped. Along with it, if the stop type is place of receipt or place of delivery, the StopAddressId field will be mapped to StopUnlocode.
- UNLOCODE will NOT be populated for Delivery stoptype
- In rare instances where the location is unavailable in FourKites' address master, UNLOCODE might be “null” | String | | Always non empty |
| Stop ETA Updated | STOP\_ETA\_UPDATED | StopReferenceNumbers | List of reference numbers associated with the particular stop | Yes | No | Only for the licensed customers. | Array of string | | \[] |
| Stop ETA Updated | STOP\_ETA\_UPDATED | Latitude | Decimal latitude of the location update | No | No | This is a feature flag. TrackingStatus should not be null and LatestLocation should not be null. Submit a support case here to leverage. | String | | |
| Stop ETA Updated | STOP\_ETA\_UPDATED | Longitude | Decimal longitude of the location update | No | No | | String | | |
| Stop ETA Updated | STOP\_ETA\_UPDATED | CheckCallTime | | No | No | | String in DateTime format | | |
| Stop ETA Updated | STOP\_ETA\_UPDATED | TimeZoneName | | No | No | | String | | |
| Stop ETA Updated | STOP\_ETA\_UPDATED | FourKitesStopID | | No | No | This is a feature flag. Will be directly mapped if the customer is licensed for it. | int64 | | |
| Stop ETA Updated | STOP\_ETA\_UPDATED | ETAType | Indicates whether the updated ETA is Carrier ETA or FourKites ETA | Yes, for Ocean & Air loads | Yes, for Ocean & Air loads | If the event message is received as multiple ETA enabled companies -- then the field will be mapped as ETAType | String | | |
| Stop ETA Updated | STOP\_ETA\_UPDATED | CarrierETA | | Yes | Yes | CarrierETA will be converted to specific timezone before getting mapped | ISO8601 Date/Time | | |
| Stop ETA Updated | STOP\_ETA\_UPDATED | Confidence | Percentage of confidence for the ETA. Only applies to delivery stop ETAs and will only be present in the payload if the Enterprise with AI package has been purchased. | No | No | If the eta confidence is not null then this key will be mapped. | String | | |
| Stop ETA Updated | STOP\_ETA\_UPDATED | OdometerReading | Odometer reading associated with the check call (provided only for loads moved by dedicated carriers) | No | No | OdometerReading field will be available on an as needed basis. If you'd like to receive this field in the callback, please submit a case. | | | null |
| Stop ETA Updated | STOP\_ETA\_UPDATED | CreatedBY | This applies only for FourKites X loads. | Yes | Yes | 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 | | Always non empty |
| Stop ETA Updated | STOP\_ETA\_UPDATED | DeviceID | DeviceID assigned to the load | No | No | Feature Flag. It will be mapped directly if the customer is licensed for it. | String | | |
| Stop ETA Updated | STOP\_ETA\_UPDATED | VehicleNumber | | No | No | These fields will be mapped if the load mode is Air. | String | | |
| Stop ETA Updated | STOP\_ETA\_UPDATED | Mode | | No | No | | String | | |
| Stop ETA Updated | STOP\_ETA\_UPDATED | 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 | | null |
| Stop ETA Updated | STOP\_ETA\_UPDATED | BookingNumber | Booking number provided for tracking the shipment | For Ocean Loads | For Ocean Loads | | String | | null |
| Stop ETA Updated | STOP\_ETA\_UPDATED | ContainerNumber | Number of the container in which the shipment is loaded | For Ocean Loads | For Ocean Loads | | String | | null |
| Stop ETA Updated | STOP\_ETA\_UPDATED | ContainerType | Type of the container in which the shipment is loaded | For Ocean Loads | For Ocean Loads | | String | | |
| Stop ETA Updated | STOP\_ETA\_UPDATED | VesselName | Name of the vessel the shipment is currently loaded on | For Ocean Loads | For Ocean Loads | | String | | null |
| Stop ETA Updated | STOP\_ETA\_UPDATED | VoyageNumber | Number of the voyage for the vessel the shipment is currently loaded on | For Ocean Loads | For Ocean Loads | | String | | null |
| Tracking Update | TRACKING\_UPDATE | LoadNumber | Unique shipment identifier from shipper's system | Yes | Yes | | String | | Always Present |
| Tracking Update | TRACKING\_UPDATE | Message | Indicates the tracking update details. For example, "Driver \*8221 assigned for tracking" | Yes | Yes | If Status = Driver Assigned, a field called Message will be mapped. | String | 1024 | Always non empty |
| Tracking Update | TRACKING\_UPDATE | ProNumber | Shipment's PRO # | Yes | No | | String | | |
| Tracking Update | TRACKING\_UPDATE | ReferenceNumbers | List of additional reference numbers associated with the load (empty list when no reference numbers are associated with the load) | Yes | No | | Array | | null |
| Tracking Update | TRACKING\_UPDATE | Scac | Scac of the carrier assigned to the shipment/load | Yes | No | | String | | |
| Tracking Update | TRACKING\_UPDATE | Shipper | Unique permalink for the company. This is generated by FourKites and is unique for each company | Yes | Yes | | String | | Shipper Name |
| Tracking Update | TRACKING\_UPDATE | Status | | Yes | Yes | | String | | Always non empty |
| Tracking Update | TRACKING\_UPDATE | StopName | Name of the stop provided during load creation | Yes | No | | String | | |
| Tracking Update | TRACKING\_UPDATE | Tags | List of tags associated with the load (empty list when tags are not present) | Yes | No | Default value is UTC | Array | | \[] |
| Tracking Update | TRACKING\_UPDATE | Timestamp | The time in UTC when the callback was triggered | Yes | Yes | | ISO8601 Date/Time | | |
| Tracking Update | TRACKING\_UPDATE | FourKitesLoadId | Unique load identifier from the FourKites system | Yes | No | | Number | 20 | |
| Tracking Update | TRACKING\_UPDATE | DeviceID | DeviceID assigned to the load | No | No | Feature Flag. It will be mapped directly if the customer is licensed for it. | String | | |
| Tracking Update | TRACKING\_UPDATE | StatusCode | | No | No | FeatureFlag. Mapping it EDI Status Code field | String | | Always non empty |
| Tracking Update | TRACKING\_UPDATE | CreatedBY | This applies only for FourKites X loads. | Yes | Yes | 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 | | Always non empty |
| Tracking Update | TRACKING\_UPDATE | 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 | No | No | Only if the status is Container Assigned, we will be mapping it EncryptedUrl | String containing url | | Always non empty |
| Tracking Update | TRACKING\_UPDATE | BookingNumber | Booking number provided for tracking the shipment | No | No | Ocean | String | | null |
| Tracking Update | TRACKING\_UPDATE | VoyageNumber | Number of the voyage for the vessel the shipment is currently loaded on | No | No | | String | | null |
| Tracking Update | TRACKING\_UPDATE | VesselName | Name of the vessel the shipment is currently loaded on | No | No | | String | | null |
| Tracking Update | TRACKING\_UPDATE | ContainerType | Type of the container in which the shipment is loaded | No | No | | String | | null |
| Tracking Update | TRACKING\_UPDATE | ContainerNumber | Number of the container in which the shipment is loaded | No | No | | String | | null |
| Tracking Update | TRACKING\_UPDATE | BillOfLading | MBOL or HBOL provided for tracking the shipment | No | No | | String | | null |
| Stop Arrival | STOP\_ARRIVAL | FourKitesLoadId | | Yes | No | | Number | 20 | |
| Stop Arrival | STOP\_ARRIVAL | LoadNumber | Customer supplied Load Number. This is populated on the Create Load API | Yes | No | | String | | Always Present |
| Stop Arrival | STOP\_ARRIVAL | ProNumber | PRO Number associated with the load | Yes | No | | String | | |
| Stop Arrival | STOP\_ARRIVAL | ReferenceNumbers | List of unique identifiers for the load. These can be used to search for the load the platform | Yes | No | | Array of string | | null |
| Stop Arrival | STOP\_ARRIVAL | Scac | SCAC or identifier for the carrier | Yes | No | | String | | |
| Stop Arrival | STOP\_ARRIVAL | Shipper | Unique permalink for the company. This is generated by FourKites and is unique for each company | Yes | No | | String | | Shipper Name |
| Stop Arrival | STOP\_ARRIVAL | StopName | Stop name which was just arrived at | Yes | Yes | | String | | |
| Stop Arrival | STOP\_ARRIVAL | StopReferenceId | Unique identifier for the stop. This identifier is defined when creating the load | Yes | No | | String | | null |
| Stop Arrival | STOP\_ARRIVAL | StopSequence | Stop sequence of the stop which was just arrived at. Depending upon whether your organization is creating loads with a stop sequence as an integer or string, that will determine what value is exported back out on the callback | Yes | No | | int | | Always non empty |
| Stop Arrival | STOP\_ARRIVAL | StopStatus | Status of the current stop. When delivered on the Stop Arrival callback, this value will most often be "at\_facility" | Yes | No | | String | | |
| Stop Arrival | STOP\_ARRIVAL | StopType | Type of stop which was just arrived at. Can be one of the following values:
- pickup
- delivery
- port\_of\_loading
- port\_of\_discharge
- originAirport
- destinationAirport | Yes | No | 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 | | Always present |
| Stop Arrival | STOP\_ARRIVAL | Tags | List of categories or labels for the load | Yes | No | | Array of string | | \[] |
| Stop Arrival | STOP\_ARRIVAL | Timestamp | Time that the stop was arrived at. This will be in the local time of the stop | Yes | Yes | The ArrivedAt field will be converted to specific timezone and will mapped as Timestamp. | String in DateTime format | | |
| Stop Arrival | STOP\_ARRIVAL | Timezone | Time zone of the stop | Yes | Yes | | String | | |
| Stop Arrival | STOP\_ARRIVAL | TimezoneOffset | Numeric offset (in seconds) of the stop's time zone | Yes | No | Depends on timestamp, if the timestamp is empty/null, it will not be mapped. | \[+/-]Digits | | Always non empty |
| Stop Arrival | STOP\_ARRIVAL | TimezoneShortName | Time zone short name of the stop | Yes | No | If Timestamp or Timezone is nil then TimezoneShortName will be empty | String | | |
| Stop Arrival | STOP\_ARRIVAL | EncryptedAccessToken | A token which can be appended to a FourKites URL host to create a "shared shipment status" URL for the specific delivery stop. Please contact FourKites for more information | No | No | If encrypted access token is not null and stoptype is delivery the field EncryptedAccessToken will be mapped. | String | | Always non empty |
| Stop Arrival | STOP\_ARRIVAL | EncryptedURL | Encrypted URL of the load which is unique and which can be used to access details of the load | No | No | If the StopType is delivery then the EncryptedURL field based on a license. Feature Flag | String containing url | | Always non empty |
| Stop Arrival | STOP\_ARRIVAL | StopUnlocode | It indicates the UNLOCODE of the stop | No | No | If the transportation mode is ocean, and the stoptype is port of loading, port of discharge and transhipment port, then the field StopAddressID will be mapped as StopUnlocode. | String | | |
| Stop Arrival | STOP\_ARRIVAL | StopReferenceNumbers | | No | No | Feature Flag. It will be mapped directly if the customer is licensed for it. | String containing url | | \[] |
| Stop Arrival | STOP\_ARRIVAL | OdometerReading | | No | No | Will be mapped only based on the Odometer field received with the reading. If it is null, it will not be mapped. | | | null |
| Stop Arrival | STOP\_ARRIVAL | BookingNumber | Booking number provided for tracking the shipment | Yes | Yes | For Ocean Loads. | String | | null |
| Stop Arrival | STOP\_ARRIVAL | VoyageNumber | Number of the voyage for the vessel the shipment is currently loaded on | Yes | Yes | | String | | null |
| Stop Arrival | STOP\_ARRIVAL | VesselName | Name of the vessel the shipment is currently loaded on | Yes | Yes | | String | | null |
| Stop Arrival | STOP\_ARRIVAL | ContainerType | Type of the container in which the shipment is loaded | Yes | Yes | | String | | null |
| Stop Arrival | STOP\_ARRIVAL | ContainerNumber | Number of the container in which the shipment is loaded | Yes | Yes | | String | | null |
| Stop Arrival | STOP\_ARRIVAL | BillOfLading | MBOL or HBOL provided for tracking the shipment | Yes | Yes | | String | | null |
| Stop Arrival | STOP\_ARRIVAL | TerminalName | It indicates the terminal inside a port where the vessel is berthing (terminal name tied to a stop).
Applicable for messages tied to following stoptypes:
- port\_of\_loading
- transhipment\_port
- port\_of\_discharge | Yes | Yes | | String | | |
| Stop Arrival | STOP\_ARRIVAL | CreatedBy | This applies only for FourKites X loads. | Yes, if it's a FourKites X Load. | 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 | | Always non empty |
| Stop Departure | STOP\_DEPARTURE | AutoDeparture | In rare cases, we receive arrival but not departure info for the final delivery stop on a load. When this happens, FourKites marks these stops as completed by auto-departure. This is a boolean value: true/false. | Yes | No | | | | |
| Stop Departure | STOP\_DEPARTURE | FourKitesLoadId | Unique load identifier from FourKites system if the load was successfully created (IsSuccess = true). The field will be null if the load creation failed in FourKites | Yes | No | | Number | 20 | |
| Stop Departure | STOP\_DEPARTURE | LoadNumber | Unique shipment identifier from shipper's system | Yes | No | | String | | Always Present |
| Stop Departure | STOP\_DEPARTURE | ProNumber | Shipment's PRO # | Yes | No | | String | | |
| Stop Departure | STOP\_DEPARTURE | ReferenceNumbers | List of additional reference numbers associated with the load (empty list when no reference numbers are associated with the load) | Yes | No | | Array of string | | \[] |
| Stop Departure | STOP\_DEPARTURE | Scac | SCAC or identifier for the carrier | Yes | No | | String | | |
| Stop Departure | STOP\_DEPARTURE | Shipper | Unique shipper ID from FourKites | Yes | Yes | | String | | Shipper Name |
| Stop Departure | STOP\_DEPARTURE | StopName | Name of the stop provided during load creation | Yes | Yes | | String | | |
| Stop Departure | STOP\_DEPARTURE | StopReferenceId | Reference ID of the stop provided during load creation | Yes | No | | String | | null |
| Stop Departure | STOP\_DEPARTURE | StopSequence | Sequence of the stop on the load that the truck departed from | Yes | No | | int | | Always non empty |
| Stop Departure | STOP\_DEPARTURE | StopStatus | Status of the current stop. When delivered on the Stop Departure callback, this value will most often be "completed" | Yes | No | | String | | not\_tracking |
| Stop Departure | STOP\_DEPARTURE | StopType | Stop type - pickup, transfer, delivery, port\_of\_loading, transhipment\_port, port\_of\_discharge, origin\_airport, destination\_airport | Yes | No | 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 | | Always present |
| Stop Departure | STOP\_DEPARTURE | Tags | List of tags associated with the load (empty list when tags are not present) | Yes | No | | Array of string | | \[] |
| Stop Departure | STOP\_DEPARTURE | Timestamp | Time when the truck departed the stop in stop's local time (in ISO 8601 format with local time offset to UTC) | Yes | Yes | The DepartedAt Time will be converted to different timezone and will be mapped as Timestamp. | String in DateTime format | | |
| Stop Departure | STOP\_DEPARTURE | Timezone | Local Timezone of the stop in which Timestamp is specified. | Yes | No | | String | | |
| Stop Departure | STOP\_DEPARTURE | TimezoneOffset | Number of seconds local timezone is ahead of UTC time. Negative for western hemisphere timezones. | Yes | No | Based on the Timestamp | \[+/-]Digits | | Always non empty |
| Stop Departure | STOP\_DEPARTURE | TimezoneShortName | Short name of Timezone of the stop in which "Timestamp" is specified. | Yes | No | Based on both Timestamp and Timezone | String | | |
| Stop Departure | STOP\_DEPARTURE | EncryptedAccessToken | The access token that would be used to create an encrypted URL. | Only for Delivery stops | Only for Delivery stops | If encrypted access token is not null and stoptype is delivery then the field EncryptedAccessToken will be mapped. | String | | Always non empty |
| Stop Departure | STOP\_DEPARTURE | EncryptedURL | Encrypted URL of the load which is unique and which can be used to access details of the load | Only for Delivery stops | Only for Delivery stops | If the StopType is delivery then the EncryptedURL field based on a license. Feature Flag | String containing url | | Always non empty |
| Stop Departure | STOP\_DEPARTURE | StopUnlocode | UNLOCODE of the port. Specific to Ocean loads. | No | No | If the transportation mode is ocean, and the stoptype is port of loading, port of discharge and transhipment port, then the field StopAddressID will be mapped as StopUnlocode. | String | | Always non empty |
| Stop Departure | STOP\_DEPARTURE | StopReferenceNumbers | List of reference numbers associated with the particular stop | No | No | As needed basis | Array of string | | \[] |
| Stop Departure | STOP\_DEPARTURE | OdometerReading | Odometer reading associated with the check call (provided only for loads moved by dedicated carriers) | No | No | OdometerReading field will be available on an as needed basis. If you'd like to receive this field in the callback, please submit a case. | | | null |
| Stop Departure | STOP\_DEPARTURE | BookingNumber | It indicates the shipping line's booking number. | Yes | Yes | For Ocean loads. | String | | null |
| Stop Departure | STOP\_DEPARTURE | VoyageNumber | It indicates the unique identifier given for the voyage. | Yes | Yes | | String | | null |
| Stop Departure | STOP\_DEPARTURE | VesselName | It indicates the name of the vessel carrying the load. | Yes | Yes | | String | | null |
| Stop Departure | STOP\_DEPARTURE | ContainerType | It indicates whether the container is a general, high cube, Reefer, etc., type of container. | Yes | Yes | | String | | null |
| Stop Departure | STOP\_DEPARTURE | ContainerNumber | Container Number of the ocean load | Yes | Yes | | String | | null |
| Stop Departure | STOP\_DEPARTURE | BillOfLading | It indicates the bill of lading associated with the load. | Yes | Yes | | String | | null |
| Stop Departure | STOP\_DEPARTURE | TerminalName | It indicates the terminal inside a port where the vessel is berthing (terminal name tied to a stop).
Applicable for messages tied to following stoptypes:
- port\_of\_loading
- transhipment\_port
- port\_of\_discharge | Yes | Yes | | String | | |
| Stop Departure | STOP\_DEPARTURE | CreatedBy | This applies only for FourKites X loads. | | | 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 | | Always non empty |
| Stop Completion. This callback will be sent under the condition that TransportationMode is Ocean or StopType is Delivered/Pickup. | STOP\_AUTO\_COMPLETED/STOP\_AUTO\_DELIVERED/STOP\_AUTO\_PICKED\_UP | DepartedAt | Time when the truck departed the pickup stop | Yes | No | Mapped directly to the Timestamp | String in DateTime format | | |
| Stop Completion | STOP\_AUTO\_COMPLETED/STOP\_AUTO\_DELIVERED/STOP\_AUTO\_PICKED\_UP | FourKitesLoadId | Unique load identifier from FourKites system if the load was successfully created (IsSuccess = true). The field will be null if the load creation failed in FourKites | Yes | No | TrackingId will be mapped to FourKitesLoadId. | Number | 20 | |
| Stop Completion | STOP\_AUTO\_COMPLETED/STOP\_AUTO\_DELIVERED/STOP\_AUTO\_PICKED\_UP | LoadNumber | Unique shipment identifier from shipper's system | Yes | Yes | | String | | Always Present |
| Stop Completion | STOP\_AUTO\_COMPLETED/STOP\_AUTO\_DELIVERED/STOP\_AUTO\_PICKED\_UP | ReferenceNumbers | List of additional reference numbers associated with the load (empty list when no reference numbers are associated with the load) | Yes | No | | Array of string | | \[] |
| Stop Completion | STOP\_AUTO\_COMPLETED/STOP\_AUTO\_DELIVERED/STOP\_AUTO\_PICKED\_UP | Scac | SCAC or identifier for the carrier | Yes | No | | String | | |
| Stop Completion | STOP\_AUTO\_COMPLETED/STOP\_AUTO\_DELIVERED/STOP\_AUTO\_PICKED\_UP | Shipper | Unique shipper ID from FourKites | Yes | No | | String | | Shipper Name |
| Stop Completion | STOP\_AUTO\_COMPLETED/STOP\_AUTO\_DELIVERED/STOP\_AUTO\_PICKED\_UP | StopName | Name of the stop provided during load creation | Yes | Yes | | String | | |
| Stop Completion | STOP\_AUTO\_COMPLETED/STOP\_AUTO\_DELIVERED/STOP\_AUTO\_PICKED\_UP | StopReferenceId | Reference ID of the stop provided during load creation | Yes | No | | String | | \[] |
| Stop Completion | STOP\_AUTO\_COMPLETED/STOP\_AUTO\_DELIVERED/STOP\_AUTO\_PICKED\_UP | StopSequence | Sequence of the stop on the load that the truck departed from | Yes | No | | int | | Always non empty |
| Stop Completion | STOP\_AUTO\_COMPLETED/STOP\_AUTO\_DELIVERED/STOP\_AUTO\_PICKED\_UP | StopStatus | Status of the current stop. When delivered on the Stop Departure callback, this value will most often be "completed" | Yes | No | | String | | not\_tracking |
| Stop Completion | STOP\_AUTO\_COMPLETED/STOP\_AUTO\_DELIVERED/STOP\_AUTO\_PICKED\_UP | StopUnlocode | It indicates the UNLOCODE of the stop | No | No | If it's an ocean load. And if the stop type is port of loading, port of discharger and transhipment port. | String | | Always non empty |
| Stop Completion | STOP\_AUTO\_COMPLETED/STOP\_AUTO\_DELIVERED/STOP\_AUTO\_PICKED\_UP | Tags | List of tags associated with the load (empty list when tags are not present) | Yes | No | | Array of string | | \[] |
| Stop Completion | STOP\_AUTO\_COMPLETED/STOP\_AUTO\_DELIVERED/STOP\_AUTO\_PICKED\_UP | Timestamp | Time when the truck departed the stop in stop's local time (in ISO 8601 format with local time offset to UTC) | Yes | No | DepartedAt will be mapped to the Timestamp. | String in DateTime format | | |
| Stop Completion | STOP\_AUTO\_COMPLETED/STOP\_AUTO\_DELIVERED/STOP\_AUTO\_PICKED\_UP | Timezone | Local Timezone of the stop in which Timestamp is specified. | Yes | No | | String | | |
| Stop Completion | STOP\_AUTO\_COMPLETED/STOP\_AUTO\_DELIVERED/STOP\_AUTO\_PICKED\_UP | TimezoneOffset | Number of seconds local timezone is ahead of UTC time. Negative for western hemisphere timezones. | Yes | No | TimezoneOffset will be dependent on Timestamp | \[+/-]Digits | | Always non empty |
| Stop Completion | STOP\_AUTO\_COMPLETED/STOP\_AUTO\_DELIVERED/STOP\_AUTO\_PICKED\_UP | TimezoneShortName | Short name of Timezone of the stop in which "Timestamp" is specified. | Yes | No | TimezoneShortName will be dependent on Timestamp and Timezone | String | | |
| Stop Completion | STOP\_AUTO\_COMPLETED/STOP\_AUTO\_DELIVERED/STOP\_AUTO\_PICKED\_UP | StopType | Stop type - pickup, transfer, delivery, port\_of\_loading, transhipment\_port, port\_of\_discharge, origin\_airport, destination\_airport | Yes | No | 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 rail then the following values will be mapped to StopType:
- Origin Rail Terminal (If the StopType is Pickup)
- Destination Rail Terminal (If the StopType is Delivery)
7. If it doesn't satisfy any of the above conditions, then it will be mapped directly to the field received from the customer. | String | | Always present |
| Stop Completion | MANUALLY\_COMPLETED/MANUALLY\_DELIVERED/MANUALLY\_PICKED\_UP | Shipper | Unique shipper ID from FourKites | Yes | Yes | | String | | Shipper Name |
| Stop Completion | MANUALLY\_COMPLETED/MANUALLY\_DELIVERED/MANUALLY\_PICKED\_UP | StopName | Name of the stop provided during load creation | Yes | Yes | | String | | |
| Stop Completion | MANUALLY\_COMPLETED/MANUALLY\_DELIVERED/MANUALLY\_PICKED\_UP | DepartedAt | Time when the truck departed the pickup stop | Only if the stop is Manually Picked Up/Delivered | Only if the stop is Manually Picked Up/Delivered | Converting it to specific timezone and map it. | String in DateTime format | | |
| Stop Completion | MANUALLY\_COMPLETED/MANUALLY\_DELIVERED/MANUALLY\_PICKED\_UP | Mode | | Yes | Yes | | String | | |
| Stop Completion | MANUALLY\_COMPLETED/MANUALLY\_DELIVERED/MANUALLY\_PICKED\_UP | FourKitesLoadID | Unique load identifier from FourKites system if the load was successfully created (IsSuccess = true). The field will be null if the load creation failed in FourKites | Yes | No | Mapped to TrackingID | Number | 20 | |
| Stop Completion | MANUALLY\_COMPLETED/MANUALLY\_DELIVERED/MANUALLY\_PICKED\_UP | LoadNumber | Unique shipment identifier from shipper's system | Yes | Value May be Null | | String | | Always Present |
| Stop Completion | MANUALLY\_COMPLETED/MANUALLY\_DELIVERED/MANUALLY\_PICKED\_UP | PRONumber | Shipment's PRO # | Yes | Value May be Null | | String | | |
| Stop Completion | MANUALLY\_COMPLETED/MANUALLY\_DELIVERED/MANUALLY\_PICKED\_UP | Scac | SCAC or identifier for the carrier | Yes | Value May be Null | | String | | |
| Stop Completion | MANUALLY\_COMPLETED/MANUALLY\_DELIVERED/MANUALLY\_PICKED\_UP | Tags | List of tags associated with the load (empty list when tags are not present) | Yes | Value May be Null | | Array of string | | \[] |
| Stop Completion | MANUALLY\_COMPLETED/MANUALLY\_DELIVERED/MANUALLY\_PICKED\_UP | ReferenceNumbers | List of additional reference numbers associated with the load (empty list when no reference numbers are associated with the load) | Yes | Value May be Null | | Array of string | | |
| Stop Completion | MANUALLY\_COMPLETED/MANUALLY\_DELIVERED/MANUALLY\_PICKED\_UP | StopReferenceID | Reference ID of the stop provided during load creation | Yes | Value May be Null | | String | | null |
| Stop Completion | MANUALLY\_COMPLETED/MANUALLY\_DELIVERED/MANUALLY\_PICKED\_UP | StopSequence | Sequence of the stop on the load that the truck departed from | Yes | Value May be Null | | int | | null |
| Stop Completion | MANUALLY\_COMPLETED/MANUALLY\_DELIVERED/MANUALLY\_PICKED\_UP | Timezone | Local Timezone of the stop in which Timestamp is specified. | Yes | Value May be Null | | String | | |
| Stop Completion | MANUALLY\_COMPLETED/MANUALLY\_DELIVERED/MANUALLY\_PICKED\_UP | DepartedAt | Time when the truck departed the pickup stop | Yes | Value May be Null | | String in DateTime format | | |
| Stop Completion | MANUALLY\_COMPLETED/MANUALLY\_DELIVERED/MANUALLY\_PICKED\_UP | Timestamp | Time when the truck departed the stop in stop's local time (in ISO 8601 format with local time offset to UTC) | Yes | Value May be Null | The exact time received will be considered and converted to the specific timezone received from the customer. | String in DateTime format | | |
| Stop Completion | MANUALLY\_COMPLETED/MANUALLY\_DELIVERED/MANUALLY\_PICKED\_UP | TimezoneShortname | Short name of Timezone of the stop in which "Timestamp" is specified. | Yes | Value May be Null | Similar to All callbacks | String | | |
| Stop Completion | MANUALLY\_COMPLETED/MANUALLY\_DELIVERED/MANUALLY\_PICKED\_UP | TimezoneOffset | Number of seconds local timezone is ahead of UTC time. Negative for western hemisphere timezones. | Yes | Value May be Null | Similar to All callbacks | \[+/-]Digits | | Always non empty |
| Stop Completion | MANUALLY\_COMPLETED/MANUALLY\_DELIVERED/MANUALLY\_PICKED\_UP | StopType | Stop type - pickup, transfer, delivery, port\_of\_loading, transhipment\_port, port\_of\_discharge, origin\_airport, destination\_airport.
- If transportation mode is ocean and stopType is Pick Up, Delivery, Transfer, then the message type called Manually Completed will be mapped
- If transportation mode is not an ocean and stopType is delivery.
- If the transportation mode is not Ocean and the stop type is not delivery.
- If the load is Ocean. And StopType can be Pickup, Delivery or Transfer. Then it will be mapped as manually completed.
- If the StopType is Delivery it will be mapped as MANUALLY\_DELIVERED
- If none of the above conditions satisfy, it will be mapped as MANUALLY\_PICKED\_UP | Yes | No | 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.
| String | | Always present |
| Stop Completion | MANUALLY\_COMPLETED/MANUALLY\_DELIVERED/MANUALLY\_PICKED\_UP | CreatedBy | This applies only for FourKites X loads. | Yes, if it's a FourKites X load. | 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 | | Always non empty |