Stop Completion
This callback will be triggered as and when the stop is manually or auto-completed.
Request Parameter
{
"DepartedAt": "2023-10-07T00:27:01+07:00",
"FourKitesLoadId": 352020096,
"LoadNumber": "0083874382",
"MessageType": "STOP_AUTO_COMPLETED",
"ProNumber": "0082551673",
"ReferenceNumbers": [
"0091730057",
"0004576387",
"0004576387",
"0082551673",
"0083874382",
"040300378998",
"EITU9128547"
],
"Scac": "200009116W",
"Shipper": "eastman-chemical-asia-pacific",
"StopName": "4ID0000008-SURABAYA",
"StopReferenceId": "4ID0000008",
"StopSequence": 4,
"StopStatus": null,
"StopType": "port_of_discharge",
"StopUnlocode": "IDSUB",
"Tags": [
"VQ00 - Origin",
"DKI JAKARTA RAYA - Dest",
"Ulsan Metropolitan City - Origin",
"H173006 - PT SARI SARANA KIMIA",
"4260103 - PT. SARANA BERKAT SEJAHTERA",
"Loaded",
"EITU9128547",
"00000",
"0000",
"U794147-Joyce Ang",
"CCHQ",
"U487124-Young Jung Kim"
],
"Timestamp": "2023-10-07T00:27:01+07:00",
"Timezone": "Asia/Jakarta",
"TimezoneOffset": 25200,
"TimezoneShortName": "WIB"
}Field Definitions
MessageType | Field Name | Description | Key Always Present? | Value Always Present? | Conditions for the Key to be present | Data Type | Max Length |
|---|---|---|---|---|---|---|---|
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 | 30 |
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_AUTO_COMPLETED/STOP_AUTO_DELIVERED/STOP_AUTO_PICKED_UP | LoadNumber | Unique shipment identifier from shipper's system | Yes | Yes | N/A | String | 65535 |
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 | N/A | Array of string | No max |
STOP_AUTO_COMPLETED/STOP_AUTO_DELIVERED/STOP_AUTO_PICKED_UP | Scac | SCAC or identifier for the carrier | Yes | No | N/A | Alpha/Numeric | 4 |
STOP_AUTO_COMPLETED/STOP_AUTO_DELIVERED/STOP_AUTO_PICKED_UP | Shipper | Unique shipper ID from FourKites | Yes | No | N/A | String | No max, but realistically, not longer than 200 characters |
STOP_AUTO_COMPLETED/STOP_AUTO_DELIVERED/STOP_AUTO_PICKED_UP | StopName | Name of the stop provided during load creation | Yes | Yes | N/A | String | No max |
STOP_AUTO_COMPLETED/STOP_AUTO_DELIVERED/STOP_AUTO_PICKED_UP | StopReferenceId | Reference ID of the stop provided during load creation | Yes | No | N/A | string | 1024 |
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 | N/A | Number | 10 |
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 | N/A | String | |
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 | |
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 | N/A | Array of string | 50 for each tag |
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 | 30 |
STOP_AUTO_COMPLETED/STOP_AUTO_DELIVERED/STOP_AUTO_PICKED_UP | Timezone | Local Timezone of the stop in which Timestamp is specified. | Yes | No | N/A | String | 50 |
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 | 10 |
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 | 5 |
STOP_AUTO_COMPLETED/STOP_AUTO_DELIVERED/STOP_AUTO_PICKED_UP | StopType | Stop type - * Pickup |
- Terminal
- port_of_loading (not common)
- transhipment_port
- port_of_discharge
- place_of_delivery
- Origin Airport
- Hub Airport
- Destination Airport
- Delivery | 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 | 1024 | | MANUALLY_COMPLETED/MANUALLY_DELIVERED/MANUALLY_PICKED_UP | Shipper | Unique shipper ID from FourKites | Yes | Yes | N/A | String | No max, but realistically, not longer than 200 characters | | MANUALLY_COMPLETED/MANUALLY_DELIVERED/MANUALLY_PICKED_UP | StopName | Name of the stop provided during load creation | Yes | Yes | N/A | String | No max | | 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 | 30 | | MANUALLY_COMPLETED/MANUALLY_DELIVERED/MANUALLY_PICKED_UP | Mode | | Yes | Yes | N/A | String | | | 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 | | MANUALLY_COMPLETED/MANUALLY_DELIVERED/MANUALLY_PICKED_UP | LoadNumber | Unique shipment identifier from shipper's system | Yes | Value May be Null | N/A | String | 65535 | | MANUALLY_COMPLETED/MANUALLY_DELIVERED/MANUALLY_PICKED_UP | PRONumber | Shipment's PRO # | Yes | Value May be Null | N/A | Number | 10 | | MANUALLY_COMPLETED/MANUALLY_DELIVERED/MANUALLY_PICKED_UP | Scac | SCAC or identifier for the carrier | Yes | Value May be Null | N/A | Alpha/Numeric | 4 | | 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 | N/A | Array of string | 50 for each tag | | 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 | N/A | Array of string | No max | | MANUALLY_COMPLETED/MANUALLY_DELIVERED/MANUALLY_PICKED_UP | StopReferenceID | Reference ID of the stop provided during load creation | Yes | Value May be Null | N/A | string | 1024 | | 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 | N/A | Number | 10 | | MANUALLY_COMPLETED/MANUALLY_DELIVERED/MANUALLY_PICKED_UP | Timezone | Local Timezone of the stop in which Timestamp is specified. | Yes | Value May be Null | N/A | String | 50 | | MANUALLY_COMPLETED/MANUALLY_DELIVERED/MANUALLY_PICKED_UP | DepartedAt | Time when the truck departed the pickup stop | Yes | Value May be Null | N/A | String in DateTime format | 30 | | 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 | 30 | | 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 | N/A | String | 5 | | 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 | N/A | [+/-]Digits | 10 | | 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 | 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 | 1024 | | 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 | 1024 |
MessageType | Field Name | Description | Key Always Present? | Value Always Present? | Conditions for the Key to be Present | Data Type | Max Length |
|---|---|---|---|---|---|---|---|
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_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. | Int64 | |
STOP_AUTO_COMPLETED/STOP_AUTO_DELIVERED/STOP_AUTO_PICKED_UP | LoadNumber | Unique shipment identifier from shipper's system | Yes | Yes | N/A | String | |
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_AUTO_COMPLETED/STOP_AUTO_DELIVERED/STOP_AUTO_PICKED_UP | Scac | SCAC or identifier for the carrier | Yes | No | | String | |
STOP_AUTO_COMPLETED/STOP_AUTO_DELIVERED/STOP_AUTO_PICKED_UP | Shipper | Unique shipper ID from FourKites | Yes | No | | String | |
STOP_AUTO_COMPLETED/STOP_AUTO_DELIVERED/STOP_AUTO_PICKED_UP | StopName | Name of the stop provided during load creation | Yes | Yes | | String | |
STOP_AUTO_COMPLETED/STOP_AUTO_DELIVERED/STOP_AUTO_PICKED_UP | StopReferenceId | Reference ID of the stop provided during load creation | Yes | No | | String | |
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 | |
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 | |
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 | |
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_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_AUTO_COMPLETED/STOP_AUTO_DELIVERED/STOP_AUTO_PICKED_UP | Timezone | Local Timezone of the stop in which Timestamp is specified. | Yes | No | | String | |
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 | |
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_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 | |
MANUALLY_COMPLETED/MANUALLY_DELIVERED/MANUALLY_PICKED_UP | Shipper | Unique shipper ID from FourKites | Yes | Yes | | String | |
MANUALLY_COMPLETED/MANUALLY_DELIVERED/MANUALLY_PICKED_UP | StopName | Name of the stop provided during load creation | Yes | Yes | | String | |
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 | |
MANUALLY_COMPLETED/MANUALLY_DELIVERED/MANUALLY_PICKED_UP | Mode | | Yes | Yes | | String | |
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 | int64 | |
MANUALLY_COMPLETED/MANUALLY_DELIVERED/MANUALLY_PICKED_UP | LoadNumber | Unique shipment identifier from shipper's system | Yes | Value May be Null | | String | |
MANUALLY_COMPLETED/MANUALLY_DELIVERED/MANUALLY_PICKED_UP | PRONumber | Shipment's PRO # | Yes | Value May be Null | | String | |
MANUALLY_COMPLETED/MANUALLY_DELIVERED/MANUALLY_PICKED_UP | Scac | SCAC or identifier for the carrier | Yes | Value May be Null | | String | |
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 | |
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 | |
MANUALLY_COMPLETED/MANUALLY_DELIVERED/MANUALLY_PICKED_UP | StopReferenceID | Reference ID of the stop provided during load creation | Yes | Value May be Null | | String | |
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 | |
MANUALLY_COMPLETED/MANUALLY_DELIVERED/MANUALLY_PICKED_UP | Timezone | Local Timezone of the stop in which Timestamp is specified. | Yes | Value May be Null | | String | |
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 | |
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 | |
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 | |
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 | |
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 | 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 | |
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 | |