--- title: Dispatcher Update - Asynchronous (All Key-Value) slug: fourkites-api-reference/dispatcher-update-asynchronous-all-key-value createdAt: 2024-02-05T08:13:55.000Z --- This document contains a sample payload with all the relevant parameters and a request parameter description for all the available keys. :::hint{type="info"} ### Rate Limit **60 requests per minute** [Click here](https://docs.fourkites.com/api-reference/rate-limits) for more information on Rate Limit. ::: :::hint{type="info"} ### Format Supported **JSON** ::: :::hint{type="info"} ### Authenticated Resource **API Key** ::: :::hint{type="success"} When providing stop identifiers, such as **PostalCode, StopSequence, StopId, StopReferenceId, **or** StopReferenceNumber** for **stop-level updates** (e.g., X3, AF, X1, D1, etc.), it is essential that each identifier is **unique** to a specific stop. If an identifier is used for more than one stop, the update will not be processed successfully. ::: For more information on Authentication, [click here](https://docs.fourkites.com/api-reference/authentication). :::ApiMethodV2 ```json { "name": "Production", "method": "POST", "url": "https://api.fourkites.com/load/update/dispatcher-api/async", "description": "", "tab": "examples", "examples": { "languages": [ { "id": "A7Tsvgnmw7rglHtFt1mgt", "language": "curl", "code": "curl --location 'https://api.fourkites.com/load/update/dispatcher-api/async' \\\n--header 'Content-Type: application/json' \\\n--header 'apikey: testkey' \\\n--data '{\n \"updates\": [\n {\n \"timeZone\": \"UTC\",\n \"billToCode\": \"Shipper unique id\",\n \"identifierKeys\": [\n {\n \"identifier\": \"Load reference #1\",\n \"rawIdentifier\": \"Carrier format - Load reference #1\",\n \"identifierType\": \"Load reference identifier type in FourKites or Carrier company\" \n },\n {\n \"identifier\": \"Load reference #2\",\n \"rawIdentifier\": \"Carrier format - Load reference #2\",\n \"identifierType\": \"Load reference identifier type in FourKites or Carrier company\"\n },\n {\n \"identifier\": \"Load reference #3\",\n \"rawIdentifier\": \"Carrier format - Load reference #3\",\n \"identifierType\": \"Load reference identifier type in FourKites or Carrier company\"\n },\n {\n \"identifier\": \"Load reference #4\",\n \"rawIdentifier\": \"Carrier format - Load reference #4\",\n \"identifierType\": \"Load reference identifier type in FourKites or Carrier company\"\n }\n ],\n \"assignmentUpdate\": {\n \"operatingCarrierScac\": \"Operating Carrier SCAC ID\",\n \"truckNumber\": \"Truck Number as in the GPS/ELD portal\",\n \"trailerNumber\": \"Trailer Number as in the GPS/ELD portal\",\n \"deviceId\": \"Device Id as in the GPS/ELD portal\",\n \"driverPhone\": \"Driver Phone Number with the Country Code\",\n \"driverName\": \"Driver Name\",\n \"driverLicenseNumber\": \"Driver Truck License Number\",\n \"railEquipmentInitials\": \"4-character rail equipment prefix\",\n \"railEquipmentNumber\": \"6-digit rail equipment number\",\n \"wagonNumber\": \"Wagon Number\",\n \"oceanContainer\": \"Ocean Containter\",\n \"loadMode\": \"Mode of the load to be assigned\"\n },\n \"stopUpdate\": {\n \"appointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"earliestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"latestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"stopType\": \"pickup\",\n \"stopSequence\": 1,\n \"stopReferenceId\": \"stopReferenceId\",\n \"postalCode\": \"postalCode\",\n \"statusCode\": \"statusCodestop\",\n \"statusDescription\": \"statusDescriptionstop\",\n \"statusReasonCode\": \"statusReasonCodestop\",\n \"eventTimeStamp\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"earliestAppointmentDateOnly\": \"YYYY-MM-DD\",\n \"earliestAppointmentTimeOnly\": \"HH:MM:SS\",\n \"latestAppointmentDateOnly\": \"YYYY-MM-DD\",\n \"latestAppointmentTimeOnly\": \"HH:MM:SS\",\n \"modeType\": [\n \"modeType generally specified as '\\''intermodal'\\'' to update the terminalStops for load\"\n ],\n \"terminalStops\": [\n {\n \"appointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"earliestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"latestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"stopType\": \"originTerminal\",\n \"transportationMode\": \"transportationMode\",\n \"stopSequence\": 1,\n \"stopReferenceId\": \"stopReferenceId\",\n \"name\": \"stopName\",\n \"city\": \"stopCity\",\n \"state\": \"stopState\",\n \"country\": \"stopCountry\",\n \"latitude\": \"47.1667\",\n \"longitude\": \"-2.1667\"\n },\n {\n \"appointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"earliestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"latestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"stopType\": \"destinationTerminal\",\n \"transportationMode\": \"transportationMode\",\n \"stopSequence\": 2,\n \"stopReferenceId\": \"stopReferenceId\",\n \"name\": \"stopName\",\n \"city\": \"stopCity\",\n \"state\": \"stopState\",\n \"country\": \"stopCountry\",\n \"latitude\": \"47.1667\",\n \"longitude\": \"-2.1667\"\n }\n ]\n },\n \"loadUpdate\": [\n {\n \"locationUpdate\": {\n \"latitude\": \"42.42\",\n \"longitude\": \"-87.622003\",\n \"locatedAt\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"city\": \"Location City\",\n \"state\": \"Location State code\",\n \"deliveredAt\": \"YYYY-MM-DDTHH:MM:SSZ\"\n },\n \"etaUpdate\": {\n \"estimatedArrivalAtDestination\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"estimatedArrivalAtDestinationDateOnly\": \"YYYY-MM-DD\"\n },\n \"temperatureUpdate\": {\n \"temperature\": \"0.2\",\n \"sensorName\": \"sensorName\",\n \"temperatureUnit\": \"C\",\n \"temperatureCheckCallTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"temperatureTimestamp\": \"YYYY-MM-DDTHH:MM:SSZ\"\n },\n \"loadInfoUpdate\": {\n \"tags\": [\n \"tags\"\n ],\n \"updatableProNumber\": \"updatableProNumber\",\n \"updatableCarrierReferenceNumber\": \"updatableCarrierReferenceNumber\",\n \"brokeredLoad\": false,\n \"relayLoad\": true,\n \"simultaneousTrackingReferenceNumber\": \"simultaneousTrackingReferenceNumberloadinfo\",\n \"endPoint\": \"endPoint\",\n \"startPoint\": \"startPoint\",\n \"startTime\": \"startTime\",\n \"forceStart\": true,\n \"stopTracking\": \"stopTracking\",\n \"weight\": \"weight\",\n \"weightUnit\": \"weightUnit\",\n \"freightCharges\": \"freightCharges\",\n \"freightChargeUnit\": \"freightChargeUnit\",\n \"quantity\": \"quantity\",\n \"simultaneousTrackingSequenceNumber\": 1\n },\n \"eventUpdate\": {\n \"modeType\": [\n \"ftl\"\n ],\n \"statusCode\": \"statusCodeevent\",\n \"statusDescription\": \"statusDescriptionevent\",\n \"statusReasonCode\": \"statusReasonCodeevent\",\n \"eventTimeStamp\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"ecta\": {\n \"ecta\": \"ecta\"\n },\n \"city\": \"Event City Code\",\n \"state\": \"Event state code\",\n \"country\": \"Event Country code\",\n \"pickupTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"deliveryTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"delivered\": false,\n \"deliveredAt\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"oceanDataHash\": {\n \"city\": \"City\",\n \"state\": \"State code\",\n \"country\": \"Country Code\",\n \"event_timezone\": \"UTC\",\n \"event_source\": \"dispatcher_async\",\n \"event_date_time\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"ocean_container_number\": \"ocean_container_number\",\n \"update_action\": \"update_action\"\n },\n \"vesselLocation\": \"vesselLocation\",\n \"railEventCode\": \"railEventCode\",\n \"shipmentStatusIndicator\": \"shipmentStatusIndicator\",\n \"shipmentStatus\": \"shipmentStatus\",\n \"failedLoads\": \"failedLoads\",\n \"airDataHash\": {\n \"quantity\": \"1\"\n }\n },\n \"additionalData\": {\n \"simultaneousTrackingReferenceNumber\": \"simultaneousTrackingReferenceNumberadditional\"\n }\n }\n ]\n }\n ]\n}'", "customLabel": "" }, { "id": "XOzuNuQ28crzwrczsH0ce", "language": "csharp", "code": "var client = new HttpClient();\nvar request = new HttpRequestMessage(HttpMethod.Post, \"https://api.fourkites.com/load/update/dispatcher-api/async\");\nrequest.Headers.Add(\"apikey\", \"testkey\");\nvar content = new StringContent(\"{\\n \\\"updates\\\": [\\n {\\n \\\"timeZone\\\": \\\"UTC\\\",\\n \\\"billToCode\\\": \\\"Shipper unique id\\\",\\n \\\"identifierKeys\\\": [\\n {\\n \\\"identifier\\\": \\\"Load reference #1\\\",\\n \\\"rawIdentifier\\\": \\\"Carrier format - Load reference #1\\\",\\n \\\"identifierType\\\": \\\"Load reference identifier type in FourKites or Carrier company\\\" \\n },\\n {\\n \\\"identifier\\\": \\\"Load reference #2\\\",\\n \\\"rawIdentifier\\\": \\\"Carrier format - Load reference #2\\\",\\n \\\"identifierType\\\": \\\"Load reference identifier type in FourKites or Carrier company\\\"\\n },\\n {\\n \\\"identifier\\\": \\\"Load reference #3\\\",\\n \\\"rawIdentifier\\\": \\\"Carrier format - Load reference #3\\\",\\n \\\"identifierType\\\": \\\"Load reference identifier type in FourKites or Carrier company\\\"\\n },\\n {\\n \\\"identifier\\\": \\\"Load reference #4\\\",\\n \\\"rawIdentifier\\\": \\\"Carrier format - Load reference #4\\\",\\n \\\"identifierType\\\": \\\"Load reference identifier type in FourKites or Carrier company\\\"\\n }\\n ],\\n \\\"assignmentUpdate\\\": {\\n \\\"operatingCarrierScac\\\": \\\"Operating Carrier SCAC ID\\\",\\n \\\"truckNumber\\\": \\\"Truck Number as in the GPS/ELD portal\\\",\\n \\\"trailerNumber\\\": \\\"Trailer Number as in the GPS/ELD portal\\\",\\n \\\"deviceId\\\": \\\"Device Id as in the GPS/ELD portal\\\",\\n \\\"driverPhone\\\": \\\"Driver Phone Number with the Country Code\\\",\\n \\\"driverName\\\": \\\"Driver Name\\\",\\n \\\"driverLicenseNumber\\\": \\\"Driver Truck License Number\\\",\\n \\\"railEquipmentInitials\\\": \\\"4-character rail equipment prefix\\\",\\n \\\"railEquipmentNumber\\\": \\\"6-digit rail equipment number\\\",\\n \\\"wagonNumber\\\": \\\"Wagon Number\\\",\\n \\\"oceanContainer\\\": \\\"Ocean Containter\\\",\\n \\\"loadMode\\\": \\\"Mode of the load to be assigned\\\"\\n },\\n \\\"stopUpdate\\\": {\\n \\\"appointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"earliestAppointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"latestAppointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"stopType\\\": \\\"pickup\\\",\\n \\\"stopSequence\\\": 1,\\n \\\"stopReferenceId\\\": \\\"stopReferenceId\\\",\\n \\\"postalCode\\\": \\\"postalCode\\\",\\n \\\"statusCode\\\": \\\"statusCodestop\\\",\\n \\\"statusDescription\\\": \\\"statusDescriptionstop\\\",\\n \\\"statusReasonCode\\\": \\\"statusReasonCodestop\\\",\\n \\\"eventTimeStamp\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"earliestAppointmentDateOnly\\\": \\\"YYYY-MM-DD\\\",\\n \\\"earliestAppointmentTimeOnly\\\": \\\"HH:MM:SS\\\",\\n \\\"latestAppointmentDateOnly\\\": \\\"YYYY-MM-DD\\\",\\n \\\"latestAppointmentTimeOnly\\\": \\\"HH:MM:SS\\\",\\n \\\"modeType\\\": [\\n \\\"modeType generally specified as 'intermodal' to update the terminalStops for load\\\"\\n ],\\n \\\"terminalStops\\\": [\\n {\\n \\\"appointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"earliestAppointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"latestAppointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"stopType\\\": \\\"originTerminal\\\",\\n \\\"transportationMode\\\": \\\"transportationMode\\\",\\n \\\"stopSequence\\\": 1,\\n \\\"stopReferenceId\\\": \\\"stopReferenceId\\\",\\n \\\"name\\\": \\\"stopName\\\",\\n \\\"city\\\": \\\"stopCity\\\",\\n \\\"state\\\": \\\"stopState\\\",\\n \\\"country\\\": \\\"stopCountry\\\",\\n \\\"latitude\\\": \\\"47.1667\\\",\\n \\\"longitude\\\": \\\"-2.1667\\\"\\n },\\n {\\n \\\"appointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"earliestAppointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"latestAppointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"stopType\\\": \\\"destinationTerminal\\\",\\n \\\"transportationMode\\\": \\\"transportationMode\\\",\\n \\\"stopSequence\\\": 2,\\n \\\"stopReferenceId\\\": \\\"stopReferenceId\\\",\\n \\\"name\\\": \\\"stopName\\\",\\n \\\"city\\\": \\\"stopCity\\\",\\n \\\"state\\\": \\\"stopState\\\",\\n \\\"country\\\": \\\"stopCountry\\\",\\n \\\"latitude\\\": \\\"47.1667\\\",\\n \\\"longitude\\\": \\\"-2.1667\\\"\\n }\\n ]\\n },\\n \\\"loadUpdate\\\": [\\n {\\n \\\"locationUpdate\\\": {\\n \\\"latitude\\\": \\\"42.42\\\",\\n \\\"longitude\\\": \\\"-87.622003\\\",\\n \\\"locatedAt\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"city\\\": \\\"Location City\\\",\\n \\\"state\\\": \\\"Location State code\\\",\\n \\\"deliveredAt\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\"\\n },\\n \\\"etaUpdate\\\": {\\n \\\"estimatedArrivalAtDestination\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"estimatedArrivalAtDestinationDateOnly\\\": \\\"YYYY-MM-DD\\\"\\n },\\n \\\"temperatureUpdate\\\": {\\n \\\"temperature\\\": \\\"0.2\\\",\\n \\\"sensorName\\\": \\\"sensorName\\\",\\n \\\"temperatureUnit\\\": \\\"C\\\",\\n \\\"temperatureCheckCallTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"temperatureTimestamp\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\"\\n },\\n \\\"loadInfoUpdate\\\": {\\n \\\"tags\\\": [\\n \\\"tags\\\"\\n ],\\n \\\"updatableProNumber\\\": \\\"updatableProNumber\\\",\\n \\\"updatableCarrierReferenceNumber\\\": \\\"updatableCarrierReferenceNumber\\\",\\n \\\"brokeredLoad\\\": false,\\n \\\"relayLoad\\\": true,\\n \\\"simultaneousTrackingReferenceNumber\\\": \\\"simultaneousTrackingReferenceNumberloadinfo\\\",\\n \\\"endPoint\\\": \\\"endPoint\\\",\\n \\\"startPoint\\\": \\\"startPoint\\\",\\n \\\"startTime\\\": \\\"startTime\\\",\\n \\\"forceStart\\\": true,\\n \\\"stopTracking\\\": \\\"stopTracking\\\",\\n \\\"weight\\\": \\\"weight\\\",\\n \\\"weightUnit\\\": \\\"weightUnit\\\",\\n \\\"freightCharges\\\": \\\"freightCharges\\\",\\n \\\"freightChargeUnit\\\": \\\"freightChargeUnit\\\",\\n \\\"quantity\\\": \\\"quantity\\\",\\n \\\"simultaneousTrackingSequenceNumber\\\": 1\\n },\\n \\\"eventUpdate\\\": {\\n \\\"modeType\\\": [\\n \\\"ftl\\\"\\n ],\\n \\\"statusCode\\\": \\\"statusCodeevent\\\",\\n \\\"statusDescription\\\": \\\"statusDescriptionevent\\\",\\n \\\"statusReasonCode\\\": \\\"statusReasonCodeevent\\\",\\n \\\"eventTimeStamp\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"ecta\\\": {\\n \\\"ecta\\\": \\\"ecta\\\"\\n },\\n \\\"city\\\": \\\"Event City Code\\\",\\n \\\"state\\\": \\\"Event state code\\\",\\n \\\"country\\\": \\\"Event Country code\\\",\\n \\\"pickupTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"deliveryTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"delivered\\\": false,\\n \\\"deliveredAt\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"oceanDataHash\\\": {\\n \\\"city\\\": \\\"City\\\",\\n \\\"state\\\": \\\"State code\\\",\\n \\\"country\\\": \\\"Country Code\\\",\\n \\\"event_timezone\\\": \\\"UTC\\\",\\n \\\"event_source\\\": \\\"dispatcher_async\\\",\\n \\\"event_date_time\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"ocean_container_number\\\": \\\"ocean_container_number\\\",\\n \\\"update_action\\\": \\\"update_action\\\"\\n },\\n \\\"vesselLocation\\\": \\\"vesselLocation\\\",\\n \\\"railEventCode\\\": \\\"railEventCode\\\",\\n \\\"shipmentStatusIndicator\\\": \\\"shipmentStatusIndicator\\\",\\n \\\"shipmentStatus\\\": \\\"shipmentStatus\\\",\\n \\\"failedLoads\\\": \\\"failedLoads\\\",\\n \\\"airDataHash\\\": {\\n \\\"quantity\\\": \\\"1\\\"\\n }\\n },\\n \\\"additionalData\\\": {\\n \\\"simultaneousTrackingReferenceNumber\\\": \\\"simultaneousTrackingReferenceNumberadditional\\\"\\n }\\n }\\n ]\\n }\\n ]\\n}\", null, \"application/json\");\nrequest.Content = content;\nvar response = await client.SendAsync(request);\nresponse.EnsureSuccessStatusCode();\nConsole.WriteLine(await response.Content.ReadAsStringAsync());\n" }, { "id": "YQ304lKgWLwh_-b1dUx4-", "language": "go", "code": "package main\n\nimport (\n \"fmt\"\n \"strings\"\n \"net/http\"\n \"io/ioutil\"\n)\n\nfunc main() {\n\n url := \"https://api.fourkites.com/load/update/dispatcher-api/async\"\n method := \"POST\"\n\n payload := strings.NewReader(`{\n \"updates\": [\n {\n \"timeZone\": \"UTC\",\n \"billToCode\": \"Shipper unique id\",\n \"identifierKeys\": [\n {\n \"identifier\": \"Load reference #1\",\n \"rawIdentifier\": \"Carrier format - Load reference #1\",\n \"identifierType\": \"Load reference identifier type in FourKites or Carrier company\" \n },\n {\n \"identifier\": \"Load reference #2\",\n \"rawIdentifier\": \"Carrier format - Load reference #2\",\n \"identifierType\": \"Load reference identifier type in FourKites or Carrier company\"\n },\n {\n \"identifier\": \"Load reference #3\",\n \"rawIdentifier\": \"Carrier format - Load reference #3\",\n \"identifierType\": \"Load reference identifier type in FourKites or Carrier company\"\n },\n {\n \"identifier\": \"Load reference #4\",\n \"rawIdentifier\": \"Carrier format - Load reference #4\",\n \"identifierType\": \"Load reference identifier type in FourKites or Carrier company\"\n }\n ],\n \"assignmentUpdate\": {\n \"operatingCarrierScac\": \"Operating Carrier SCAC ID\",\n \"truckNumber\": \"Truck Number as in the GPS/ELD portal\",\n \"trailerNumber\": \"Trailer Number as in the GPS/ELD portal\",\n \"deviceId\": \"Device Id as in the GPS/ELD portal\",\n \"driverPhone\": \"Driver Phone Number with the Country Code\",\n \"driverName\": \"Driver Name\",\n \"driverLicenseNumber\": \"Driver Truck License Number\",\n \"railEquipmentInitials\": \"4-character rail equipment prefix\",\n \"railEquipmentNumber\": \"6-digit rail equipment number\",\n \"wagonNumber\": \"Wagon Number\",\n \"oceanContainer\": \"Ocean Containter\",\n \"loadMode\": \"Mode of the load to be assigned\"\n },\n \"stopUpdate\": {\n \"appointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"earliestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"latestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"stopType\": \"pickup\",\n \"stopSequence\": 1,\n \"stopReferenceId\": \"stopReferenceId\",\n \"postalCode\": \"postalCode\",\n \"statusCode\": \"statusCodestop\",\n \"statusDescription\": \"statusDescriptionstop\",\n \"statusReasonCode\": \"statusReasonCodestop\",\n \"eventTimeStamp\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"earliestAppointmentDateOnly\": \"YYYY-MM-DD\",\n \"earliestAppointmentTimeOnly\": \"HH:MM:SS\",\n \"latestAppointmentDateOnly\": \"YYYY-MM-DD\",\n \"latestAppointmentTimeOnly\": \"HH:MM:SS\",\n \"modeType\": [\n \"modeType generally specified as 'intermodal' to update the terminalStops for load\"\n ],\n \"terminalStops\": [\n {\n \"appointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"earliestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"latestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"stopType\": \"originTerminal\",\n \"transportationMode\": \"transportationMode\",\n \"stopSequence\": 1,\n \"stopReferenceId\": \"stopReferenceId\",\n \"name\": \"stopName\",\n \"city\": \"stopCity\",\n \"state\": \"stopState\",\n \"country\": \"stopCountry\",\n \"latitude\": \"47.1667\",\n \"longitude\": \"-2.1667\"\n },\n {\n \"appointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"earliestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"latestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"stopType\": \"destinationTerminal\",\n \"transportationMode\": \"transportationMode\",\n \"stopSequence\": 2,\n \"stopReferenceId\": \"stopReferenceId\",\n \"name\": \"stopName\",\n \"city\": \"stopCity\",\n \"state\": \"stopState\",\n \"country\": \"stopCountry\",\n \"latitude\": \"47.1667\",\n \"longitude\": \"-2.1667\"\n }\n ]\n },\n \"loadUpdate\": [\n {\n \"locationUpdate\": {\n \"latitude\": \"42.42\",\n \"longitude\": \"-87.622003\",\n \"locatedAt\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"city\": \"Location City\",\n \"state\": \"Location State code\",\n \"deliveredAt\": \"YYYY-MM-DDTHH:MM:SSZ\"\n },\n \"etaUpdate\": {\n \"estimatedArrivalAtDestination\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"estimatedArrivalAtDestinationDateOnly\": \"YYYY-MM-DD\"\n },\n \"temperatureUpdate\": {\n \"temperature\": \"0.2\",\n \"sensorName\": \"sensorName\",\n \"temperatureUnit\": \"C\",\n \"temperatureCheckCallTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"temperatureTimestamp\": \"YYYY-MM-DDTHH:MM:SSZ\"\n },\n \"loadInfoUpdate\": {\n \"tags\": [\n \"tags\"\n ],\n \"updatableProNumber\": \"updatableProNumber\",\n \"updatableCarrierReferenceNumber\": \"updatableCarrierReferenceNumber\",\n \"brokeredLoad\": false,\n \"relayLoad\": true,\n \"simultaneousTrackingReferenceNumber\": \"simultaneousTrackingReferenceNumberloadinfo\",\n \"endPoint\": \"endPoint\",\n \"startPoint\": \"startPoint\",\n \"startTime\": \"startTime\",\n \"forceStart\": true,\n \"stopTracking\": \"stopTracking\",\n \"weight\": \"weight\",\n \"weightUnit\": \"weightUnit\",\n \"freightCharges\": \"freightCharges\",\n \"freightChargeUnit\": \"freightChargeUnit\",\n \"quantity\": \"quantity\",\n \"simultaneousTrackingSequenceNumber\": 1\n },\n \"eventUpdate\": {\n \"modeType\": [\n \"ftl\"\n ],\n \"statusCode\": \"statusCodeevent\",\n \"statusDescription\": \"statusDescriptionevent\",\n \"statusReasonCode\": \"statusReasonCodeevent\",\n \"eventTimeStamp\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"ecta\": {\n \"ecta\": \"ecta\"\n },\n \"city\": \"Event City Code\",\n \"state\": \"Event state code\",\n \"country\": \"Event Country code\",\n \"pickupTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"deliveryTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"delivered\": false,\n \"deliveredAt\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"oceanDataHash\": {\n \"city\": \"City\",\n \"state\": \"State code\",\n \"country\": \"Country Code\",\n \"event_timezone\": \"UTC\",\n \"event_source\": \"dispatcher_async\",\n \"event_date_time\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"ocean_container_number\": \"ocean_container_number\",\n \"update_action\": \"update_action\"\n },\n \"vesselLocation\": \"vesselLocation\",\n \"railEventCode\": \"railEventCode\",\n \"shipmentStatusIndicator\": \"shipmentStatusIndicator\",\n \"shipmentStatus\": \"shipmentStatus\",\n \"failedLoads\": \"failedLoads\",\n \"airDataHash\": {\n \"quantity\": \"1\"\n }\n },\n \"additionalData\": {\n \"simultaneousTrackingReferenceNumber\": \"simultaneousTrackingReferenceNumberadditional\"\n }\n }\n ]\n }\n ]\n}`)\n\n client := &http.Client {\n }\n req, err := http.NewRequest(method, url, payload)\n\n if err != nil {\n fmt.Println(err)\n return\n }\n req.Header.Add(\"Content-Type\", \"application/json\")\n req.Header.Add(\"apikey\", \"testkey\")\n\n res, err := client.Do(req)\n if err != nil {\n fmt.Println(err)\n return\n }\n defer res.Body.Close()\n\n body, err := ioutil.ReadAll(res.Body)\n if err != nil {\n fmt.Println(err)\n return\n }\n fmt.Println(string(body))\n}" }, { "id": "VcdMMkTBE__NondXLnTO_", "language": "java", "code": "OkHttpClient client = new OkHttpClient().newBuilder()\n .build();\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\n \\\"updates\\\": [\\n {\\n \\\"timeZone\\\": \\\"UTC\\\",\\n \\\"billToCode\\\": \\\"Shipper unique id\\\",\\n \\\"identifierKeys\\\": [\\n {\\n \\\"identifier\\\": \\\"Load reference #1\\\",\\n \\\"rawIdentifier\\\": \\\"Carrier format - Load reference #1\\\",\\n \\\"identifierType\\\": \\\"Load reference identifier type in FourKites or Carrier company\\\" \\n },\\n {\\n \\\"identifier\\\": \\\"Load reference #2\\\",\\n \\\"rawIdentifier\\\": \\\"Carrier format - Load reference #2\\\",\\n \\\"identifierType\\\": \\\"Load reference identifier type in FourKites or Carrier company\\\"\\n },\\n {\\n \\\"identifier\\\": \\\"Load reference #3\\\",\\n \\\"rawIdentifier\\\": \\\"Carrier format - Load reference #3\\\",\\n \\\"identifierType\\\": \\\"Load reference identifier type in FourKites or Carrier company\\\"\\n },\\n {\\n \\\"identifier\\\": \\\"Load reference #4\\\",\\n \\\"rawIdentifier\\\": \\\"Carrier format - Load reference #4\\\",\\n \\\"identifierType\\\": \\\"Load reference identifier type in FourKites or Carrier company\\\"\\n }\\n ],\\n \\\"assignmentUpdate\\\": {\\n \\\"operatingCarrierScac\\\": \\\"Operating Carrier SCAC ID\\\",\\n \\\"truckNumber\\\": \\\"Truck Number as in the GPS/ELD portal\\\",\\n \\\"trailerNumber\\\": \\\"Trailer Number as in the GPS/ELD portal\\\",\\n \\\"deviceId\\\": \\\"Device Id as in the GPS/ELD portal\\\",\\n \\\"driverPhone\\\": \\\"Driver Phone Number with the Country Code\\\",\\n \\\"driverName\\\": \\\"Driver Name\\\",\\n \\\"driverLicenseNumber\\\": \\\"Driver Truck License Number\\\",\\n \\\"railEquipmentInitials\\\": \\\"4-character rail equipment prefix\\\",\\n \\\"railEquipmentNumber\\\": \\\"6-digit rail equipment number\\\",\\n \\\"wagonNumber\\\": \\\"Wagon Number\\\",\\n \\\"oceanContainer\\\": \\\"Ocean Containter\\\",\\n \\\"loadMode\\\": \\\"Mode of the load to be assigned\\\"\\n },\\n \\\"stopUpdate\\\": {\\n \\\"appointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"earliestAppointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"latestAppointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"stopType\\\": \\\"pickup\\\",\\n \\\"stopSequence\\\": 1,\\n \\\"stopReferenceId\\\": \\\"stopReferenceId\\\",\\n \\\"postalCode\\\": \\\"postalCode\\\",\\n \\\"statusCode\\\": \\\"statusCodestop\\\",\\n \\\"statusDescription\\\": \\\"statusDescriptionstop\\\",\\n \\\"statusReasonCode\\\": \\\"statusReasonCodestop\\\",\\n \\\"eventTimeStamp\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"earliestAppointmentDateOnly\\\": \\\"YYYY-MM-DD\\\",\\n \\\"earliestAppointmentTimeOnly\\\": \\\"HH:MM:SS\\\",\\n \\\"latestAppointmentDateOnly\\\": \\\"YYYY-MM-DD\\\",\\n \\\"latestAppointmentTimeOnly\\\": \\\"HH:MM:SS\\\",\\n \\\"modeType\\\": [\\n \\\"modeType generally specified as 'intermodal' to update the terminalStops for load\\\"\\n ],\\n \\\"terminalStops\\\": [\\n {\\n \\\"appointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"earliestAppointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"latestAppointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"stopType\\\": \\\"originTerminal\\\",\\n \\\"transportationMode\\\": \\\"transportationMode\\\",\\n \\\"stopSequence\\\": 1,\\n \\\"stopReferenceId\\\": \\\"stopReferenceId\\\",\\n \\\"name\\\": \\\"stopName\\\",\\n \\\"city\\\": \\\"stopCity\\\",\\n \\\"state\\\": \\\"stopState\\\",\\n \\\"country\\\": \\\"stopCountry\\\",\\n \\\"latitude\\\": \\\"47.1667\\\",\\n \\\"longitude\\\": \\\"-2.1667\\\"\\n },\\n {\\n \\\"appointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"earliestAppointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"latestAppointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"stopType\\\": \\\"destinationTerminal\\\",\\n \\\"transportationMode\\\": \\\"transportationMode\\\",\\n \\\"stopSequence\\\": 2,\\n \\\"stopReferenceId\\\": \\\"stopReferenceId\\\",\\n \\\"name\\\": \\\"stopName\\\",\\n \\\"city\\\": \\\"stopCity\\\",\\n \\\"state\\\": \\\"stopState\\\",\\n \\\"country\\\": \\\"stopCountry\\\",\\n \\\"latitude\\\": \\\"47.1667\\\",\\n \\\"longitude\\\": \\\"-2.1667\\\"\\n }\\n ]\\n },\\n \\\"loadUpdate\\\": [\\n {\\n \\\"locationUpdate\\\": {\\n \\\"latitude\\\": \\\"42.42\\\",\\n \\\"longitude\\\": \\\"-87.622003\\\",\\n \\\"locatedAt\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"city\\\": \\\"Location City\\\",\\n \\\"state\\\": \\\"Location State code\\\",\\n \\\"deliveredAt\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\"\\n },\\n \\\"etaUpdate\\\": {\\n \\\"estimatedArrivalAtDestination\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"estimatedArrivalAtDestinationDateOnly\\\": \\\"YYYY-MM-DD\\\"\\n },\\n \\\"temperatureUpdate\\\": {\\n \\\"temperature\\\": \\\"0.2\\\",\\n \\\"sensorName\\\": \\\"sensorName\\\",\\n \\\"temperatureUnit\\\": \\\"C\\\",\\n \\\"temperatureCheckCallTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"temperatureTimestamp\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\"\\n },\\n \\\"loadInfoUpdate\\\": {\\n \\\"tags\\\": [\\n \\\"tags\\\"\\n ],\\n \\\"updatableProNumber\\\": \\\"updatableProNumber\\\",\\n \\\"updatableCarrierReferenceNumber\\\": \\\"updatableCarrierReferenceNumber\\\",\\n \\\"brokeredLoad\\\": false,\\n \\\"relayLoad\\\": true,\\n \\\"simultaneousTrackingReferenceNumber\\\": \\\"simultaneousTrackingReferenceNumberloadinfo\\\",\\n \\\"endPoint\\\": \\\"endPoint\\\",\\n \\\"startPoint\\\": \\\"startPoint\\\",\\n \\\"startTime\\\": \\\"startTime\\\",\\n \\\"forceStart\\\": true,\\n \\\"stopTracking\\\": \\\"stopTracking\\\",\\n \\\"weight\\\": \\\"weight\\\",\\n \\\"weightUnit\\\": \\\"weightUnit\\\",\\n \\\"freightCharges\\\": \\\"freightCharges\\\",\\n \\\"freightChargeUnit\\\": \\\"freightChargeUnit\\\",\\n \\\"quantity\\\": \\\"quantity\\\",\\n \\\"simultaneousTrackingSequenceNumber\\\": 1\\n },\\n \\\"eventUpdate\\\": {\\n \\\"modeType\\\": [\\n \\\"ftl\\\"\\n ],\\n \\\"statusCode\\\": \\\"statusCodeevent\\\",\\n \\\"statusDescription\\\": \\\"statusDescriptionevent\\\",\\n \\\"statusReasonCode\\\": \\\"statusReasonCodeevent\\\",\\n \\\"eventTimeStamp\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"ecta\\\": {\\n \\\"ecta\\\": \\\"ecta\\\"\\n },\\n \\\"city\\\": \\\"Event City Code\\\",\\n \\\"state\\\": \\\"Event state code\\\",\\n \\\"country\\\": \\\"Event Country code\\\",\\n \\\"pickupTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"deliveryTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"delivered\\\": false,\\n \\\"deliveredAt\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"oceanDataHash\\\": {\\n \\\"city\\\": \\\"City\\\",\\n \\\"state\\\": \\\"State code\\\",\\n \\\"country\\\": \\\"Country Code\\\",\\n \\\"event_timezone\\\": \\\"UTC\\\",\\n \\\"event_source\\\": \\\"dispatcher_async\\\",\\n \\\"event_date_time\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"ocean_container_number\\\": \\\"ocean_container_number\\\",\\n \\\"update_action\\\": \\\"update_action\\\"\\n },\\n \\\"vesselLocation\\\": \\\"vesselLocation\\\",\\n \\\"railEventCode\\\": \\\"railEventCode\\\",\\n \\\"shipmentStatusIndicator\\\": \\\"shipmentStatusIndicator\\\",\\n \\\"shipmentStatus\\\": \\\"shipmentStatus\\\",\\n \\\"failedLoads\\\": \\\"failedLoads\\\",\\n \\\"airDataHash\\\": {\\n \\\"quantity\\\": \\\"1\\\"\\n }\\n },\\n \\\"additionalData\\\": {\\n \\\"simultaneousTrackingReferenceNumber\\\": \\\"simultaneousTrackingReferenceNumberadditional\\\"\\n }\\n }\\n ]\\n }\\n ]\\n}\");\nRequest request = new Request.Builder()\n .url(\"https://api.fourkites.com/load/update/dispatcher-api/async\")\n .method(\"POST\", body)\n .addHeader(\"Content-Type\", \"application/json\")\n .addHeader(\"apikey\", \"testkey\")\n .build();\nResponse response = client.newCall(request).execute();" }, { "id": "QskSKlu-LqFVd0dpqEgN3", "language": "javascript", "code": "var settings = {\n \"url\": \"https://api.fourkites.com/load/update/dispatcher-api/async\",\n \"method\": \"POST\",\n \"timeout\": 0,\n \"headers\": {\n \"Content-Type\": \"application/json\",\n \"apikey\": \"testkey\"\n },\n \"data\": JSON.stringify({\n \"updates\": [\n {\n \"timeZone\": \"UTC\",\n \"billToCode\": \"Shipper unique id\",\n \"identifierKeys\": [\n {\n \"identifier\": \"Load reference #1\",\n \"rawIdentifier\": \"Carrier format - Load reference #1\",\n \"identifierType\": \"Load reference identifier type in FourKites or Carrier company\"\n },\n {\n \"identifier\": \"Load reference #2\",\n \"rawIdentifier\": \"Carrier format - Load reference #2\",\n \"identifierType\": \"Load reference identifier type in FourKites or Carrier company\"\n },\n {\n \"identifier\": \"Load reference #3\",\n \"rawIdentifier\": \"Carrier format - Load reference #3\",\n \"identifierType\": \"Load reference identifier type in FourKites or Carrier company\"\n },\n {\n \"identifier\": \"Load reference #4\",\n \"rawIdentifier\": \"Carrier format - Load reference #4\",\n \"identifierType\": \"Load reference identifier type in FourKites or Carrier company\"\n }\n ],\n \"assignmentUpdate\": {\n \"operatingCarrierScac\": \"Operating Carrier SCAC ID\",\n \"truckNumber\": \"Truck Number as in the GPS/ELD portal\",\n \"trailerNumber\": \"Trailer Number as in the GPS/ELD portal\",\n \"deviceId\": \"Device Id as in the GPS/ELD portal\",\n \"driverPhone\": \"Driver Phone Number with the Country Code\",\n \"driverName\": \"Driver Name\",\n \"driverLicenseNumber\": \"Driver Truck License Number\",\n \"railEquipmentInitials\": \"4-character rail equipment prefix\",\n \"railEquipmentNumber\": \"6-digit rail equipment number\",\n \"wagonNumber\": \"Wagon Number\",\n \"oceanContainer\": \"Ocean Containter\",\n \"loadMode\": \"Mode of the load to be assigned\"\n },\n \"stopUpdate\": {\n \"appointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"earliestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"latestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"stopType\": \"pickup\",\n \"stopSequence\": 1,\n \"stopReferenceId\": \"stopReferenceId\",\n \"postalCode\": \"postalCode\",\n \"statusCode\": \"statusCodestop\",\n \"statusDescription\": \"statusDescriptionstop\",\n \"statusReasonCode\": \"statusReasonCodestop\",\n \"eventTimeStamp\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"earliestAppointmentDateOnly\": \"YYYY-MM-DD\",\n \"earliestAppointmentTimeOnly\": \"HH:MM:SS\",\n \"latestAppointmentDateOnly\": \"YYYY-MM-DD\",\n \"latestAppointmentTimeOnly\": \"HH:MM:SS\",\n \"modeType\": [\n \"modeType generally specified as 'intermodal' to update the terminalStops for load\"\n ],\n \"terminalStops\": [\n {\n \"appointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"earliestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"latestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"stopType\": \"originTerminal\",\n \"transportationMode\": \"transportationMode\",\n \"stopSequence\": 1,\n \"stopReferenceId\": \"stopReferenceId\",\n \"name\": \"stopName\",\n \"city\": \"stopCity\",\n \"state\": \"stopState\",\n \"country\": \"stopCountry\",\n \"latitude\": \"47.1667\",\n \"longitude\": \"-2.1667\"\n },\n {\n \"appointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"earliestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"latestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"stopType\": \"destinationTerminal\",\n \"transportationMode\": \"transportationMode\",\n \"stopSequence\": 2,\n \"stopReferenceId\": \"stopReferenceId\",\n \"name\": \"stopName\",\n \"city\": \"stopCity\",\n \"state\": \"stopState\",\n \"country\": \"stopCountry\",\n \"latitude\": \"47.1667\",\n \"longitude\": \"-2.1667\"\n }\n ]\n },\n \"loadUpdate\": [\n {\n \"locationUpdate\": {\n \"latitude\": \"42.42\",\n \"longitude\": \"-87.622003\",\n \"locatedAt\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"city\": \"Location City\",\n \"state\": \"Location State code\",\n \"deliveredAt\": \"YYYY-MM-DDTHH:MM:SSZ\"\n },\n \"etaUpdate\": {\n \"estimatedArrivalAtDestination\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"estimatedArrivalAtDestinationDateOnly\": \"YYYY-MM-DD\"\n },\n \"temperatureUpdate\": {\n \"temperature\": \"0.2\",\n \"sensorName\": \"sensorName\",\n \"temperatureUnit\": \"C\",\n \"temperatureCheckCallTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"temperatureTimestamp\": \"YYYY-MM-DDTHH:MM:SSZ\"\n },\n \"loadInfoUpdate\": {\n \"tags\": [\n \"tags\"\n ],\n \"updatableProNumber\": \"updatableProNumber\",\n \"updatableCarrierReferenceNumber\": \"updatableCarrierReferenceNumber\",\n \"brokeredLoad\": false,\n \"relayLoad\": true,\n \"simultaneousTrackingReferenceNumber\": \"simultaneousTrackingReferenceNumberloadinfo\",\n \"endPoint\": \"endPoint\",\n \"startPoint\": \"startPoint\",\n \"startTime\": \"startTime\",\n \"forceStart\": true,\n \"stopTracking\": \"stopTracking\",\n \"weight\": \"weight\",\n \"weightUnit\": \"weightUnit\",\n \"freightCharges\": \"freightCharges\",\n \"freightChargeUnit\": \"freightChargeUnit\",\n \"quantity\": \"quantity\",\n \"simultaneousTrackingSequenceNumber\": 1\n },\n \"eventUpdate\": {\n \"modeType\": [\n \"ftl\"\n ],\n \"statusCode\": \"statusCodeevent\",\n \"statusDescription\": \"statusDescriptionevent\",\n \"statusReasonCode\": \"statusReasonCodeevent\",\n \"eventTimeStamp\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"ecta\": {\n \"ecta\": \"ecta\"\n },\n \"city\": \"Event City Code\",\n \"state\": \"Event state code\",\n \"country\": \"Event Country code\",\n \"pickupTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"deliveryTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"delivered\": false,\n \"deliveredAt\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"oceanDataHash\": {\n \"city\": \"City\",\n \"state\": \"State code\",\n \"country\": \"Country Code\",\n \"event_timezone\": \"UTC\",\n \"event_source\": \"dispatcher_async\",\n \"event_date_time\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"ocean_container_number\": \"ocean_container_number\",\n \"update_action\": \"update_action\"\n },\n \"vesselLocation\": \"vesselLocation\",\n \"railEventCode\": \"railEventCode\",\n \"shipmentStatusIndicator\": \"shipmentStatusIndicator\",\n \"shipmentStatus\": \"shipmentStatus\",\n \"failedLoads\": \"failedLoads\",\n \"airDataHash\": {\n \"quantity\": \"1\"\n }\n },\n \"additionalData\": {\n \"simultaneousTrackingReferenceNumber\": \"simultaneousTrackingReferenceNumberadditional\"\n }\n }\n ]\n }\n ]\n }),\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});" }, { "id": "s3OdIeEFTCc1DCqCAXSdU", "language": "swift", "code": "let parameters = \"{\\n \\\"updates\\\": [\\n {\\n \\\"timeZone\\\": \\\"UTC\\\",\\n \\\"billToCode\\\": \\\"Shipper unique id\\\",\\n \\\"identifierKeys\\\": [\\n {\\n \\\"identifier\\\": \\\"Load reference #1\\\",\\n \\\"rawIdentifier\\\": \\\"Carrier format - Load reference #1\\\",\\n \\\"identifierType\\\": \\\"Load reference identifier type in FourKites or Carrier company\\\" \\n },\\n {\\n \\\"identifier\\\": \\\"Load reference #2\\\",\\n \\\"rawIdentifier\\\": \\\"Carrier format - Load reference #2\\\",\\n \\\"identifierType\\\": \\\"Load reference identifier type in FourKites or Carrier company\\\"\\n },\\n {\\n \\\"identifier\\\": \\\"Load reference #3\\\",\\n \\\"rawIdentifier\\\": \\\"Carrier format - Load reference #3\\\",\\n \\\"identifierType\\\": \\\"Load reference identifier type in FourKites or Carrier company\\\"\\n },\\n {\\n \\\"identifier\\\": \\\"Load reference #4\\\",\\n \\\"rawIdentifier\\\": \\\"Carrier format - Load reference #4\\\",\\n \\\"identifierType\\\": \\\"Load reference identifier type in FourKites or Carrier company\\\"\\n }\\n ],\\n \\\"assignmentUpdate\\\": {\\n \\\"operatingCarrierScac\\\": \\\"Operating Carrier SCAC ID\\\",\\n \\\"truckNumber\\\": \\\"Truck Number as in the GPS/ELD portal\\\",\\n \\\"trailerNumber\\\": \\\"Trailer Number as in the GPS/ELD portal\\\",\\n \\\"deviceId\\\": \\\"Device Id as in the GPS/ELD portal\\\",\\n \\\"driverPhone\\\": \\\"Driver Phone Number with the Country Code\\\",\\n \\\"driverName\\\": \\\"Driver Name\\\",\\n \\\"driverLicenseNumber\\\": \\\"Driver Truck License Number\\\",\\n \\\"railEquipmentInitials\\\": \\\"4-character rail equipment prefix\\\",\\n \\\"railEquipmentNumber\\\": \\\"6-digit rail equipment number\\\",\\n \\\"wagonNumber\\\": \\\"Wagon Number\\\",\\n \\\"oceanContainer\\\": \\\"Ocean Containter\\\",\\n \\\"loadMode\\\": \\\"Mode of the load to be assigned\\\"\\n },\\n \\\"stopUpdate\\\": {\\n \\\"appointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"earliestAppointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"latestAppointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"stopType\\\": \\\"pickup\\\",\\n \\\"stopSequence\\\": 1,\\n \\\"stopReferenceId\\\": \\\"stopReferenceId\\\",\\n \\\"postalCode\\\": \\\"postalCode\\\",\\n \\\"statusCode\\\": \\\"statusCodestop\\\",\\n \\\"statusDescription\\\": \\\"statusDescriptionstop\\\",\\n \\\"statusReasonCode\\\": \\\"statusReasonCodestop\\\",\\n \\\"eventTimeStamp\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"earliestAppointmentDateOnly\\\": \\\"YYYY-MM-DD\\\",\\n \\\"earliestAppointmentTimeOnly\\\": \\\"HH:MM:SS\\\",\\n \\\"latestAppointmentDateOnly\\\": \\\"YYYY-MM-DD\\\",\\n \\\"latestAppointmentTimeOnly\\\": \\\"HH:MM:SS\\\",\\n \\\"modeType\\\": [\\n \\\"modeType generally specified as 'intermodal' to update the terminalStops for load\\\"\\n ],\\n \\\"terminalStops\\\": [\\n {\\n \\\"appointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"earliestAppointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"latestAppointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"stopType\\\": \\\"originTerminal\\\",\\n \\\"transportationMode\\\": \\\"transportationMode\\\",\\n \\\"stopSequence\\\": 1,\\n \\\"stopReferenceId\\\": \\\"stopReferenceId\\\",\\n \\\"name\\\": \\\"stopName\\\",\\n \\\"city\\\": \\\"stopCity\\\",\\n \\\"state\\\": \\\"stopState\\\",\\n \\\"country\\\": \\\"stopCountry\\\",\\n \\\"latitude\\\": \\\"47.1667\\\",\\n \\\"longitude\\\": \\\"-2.1667\\\"\\n },\\n {\\n \\\"appointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"earliestAppointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"latestAppointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"stopType\\\": \\\"destinationTerminal\\\",\\n \\\"transportationMode\\\": \\\"transportationMode\\\",\\n \\\"stopSequence\\\": 2,\\n \\\"stopReferenceId\\\": \\\"stopReferenceId\\\",\\n \\\"name\\\": \\\"stopName\\\",\\n \\\"city\\\": \\\"stopCity\\\",\\n \\\"state\\\": \\\"stopState\\\",\\n \\\"country\\\": \\\"stopCountry\\\",\\n \\\"latitude\\\": \\\"47.1667\\\",\\n \\\"longitude\\\": \\\"-2.1667\\\"\\n }\\n ]\\n },\\n \\\"loadUpdate\\\": [\\n {\\n \\\"locationUpdate\\\": {\\n \\\"latitude\\\": \\\"42.42\\\",\\n \\\"longitude\\\": \\\"-87.622003\\\",\\n \\\"locatedAt\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"city\\\": \\\"Location City\\\",\\n \\\"state\\\": \\\"Location State code\\\",\\n \\\"deliveredAt\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\"\\n },\\n \\\"etaUpdate\\\": {\\n \\\"estimatedArrivalAtDestination\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"estimatedArrivalAtDestinationDateOnly\\\": \\\"YYYY-MM-DD\\\"\\n },\\n \\\"temperatureUpdate\\\": {\\n \\\"temperature\\\": \\\"0.2\\\",\\n \\\"sensorName\\\": \\\"sensorName\\\",\\n \\\"temperatureUnit\\\": \\\"C\\\",\\n \\\"temperatureCheckCallTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"temperatureTimestamp\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\"\\n },\\n \\\"loadInfoUpdate\\\": {\\n \\\"tags\\\": [\\n \\\"tags\\\"\\n ],\\n \\\"updatableProNumber\\\": \\\"updatableProNumber\\\",\\n \\\"updatableCarrierReferenceNumber\\\": \\\"updatableCarrierReferenceNumber\\\",\\n \\\"brokeredLoad\\\": false,\\n \\\"relayLoad\\\": true,\\n \\\"simultaneousTrackingReferenceNumber\\\": \\\"simultaneousTrackingReferenceNumberloadinfo\\\",\\n \\\"endPoint\\\": \\\"endPoint\\\",\\n \\\"startPoint\\\": \\\"startPoint\\\",\\n \\\"startTime\\\": \\\"startTime\\\",\\n \\\"forceStart\\\": true,\\n \\\"stopTracking\\\": \\\"stopTracking\\\",\\n \\\"weight\\\": \\\"weight\\\",\\n \\\"weightUnit\\\": \\\"weightUnit\\\",\\n \\\"freightCharges\\\": \\\"freightCharges\\\",\\n \\\"freightChargeUnit\\\": \\\"freightChargeUnit\\\",\\n \\\"quantity\\\": \\\"quantity\\\",\\n \\\"simultaneousTrackingSequenceNumber\\\": 1\\n },\\n \\\"eventUpdate\\\": {\\n \\\"modeType\\\": [\\n \\\"ftl\\\"\\n ],\\n \\\"statusCode\\\": \\\"statusCodeevent\\\",\\n \\\"statusDescription\\\": \\\"statusDescriptionevent\\\",\\n \\\"statusReasonCode\\\": \\\"statusReasonCodeevent\\\",\\n \\\"eventTimeStamp\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"ecta\\\": {\\n \\\"ecta\\\": \\\"ecta\\\"\\n },\\n \\\"city\\\": \\\"Event City Code\\\",\\n \\\"state\\\": \\\"Event state code\\\",\\n \\\"country\\\": \\\"Event Country code\\\",\\n \\\"pickupTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"deliveryTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"delivered\\\": false,\\n \\\"deliveredAt\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"oceanDataHash\\\": {\\n \\\"city\\\": \\\"City\\\",\\n \\\"state\\\": \\\"State code\\\",\\n \\\"country\\\": \\\"Country Code\\\",\\n \\\"event_timezone\\\": \\\"UTC\\\",\\n \\\"event_source\\\": \\\"dispatcher_async\\\",\\n \\\"event_date_time\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"ocean_container_number\\\": \\\"ocean_container_number\\\",\\n \\\"update_action\\\": \\\"update_action\\\"\\n },\\n \\\"vesselLocation\\\": \\\"vesselLocation\\\",\\n \\\"railEventCode\\\": \\\"railEventCode\\\",\\n \\\"shipmentStatusIndicator\\\": \\\"shipmentStatusIndicator\\\",\\n \\\"shipmentStatus\\\": \\\"shipmentStatus\\\",\\n \\\"failedLoads\\\": \\\"failedLoads\\\",\\n \\\"airDataHash\\\": {\\n \\\"quantity\\\": \\\"1\\\"\\n }\\n },\\n \\\"additionalData\\\": {\\n \\\"simultaneousTrackingReferenceNumber\\\": \\\"simultaneousTrackingReferenceNumberadditional\\\"\\n }\\n }\\n ]\\n }\\n ]\\n}\"\nlet postData = parameters.data(using: .utf8)\n\nvar request = URLRequest(url: URL(string: \"https://api.fourkites.com/load/update/dispatcher-api/async\")!,timeoutInterval: Double.infinity)\nrequest.addValue(\"application/json\", forHTTPHeaderField: \"Content-Type\")\nrequest.addValue(\"testkey\", forHTTPHeaderField: \"apikey\")\n\nrequest.httpMethod = \"POST\"\nrequest.httpBody = postData\n\nlet task = URLSession.shared.dataTask(with: request) { data, response, error in \n guard let data = data else {\n print(String(describing: error))\n return\n }\n print(String(data: data, encoding: .utf8)!)\n}\n\ntask.resume()\n" }, { "id": "Ts1oPB12rW-xc0LiKXJZu", "language": "ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.fourkites.com/load/update/dispatcher-api/async\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"Content-Type\"] = \"application/json\"\nrequest[\"apikey\"] = \"testkey\"\nrequest.body = JSON.dump({\n \"updates\": [\n {\n \"timeZone\": \"UTC\",\n \"billToCode\": \"Shipper unique id\",\n \"identifierKeys\": [\n {\n \"identifier\": \"Load reference #1\",\n \"rawIdentifier\": \"Carrier format - Load reference #1\",\n \"identifierType\": \"Load reference identifier type in FourKites or Carrier company\"\n },\n {\n \"identifier\": \"Load reference #2\",\n \"rawIdentifier\": \"Carrier format - Load reference #2\",\n \"identifierType\": \"Load reference identifier type in FourKites or Carrier company\"\n },\n {\n \"identifier\": \"Load reference #3\",\n \"rawIdentifier\": \"Carrier format - Load reference #3\",\n \"identifierType\": \"Load reference identifier type in FourKites or Carrier company\"\n },\n {\n \"identifier\": \"Load reference #4\",\n \"rawIdentifier\": \"Carrier format - Load reference #4\",\n \"identifierType\": \"Load reference identifier type in FourKites or Carrier company\"\n }\n ],\n \"assignmentUpdate\": {\n \"operatingCarrierScac\": \"Operating Carrier SCAC ID\",\n \"truckNumber\": \"Truck Number as in the GPS/ELD portal\",\n \"trailerNumber\": \"Trailer Number as in the GPS/ELD portal\",\n \"deviceId\": \"Device Id as in the GPS/ELD portal\",\n \"driverPhone\": \"Driver Phone Number with the Country Code\",\n \"driverName\": \"Driver Name\",\n \"driverLicenseNumber\": \"Driver Truck License Number\",\n \"railEquipmentInitials\": \"4-character rail equipment prefix\",\n \"railEquipmentNumber\": \"6-digit rail equipment number\",\n \"wagonNumber\": \"Wagon Number\",\n \"oceanContainer\": \"Ocean Containter\",\n \"loadMode\": \"Mode of the load to be assigned\"\n },\n \"stopUpdate\": {\n \"appointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"earliestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"latestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"stopType\": \"pickup\",\n \"stopSequence\": 1,\n \"stopReferenceId\": \"stopReferenceId\",\n \"postalCode\": \"postalCode\",\n \"statusCode\": \"statusCodestop\",\n \"statusDescription\": \"statusDescriptionstop\",\n \"statusReasonCode\": \"statusReasonCodestop\",\n \"eventTimeStamp\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"earliestAppointmentDateOnly\": \"YYYY-MM-DD\",\n \"earliestAppointmentTimeOnly\": \"HH:MM:SS\",\n \"latestAppointmentDateOnly\": \"YYYY-MM-DD\",\n \"latestAppointmentTimeOnly\": \"HH:MM:SS\",\n \"modeType\": [\n \"modeType generally specified as 'intermodal' to update the terminalStops for load\"\n ],\n \"terminalStops\": [\n {\n \"appointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"earliestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"latestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"stopType\": \"originTerminal\",\n \"transportationMode\": \"transportationMode\",\n \"stopSequence\": 1,\n \"stopReferenceId\": \"stopReferenceId\",\n \"name\": \"stopName\",\n \"city\": \"stopCity\",\n \"state\": \"stopState\",\n \"country\": \"stopCountry\",\n \"latitude\": \"47.1667\",\n \"longitude\": \"-2.1667\"\n },\n {\n \"appointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"earliestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"latestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"stopType\": \"destinationTerminal\",\n \"transportationMode\": \"transportationMode\",\n \"stopSequence\": 2,\n \"stopReferenceId\": \"stopReferenceId\",\n \"name\": \"stopName\",\n \"city\": \"stopCity\",\n \"state\": \"stopState\",\n \"country\": \"stopCountry\",\n \"latitude\": \"47.1667\",\n \"longitude\": \"-2.1667\"\n }\n ]\n },\n \"loadUpdate\": [\n {\n \"locationUpdate\": {\n \"latitude\": \"42.42\",\n \"longitude\": \"-87.622003\",\n \"locatedAt\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"city\": \"Location City\",\n \"state\": \"Location State code\",\n \"deliveredAt\": \"YYYY-MM-DDTHH:MM:SSZ\"\n },\n \"etaUpdate\": {\n \"estimatedArrivalAtDestination\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"estimatedArrivalAtDestinationDateOnly\": \"YYYY-MM-DD\"\n },\n \"temperatureUpdate\": {\n \"temperature\": \"0.2\",\n \"sensorName\": \"sensorName\",\n \"temperatureUnit\": \"C\",\n \"temperatureCheckCallTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"temperatureTimestamp\": \"YYYY-MM-DDTHH:MM:SSZ\"\n },\n \"loadInfoUpdate\": {\n \"tags\": [\n \"tags\"\n ],\n \"updatableProNumber\": \"updatableProNumber\",\n \"updatableCarrierReferenceNumber\": \"updatableCarrierReferenceNumber\",\n \"brokeredLoad\": false,\n \"relayLoad\": true,\n \"simultaneousTrackingReferenceNumber\": \"simultaneousTrackingReferenceNumberloadinfo\",\n \"endPoint\": \"endPoint\",\n \"startPoint\": \"startPoint\",\n \"startTime\": \"startTime\",\n \"forceStart\": true,\n \"stopTracking\": \"stopTracking\",\n \"weight\": \"weight\",\n \"weightUnit\": \"weightUnit\",\n \"freightCharges\": \"freightCharges\",\n \"freightChargeUnit\": \"freightChargeUnit\",\n \"quantity\": \"quantity\",\n \"simultaneousTrackingSequenceNumber\": 1\n },\n \"eventUpdate\": {\n \"modeType\": [\n \"ftl\"\n ],\n \"statusCode\": \"statusCodeevent\",\n \"statusDescription\": \"statusDescriptionevent\",\n \"statusReasonCode\": \"statusReasonCodeevent\",\n \"eventTimeStamp\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"ecta\": {\n \"ecta\": \"ecta\"\n },\n \"city\": \"Event City Code\",\n \"state\": \"Event state code\",\n \"country\": \"Event Country code\",\n \"pickupTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"deliveryTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"delivered\": false,\n \"deliveredAt\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"oceanDataHash\": {\n \"city\": \"City\",\n \"state\": \"State code\",\n \"country\": \"Country Code\",\n \"event_timezone\": \"UTC\",\n \"event_source\": \"dispatcher_async\",\n \"event_date_time\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"ocean_container_number\": \"ocean_container_number\",\n \"update_action\": \"update_action\"\n },\n \"vesselLocation\": \"vesselLocation\",\n \"railEventCode\": \"railEventCode\",\n \"shipmentStatusIndicator\": \"shipmentStatusIndicator\",\n \"shipmentStatus\": \"shipmentStatus\",\n \"failedLoads\": \"failedLoads\",\n \"airDataHash\": {\n \"quantity\": \"1\"\n }\n },\n \"additionalData\": {\n \"simultaneousTrackingReferenceNumber\": \"simultaneousTrackingReferenceNumberadditional\"\n }\n }\n ]\n }\n ]\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "qZ3oe-Xl6XZ18UPMFYd5n", "language": "python", "code": "import http.client\nimport json\n\nconn = http.client.HTTPSConnection(\"api.fourkites.com\")\npayload = json.dumps({\n \"updates\": [\n {\n \"timeZone\": \"UTC\",\n \"billToCode\": \"Shipper unique id\",\n \"identifierKeys\": [\n {\n \"identifier\": \"Load reference #1\",\n \"rawIdentifier\": \"Carrier format - Load reference #1\",\n \"identifierType\": \"Load reference identifier type in FourKites or Carrier company\"\n },\n {\n \"identifier\": \"Load reference #2\",\n \"rawIdentifier\": \"Carrier format - Load reference #2\",\n \"identifierType\": \"Load reference identifier type in FourKites or Carrier company\"\n },\n {\n \"identifier\": \"Load reference #3\",\n \"rawIdentifier\": \"Carrier format - Load reference #3\",\n \"identifierType\": \"Load reference identifier type in FourKites or Carrier company\"\n },\n {\n \"identifier\": \"Load reference #4\",\n \"rawIdentifier\": \"Carrier format - Load reference #4\",\n \"identifierType\": \"Load reference identifier type in FourKites or Carrier company\"\n }\n ],\n \"assignmentUpdate\": {\n \"operatingCarrierScac\": \"Operating Carrier SCAC ID\",\n \"truckNumber\": \"Truck Number as in the GPS/ELD portal\",\n \"trailerNumber\": \"Trailer Number as in the GPS/ELD portal\",\n \"deviceId\": \"Device Id as in the GPS/ELD portal\",\n \"driverPhone\": \"Driver Phone Number with the Country Code\",\n \"driverName\": \"Driver Name\",\n \"driverLicenseNumber\": \"Driver Truck License Number\",\n \"railEquipmentInitials\": \"4-character rail equipment prefix\",\n \"railEquipmentNumber\": \"6-digit rail equipment number\",\n \"wagonNumber\": \"Wagon Number\",\n \"oceanContainer\": \"Ocean Containter\",\n \"loadMode\": \"Mode of the load to be assigned\"\n },\n \"stopUpdate\": {\n \"appointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"earliestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"latestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"stopType\": \"pickup\",\n \"stopSequence\": 1,\n \"stopReferenceId\": \"stopReferenceId\",\n \"postalCode\": \"postalCode\",\n \"statusCode\": \"statusCodestop\",\n \"statusDescription\": \"statusDescriptionstop\",\n \"statusReasonCode\": \"statusReasonCodestop\",\n \"eventTimeStamp\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"earliestAppointmentDateOnly\": \"YYYY-MM-DD\",\n \"earliestAppointmentTimeOnly\": \"HH:MM:SS\",\n \"latestAppointmentDateOnly\": \"YYYY-MM-DD\",\n \"latestAppointmentTimeOnly\": \"HH:MM:SS\",\n \"modeType\": [\n \"modeType generally specified as 'intermodal' to update the terminalStops for load\"\n ],\n \"terminalStops\": [\n {\n \"appointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"earliestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"latestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"stopType\": \"originTerminal\",\n \"transportationMode\": \"transportationMode\",\n \"stopSequence\": 1,\n \"stopReferenceId\": \"stopReferenceId\",\n \"name\": \"stopName\",\n \"city\": \"stopCity\",\n \"state\": \"stopState\",\n \"country\": \"stopCountry\",\n \"latitude\": \"47.1667\",\n \"longitude\": \"-2.1667\"\n },\n {\n \"appointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"earliestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"latestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"stopType\": \"destinationTerminal\",\n \"transportationMode\": \"transportationMode\",\n \"stopSequence\": 2,\n \"stopReferenceId\": \"stopReferenceId\",\n \"name\": \"stopName\",\n \"city\": \"stopCity\",\n \"state\": \"stopState\",\n \"country\": \"stopCountry\",\n \"latitude\": \"47.1667\",\n \"longitude\": \"-2.1667\"\n }\n ]\n },\n \"loadUpdate\": [\n {\n \"locationUpdate\": {\n \"latitude\": \"42.42\",\n \"longitude\": \"-87.622003\",\n \"locatedAt\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"city\": \"Location City\",\n \"state\": \"Location State code\",\n \"deliveredAt\": \"YYYY-MM-DDTHH:MM:SSZ\"\n },\n \"etaUpdate\": {\n \"estimatedArrivalAtDestination\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"estimatedArrivalAtDestinationDateOnly\": \"YYYY-MM-DD\"\n },\n \"temperatureUpdate\": {\n \"temperature\": \"0.2\",\n \"sensorName\": \"sensorName\",\n \"temperatureUnit\": \"C\",\n \"temperatureCheckCallTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"temperatureTimestamp\": \"YYYY-MM-DDTHH:MM:SSZ\"\n },\n \"loadInfoUpdate\": {\n \"tags\": [\n \"tags\"\n ],\n \"updatableProNumber\": \"updatableProNumber\",\n \"updatableCarrierReferenceNumber\": \"updatableCarrierReferenceNumber\",\n \"brokeredLoad\": False,\n \"relayLoad\": True,\n \"simultaneousTrackingReferenceNumber\": \"simultaneousTrackingReferenceNumberloadinfo\",\n \"endPoint\": \"endPoint\",\n \"startPoint\": \"startPoint\",\n \"startTime\": \"startTime\",\n \"forceStart\": True,\n \"stopTracking\": \"stopTracking\",\n \"weight\": \"weight\",\n \"weightUnit\": \"weightUnit\",\n \"freightCharges\": \"freightCharges\",\n \"freightChargeUnit\": \"freightChargeUnit\",\n \"quantity\": \"quantity\",\n \"simultaneousTrackingSequenceNumber\": 1\n },\n \"eventUpdate\": {\n \"modeType\": [\n \"ftl\"\n ],\n \"statusCode\": \"statusCodeevent\",\n \"statusDescription\": \"statusDescriptionevent\",\n \"statusReasonCode\": \"statusReasonCodeevent\",\n \"eventTimeStamp\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"ecta\": {\n \"ecta\": \"ecta\"\n },\n \"city\": \"Event City Code\",\n \"state\": \"Event state code\",\n \"country\": \"Event Country code\",\n \"pickupTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"deliveryTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"delivered\": False,\n \"deliveredAt\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"oceanDataHash\": {\n \"city\": \"City\",\n \"state\": \"State code\",\n \"country\": \"Country Code\",\n \"event_timezone\": \"UTC\",\n \"event_source\": \"dispatcher_async\",\n \"event_date_time\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"ocean_container_number\": \"ocean_container_number\",\n \"update_action\": \"update_action\"\n },\n \"vesselLocation\": \"vesselLocation\",\n \"railEventCode\": \"railEventCode\",\n \"shipmentStatusIndicator\": \"shipmentStatusIndicator\",\n \"shipmentStatus\": \"shipmentStatus\",\n \"failedLoads\": \"failedLoads\",\n \"airDataHash\": {\n \"quantity\": \"1\"\n }\n },\n \"additionalData\": {\n \"simultaneousTrackingReferenceNumber\": \"simultaneousTrackingReferenceNumberadditional\"\n }\n }\n ]\n }\n ]\n})\nheaders = {\n 'Content-Type': 'application/json',\n 'apikey': 'testkey'\n}\nconn.request(\"POST\", \"/load/update/dispatcher-api/async\", payload, headers)\nres = conn.getresponse()\ndata = res.read()\nprint(data.decode(\"utf-8\"))" } ], "selectedLanguageId": "A7Tsvgnmw7rglHtFt1mgt" }, "results": { "languages": [ { "id": "WddmdrqmVG0OooSGjBrDt", "language": "202", "customLabel": "", "code": "{\n \"requestId\": \"294626f6-f822-42f9-9a9f-bcb6dc6ccb27\",\n \"status\": \"202\",\n \"message\": \"API Request Accepted\",\n \"timestamp\": \"2023-09-29T13:56:41.511402\"\n}" } ], "selectedLanguageId": "WddmdrqmVG0OooSGjBrDt" }, "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [], "bodyDataParameters": [ { "name": "updates", "kind": "required", "type": "object", "description": "The updates object contains all the relevant, event-specific parameters.", "children": [ { "name": "timeZone", "kind": "optional", "type": "string", "description": "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" }, { "name": "billToCode", "kind": "optional", "type": "string", "description": "The Bill-to Code is an internal identifier in the carrier's TMS system -- it is used to identify the shipper to which an individual load belongs. " }, { "name": "identifierKeys", "kind": "optional", "type": "object", "description": "Different types of identifier keys.", "children": [ { "name": "identifier", "kind": "optional", "type": "string", "description": "" }, { "name": "rawIdentifier", "kind": "optional", "type": "string", "description": "" }, { "name": "identifierType", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "assignmentUpdate", "kind": "optional", "type": "object", "description": "AssignmentUpdate keys can have one or more fields (given below) of tracking assignment to the FourKites load.", "children": [ { "name": "operatingCarrierScac", "kind": "optional", "type": "string", "description": "Enter the SCAC assigned by a Managing Carrier (3PL or broker) to an Operating Carrier. When a Carrier brokers out a load to another Operating Carrier, this field will be used to identify the load in an operating carrier's file" }, { "name": "truckNumber", "kind": "optional", "type": "string", "description": "Enter the tractor number assigned to the load. Ex: \"TrucktoTrack\"" }, { "name": "trailerNumber", "kind": "optional", "type": "string", "description": "Enter the trailer number assigned to the load. Ex: \"TrailertoTrailer\"" }, { "name": "deviceId", "kind": "optional", "type": "string", "description": "Enter the device id number assigned to the load. Ex: \"DeviceIdtoTrack\"" }, { "name": "driverPhone", "kind": "optional", "type": "string", "description": "Enter the phone number of the driver currently assigned to the load. The phone number must start with a \"+\" sign followed by the ISD code and then the mobile number. Ex: \"+19999999999\"" }, { "name": "driverName", "kind": "optional", "type": "string", "description": "It indicates the name of the driver. \"Jack\"" }, { "name": "driverLicenseNumber", "kind": "optional", "type": "string", "description": "It indicates the driver’s truck license number. \"AU 73777\"" }, { "name": "railEquipmentInitials", "kind": "optional", "type": "string", "description": "Enter the 4-character rail equipment prefix. \"AXYZ\"" }, { "name": "railEquipmentNumber", "kind": "optional", "type": "string", "description": "Enter the 6-digit rail equipment number. \"985472\"" }, { "name": "wagonNumber", "kind": "optional", "type": "string", "description": "Enter the Wagon Number if applicable" }, { "name": "oceanContainer", "kind": "optional", "type": "string", "description": "Enter the Ocean Container if applicable. Note: this field is mandatory if any ocean mode event updates. \"ABC12345678\"" } ] }, { "name": "stopUpdate", "kind": "optional", "type": "object", "description": "StopUpdates key can be used to provide any stop level (pickup, delivery, or terminal) updates to the FourKites load. For standard stop updates such as pickup and delivery, at least one of stopSequence, stopReferenceId, or postalCode is required to identify the stop. For intermodal terminal stop creation via the terminalStops array, this constraint does not apply — the stopSequence within each terminalStops object is used for identification instead.\n\nThe stopUpdate object supports creating and updating intermodal terminal stops (origin and destination terminals) on a load. To use this capability, set modeType to \"intermodal\" and include the terminalStops array within stopUpdate.\n\nTerminal stops represent intermediate rail or ocean terminals in an intermodal journey and are distinct from standard pickup and delivery stops. Each terminal stop must have a unique stopSequence and a stopType of either \"originTerminal\" or \"destinationTerminal\".", "children": [ { "name": "appointmentTime", "kind": "optional", "type": "string", "description": "It indicates the scheduled appointment time at the stop in the stop's local timezone in ISO 8601 format. Ex: \"2017-11-23T07:55:00Z\"" }, { "name": "earliestAppointmentTime", "kind": "optional", "type": "string", "description": "Enter the earliest scheduled arrival time for the stop in stop's local timezone, given in ISO 8601 format. To update a stop's appointment time, the stopSequence or the stopReferenceId should also be specified. If you wish to provide a single appointment time and not a time range, use the same value here as with latestAppointmentTime. Ex: \"2017-11-23T07:55:00Z\"" }, { "name": "latestAppointmentTime", "kind": "optional", "type": "string", "description": "Enter the latest scheduled arrival time for the stop in stop's local timezone, given in ISO 8601 format. To update a stop's appointment time, the stopSequence or the stopReferenceId should also be specified. If you wish to provide a single appointment time and not a time range, use the same value here as with earliestAppointmentTime. Ex: \"2017-11-23T07:55:00Z\"" }, { "name": "stopType", "kind": "required", "type": "string", "description": "It defines the function of the stop. Valid values: \"pickup\", \"delivery\", \"transfer\", \"portOfLoading\", \"transshipmentPort\", \"portOfDischarge\". There should be at least one pickup and delivery stop or one transfer (terminal) and one delivery. For ocean loads, there should be at least one portOfLoading and one portOfDischarge stop." }, { "name": "stopSequence", "kind": "required", "type": "string", "description": "Enter the stop sequence of the stop. The stopSequence is used to identify the stop for which the appointment time or status reason code is updated. Note: This stop sequence you specify should be present at the stop in the load (BOL) mentioned. For example, if you wish to update the appointment time or reason code for a stop with stop sequence 2, enter the value as 2. Ex: \"2\"" }, { "name": "stopReferenceId", "kind": "required", "type": "string", "description": "Enter the stop reference ID of the stop in the load for which the appointment time should be updated. The stopSequence is used to identify the stop for which the appointment time or status reason code is updated. Note: The stop reference ID you specify should be present at the stop in the load (BOL) mentioned. For example, if you wish to update the appointment time or reason code for a stop with stop reference id 1234, enter the value as 1234. Ex: \"1234\"\n\n\n" }, { "name": "postalCode", "kind": "required", "type": "string", "description": "It indicates the postal/zip code of the stop. Ex: \"75201\"" }, { "name": "statusCode", "kind": "optional", "type": "string", "description": "It indicates the status code for processing stop level event Note: The stopSequence or the stopReferenceId should also be specified. Ex: \"AF\"" }, { "name": "statusDescription", "kind": "optional", "type": "string", "description": "It indicates the status message for processing stop level event Note: The stopSequence or the stopReferenceId should also be specified. Ex: \"Picked Up\"" }, { "name": "statusReasonCode", "kind": "optional", "type": "string", "description": "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. Ex: \"Severe_Weather_Conditions\"" }, { "name": "eventTimeStamp", "kind": "optional", "type": "string", "description": "It indicates the date time for processing stop level event Note: The stopSequence or the stopReferenceId should also be specified. Ex: \"2017-11-23T07:55:00Z\"" }, { "name": "modeType", "kind": "optional", "type": "string", "description": "Specifies the transportation mode for the load. Must be set to \"intermodal\" to enable creation or updating of terminal stops via the terminalStops array. Without this value, terminalStops data will not be processed." }, { "name": "terminalStops", "kind": "optional", "type": "object", "description": "Array of terminal stop objects for intermodal loads. Use this to create or update origin and destination terminal stops on a load. Requires modeType to be set to \"intermodal\". Each terminal stop must have a unique stopSequence. Valid stopType values are \"originTerminal\" and \"destinationTerminal\".", "children": [ { "name": "appointmentTime", "kind": "optional", "type": "string", "description": "The scheduled appointment time at the stop. Format: YYYY-MM-DDTHH:MM:SSZ" }, { "name": "earliestAppointmentTime", "kind": "optional", "type": "string", "description": "The earliest acceptable appointment time at the stop. Format: YYYY-MM-DDTHH:MM:SSZ" }, { "name": "latestAppointmentTime", "kind": "optional", "type": "string", "description": "The latest acceptable appointment time at the stop. Format: YYYY-MM-DDTHH:MM:SSZ" }, { "name": "stopType", "kind": "required", "type": "string", "description": "Indicates the role of the stop in the journey. Example value: \"originTerminal\"" }, { "name": "transportationMode", "kind": "optional", "type": "string", "description": "The mode of transport used at or from this stop (e.g., rail, truck)." }, { "name": "stopSequence", "kind": "required", "type": "string", "description": "The order of this stop in the overall route. Starts at 1 for the first stop." }, { "name": "stopReferenceId", "kind": "optional", "type": "string", "description": "A unique identifier for the stop, used for referencing or matching against existing stop records." }, { "name": "name", "kind": "required", "type": "string", "description": "The display name of the terminal stop." }, { "name": "city", "kind": "required", "type": "string", "description": "The city where the terminal stop is located." }, { "name": "state", "kind": "optional", "type": "string", "description": "The state or province where the terminal stop is located." }, { "name": "country", "kind": "required", "type": "string", "description": "The country where the terminal stop is located." }, { "name": "latitude", "kind": "optional", "type": "string", "description": "The geographic latitude of the stop. Example: \"47.1667\"" }, { "name": "longitude", "kind": "optional", "type": "string", "description": "The geographic longitude of the stop. Example: \"-2.1667\"" } ] } ] }, { "name": "loadUpdate", "kind": "optional", "type": "object", "description": "LoadUpdate key is to update Load level information. ", "children": [ { "name": "locationUpdate", "kind": "optional", "type": "object", "description": "LocationUpdate key can be used for providing latest GPS coordinates updates to the FourKites load. ", "children": [ { "name": "latitude", "kind": "required", "type": "string", "description": "Enter the latitude of the truck's current location The only accepted format of lat/long by FOURKITES® is the \"Decimal Degrees\" format. For example, 41.8781 (lat) and -87.6298 (long). Ex: \"41.898274\"" }, { "name": "longitude", "kind": "required", "type": "string", "description": "Enter the longitude of the truck's current location The only accepted format of lat/long by FOURKITES® is the \"Decimal Degrees\" format. For example, 41.8781 (lat) and -87.6298 (long). Ex: \"-88.028452\"" }, { "name": "locatedAt", "kind": "required", "type": "string", "description": "Enter the timestamp at which the latitude and longitude values were recorded for location. This field is usually given along with the latitude/longitude values. If no value is given, the current time will be considered as locatedAt value. Ex: \"2017-11-23T07:55:00Z\"\n" }, { "name": "city", "kind": "optional", "type": "string", "description": "Enter the city name of the truck's current location. Ex: \"Chicago\"" }, { "name": "state", "kind": "optional", "type": "string", "description": "Enter the 2 digit state code of the truck location. Ex: \"IL\"" }, { "name": "deliveredAt", "kind": "optional", "type": "string", "description": "Enter the time at which the shipment was delivered at the final consignee, given in ISO 8601 format. This value is usually provided to indicate that a load was delivered. If no value is given, deliveredAt will default to the current time. Ex: \"2017-11-23T07:55:00Z\"" } ] }, { "name": "etaUpdate", "kind": "optional", "type": "object", "description": "EtaUpdate key can be used to send carrier ETA for the Load. This eta fields given is processed as overall Load Eta or the final delivery ETA.", "children": [ { "name": "estimatedArrivalAtDestination", "kind": "optional", "type": "string", "description": "It indicates the Load ETA datetime to destination provided by the carrier. Ex: \"2017-11-23T07:55:00Z\"" }, { "name": "estimatedArrivalAtDestinationDateOnly", "kind": "optional", "type": "string", "description": "If there is only Load Date available and no time, this field can be used to pass the date only format. Ex: \"2017-11-23\"" } ] }, { "name": "temperatureUpdate", "kind": "optional", "type": "object", "description": "Temperature Update key is to provide Temperature updates to the FourKites Load", "children": [ { "name": "temperature", "kind": "required", "type": "string", "description": "Enter the target temperature at which a product is maintained. Ex: \"20\"" }, { "name": "sensorName", "kind": "optional", "type": "string", "description": "\"Enter the sensor name\". Ex: \"SensorName1\"" }, { "name": "temperatureUnit", "kind": "optional", "type": "string", "description": "Enter the unit of the temperature in which the product is maintained. The valid values are \"C\" for Celsius and \"F\" for Fahrenheit. If no value is given, the unit defaults to Fahrenheit. Ex: \"F\"\n" }, { "name": "temperatureCheckCallTime", "kind": "optional", "type": "string", "description": "It indicates the check call time at which the temperature reading of the product was taken. Ex: \"2017-11-23T07:55:00Z\"" }, { "name": "temperatureTimestamp", "kind": "optional", "type": "string", "description": "Enter the timestamp at which the temperature reading was sent. If no value is given, the current time will be taken. \"2017-11-23T07:55:00Z\"" } ] }, { "name": "loadInfoUpdate", "kind": "optional", "type": "object", "description": "LoadInfoUpdate key is to update Load level information. These can be tags, proNumbers, or any of the below - which can be updated to the FourKites Load.", "children": [ { "name": "tags", "kind": "optional", "type": "array", "description": "It indicates the tag specified by a company for a load. Ex: \"tags\":[\"tag1\", \"tag2\", \"tag3\"]" }, { "name": "updatableProNumber", "kind": "optional", "type": "string", "description": "It indicates the updatable field where carrier can update (if not already) proNumber to the FourKites load. Note: This is not an identifying field, which will be used to search and match loads. Ex: \"proNumber\"" }, { "name": "updatableCarrierReferenceNumber", "kind": "optional", "type": "string", "description": "It is the list of carrier reference numbers assigned by managing carriers for operating carriers to match on loads." }, { "name": "brokeredLoad", "kind": "optional", "type": "boolean", "description": "It indicates if the load is a brokered load or not. Ex: true or false" }, { "name": "relayLoad", "kind": "optional", "type": "boolean", "description": "It indicates if the load is a relay load or not. Ex: true or false" }, { "name": "simultaneousTrackingReferenceNumber", "kind": "optional", "type": "string", "description": "It indicates a simultaneous tracking reference number across a group of simultaneous loads in order to group them. Ex: \"sim007654\"" }, { "name": "endPoint", "kind": "optional", "type": "string", "description": "" }, { "name": "startPoint", "kind": "optional", "type": "string", "description": "" }, { "name": "startTime", "kind": "optional", "type": "string", "description": "" }, { "name": "forceStart", "kind": "optional", "type": "string", "description": "It indicates the timestamp the sequenced load is due to start tracking. Ex: \"2021-10-25T10:00:00.000Z\"" }, { "name": "stopTracking", "kind": "optional", "type": "boolean", "description": "It indicates that the tracking of the load is stopped. Ex: True or False" }, { "name": "weight", "kind": "optional", "type": "string", "description": "It indicates the load’s weight. Ex: \"96\"" }, { "name": "weightUnit", "kind": "optional", "type": "string", "description": "It indicates the unit of mass and weight of the load. Ex: \"KG\"" }, { "name": "freightCharges", "kind": "optional", "type": "string", "description": "It indicates the freight charges" }, { "name": "freightChargeUnit", "kind": "optional", "type": "string", "description": "It indicates the unit of currency of the freight charges. Ex: \"USD\"" }, { "name": "quantity", "kind": "optional", "type": "string", "description": "It indicates the total quantity of the load. Ex: \"88\"" }, { "name": "simultaneousTrackingSequenceNumber", "kind": "optional", "type": "number", "description": "It is the unique sequence number that represents the sequence of deliveries for the simultaneous loads to predict better ETAs." } ] }, { "name": "eventUpdate", "kind": "optional", "type": "object", "description": "EventUpdate key can be used for providing event or status updates to the FourKites load.", "children": [ { "name": "modeType", "kind": "optional", "type": "array", "description": "Load mode types." }, { "name": "statusCode", "kind": "optional", "type": "string", "description": "It indicates the load event status code. Ex: \"AF\"" }, { "name": "statusDescription", "kind": "optional", "type": "string", "description": "It indicates the load event status message. Ex: \"Picked Up\"" }, { "name": "statusReasonCode", "kind": "optional", "type": "string", "description": "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. Ex: \"Severe_Weather_Conditions\"" }, { "name": "eventTimeStamp", "kind": "optional", "type": "string", "description": "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. Ex: \"2017-11-23T07:55:00Z\"" }, { "name": "ecta", "kind": "optional", "type": "object", "description": "Carrier can send ECTA (European Chemical Transport Association) event codes in this object key Note: This is applicable only for LTL mode loads", "children": [ { "name": "status", "kind": "optional", "type": "string", "description": "Ecta Status. Ex: { \"Status\": \"Booking confirmation\", \"Timestamp\": \"2021-06-03T14:30:00Z\", \"StatusDescription\": \"Booking confirmation\" }" } ] }, { "name": "city", "kind": "optional", "type": "string", "description": "Enter the city name of the load event. Ex: \"Chicago\"" }, { "name": "state", "kind": "optional", "type": "string", "description": "Enter the 2 digit state code of the load event. Ex: \"IL\"" }, { "name": "country", "kind": "optional", "type": "string", "description": "Enter the 2 digit county code. Ex: \"US\"" }, { "name": "pickupTime", "kind": "optional", "type": "string", "description": "It indicates the time when the load was picked up Note: This is applicable only for LTL mode loads. Ex: \"2017-11-23T07:55:00Z\"" }, { "name": "deliveryTime", "kind": "optional", "type": "string", "description": "It indicates the time when the load was delivered Note: This is applicable only for LTL mode loads. Ex: \"2017-11-23T07:55:00Z\"" }, { "name": "delivered", "kind": "optional", "type": "boolean", "description": "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. Ex: True or False" }, { "name": "oceanDataHash", "kind": "optional", "type": "object", "description": "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\" }" }, { "name": "vesselLocation", "kind": "optional", "type": "string", "description": "Note: This is applicable only for Ocean/Intermodal mode loads Also OceanContainer is mandatory in \"assignmentUpdate\" Key" }, { "name": "railEventCode", "kind": "optional", "type": "string", "description": "It indicates the rail event code Note: This is applicable for only Rail mode loads. Ex: \"X6\"" }, { "name": "shipmentStatusIndicator", "kind": "optional", "type": "string", "description": "It indicates the status indicator of the shipment Note: This is applicable for only Rail mode loads. Ex: \"X6\"" }, { "name": "shipmentStatus", "kind": "optional", "type": "string", "description": "It indicates the status of the shipment Note: This is applicable for only Rail mode loads. Ex: \"AR\"" }, { "name": "failedLoads", "kind": "optional", "type": "string", "description": "" }, { "name": "airDataHash", "kind": "optional", "type": "object", "description": "Enter Air event tracking update if applicable in this object key Note: This is applicable only for Air mode loads", "children": [ { "name": "quantity", "kind": "optional", "type": "string", "description": "Total quantity." } ] } ] } ] } ], "schema": [ { "name": "timeZone", "kind": "optional", "type": "string", "description": "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" }, { "name": "billToCode", "kind": "optional", "type": "string", "description": "The Bill-to Code is an internal identifier in the carrier's TMS system -- it is used to identify the shipper to which an individual load belongs. " }, { "name": "identifierKeys", "kind": "optional", "type": "object", "description": "Different types of identifier keys.", "children": [ { "name": "identifier", "kind": "optional", "type": "string", "description": "" }, { "name": "rawIdentifier", "kind": "optional", "type": "string", "description": "" }, { "name": "identifierType", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "assignmentUpdate", "kind": "optional", "type": "object", "description": "AssignmentUpdate keys can have one or more fields (given below) of tracking assignment to the FourKites load.", "children": [ { "name": "operatingCarrierScac", "kind": "optional", "type": "string", "description": "Enter the SCAC assigned by a Managing Carrier (3PL or broker) to an Operating Carrier. When a Carrier brokers out a load to another Operating Carrier, this field will be used to identify the load in an operating carrier's file" }, { "name": "truckNumber", "kind": "optional", "type": "string", "description": "Enter the tractor number assigned to the load. Ex: \"TrucktoTrack\"" }, { "name": "trailerNumber", "kind": "optional", "type": "string", "description": "Enter the trailer number assigned to the load. Ex: \"TrailertoTrailer\"" }, { "name": "deviceId", "kind": "optional", "type": "string", "description": "Enter the device id number assigned to the load. Ex: \"DeviceIdtoTrack\"" }, { "name": "driverPhone", "kind": "optional", "type": "string", "description": "Enter the phone number of the driver currently assigned to the load. The phone number must start with a \"+\" sign followed by the ISD code and then the mobile number. Ex: \"+19999999999\"" }, { "name": "driverName", "kind": "optional", "type": "string", "description": "It indicates the name of the driver. \"Jack\"" }, { "name": "driverLicenseNumber", "kind": "optional", "type": "string", "description": "It indicates the driver’s truck license number. \"AU 73777\"" }, { "name": "railEquipmentInitials", "kind": "optional", "type": "string", "description": "Enter the 4-character rail equipment prefix. \"AXYZ\"" }, { "name": "railEquipmentNumber", "kind": "optional", "type": "string", "description": "Enter the 6-digit rail equipment number. \"985472\"" }, { "name": "wagonNumber", "kind": "optional", "type": "string", "description": "Enter the Wagon Number if applicable" }, { "name": "oceanContainer", "kind": "optional", "type": "string", "description": "Enter the Ocean Container if applicable. Note: this field is mandatory if any ocean mode event updates. \"ABC12345678\"" } ] }, { "name": "stopUpdate", "kind": "optional", "type": "object", "description": "StopUpdates key can be used to provide any stop level (pickup, delivery, or terminal) updates to the FourKites load. For standard stop updates such as pickup and delivery, at least one of stopSequence, stopReferenceId, or postalCode is required to identify the stop. For intermodal terminal stop creation via the terminalStops array, this constraint does not apply — the stopSequence within each terminalStops object is used for identification instead.\n\nThe stopUpdate object supports creating and updating intermodal terminal stops (origin and destination terminals) on a load. To use this capability, set modeType to \"intermodal\" and include the terminalStops array within stopUpdate.\n\nTerminal stops represent intermediate rail or ocean terminals in an intermodal journey and are distinct from standard pickup and delivery stops. Each terminal stop must have a unique stopSequence and a stopType of either \"originTerminal\" or \"destinationTerminal\".", "children": [ { "name": "appointmentTime", "kind": "optional", "type": "string", "description": "It indicates the scheduled appointment time at the stop in the stop's local timezone in ISO 8601 format. Ex: \"2017-11-23T07:55:00Z\"" }, { "name": "earliestAppointmentTime", "kind": "optional", "type": "string", "description": "Enter the earliest scheduled arrival time for the stop in stop's local timezone, given in ISO 8601 format. To update a stop's appointment time, the stopSequence or the stopReferenceId should also be specified. If you wish to provide a single appointment time and not a time range, use the same value here as with latestAppointmentTime. Ex: \"2017-11-23T07:55:00Z\"" }, { "name": "latestAppointmentTime", "kind": "optional", "type": "string", "description": "Enter the latest scheduled arrival time for the stop in stop's local timezone, given in ISO 8601 format. To update a stop's appointment time, the stopSequence or the stopReferenceId should also be specified. If you wish to provide a single appointment time and not a time range, use the same value here as with earliestAppointmentTime. Ex: \"2017-11-23T07:55:00Z\"" }, { "name": "stopType", "kind": "required", "type": "string", "description": "It defines the function of the stop. Valid values: \"pickup\", \"delivery\", \"transfer\", \"portOfLoading\", \"transshipmentPort\", \"portOfDischarge\". There should be at least one pickup and delivery stop or one transfer (terminal) and one delivery. For ocean loads, there should be at least one portOfLoading and one portOfDischarge stop." }, { "name": "stopSequence", "kind": "required", "type": "string", "description": "Enter the stop sequence of the stop. The stopSequence is used to identify the stop for which the appointment time or status reason code is updated. Note: This stop sequence you specify should be present at the stop in the load (BOL) mentioned. For example, if you wish to update the appointment time or reason code for a stop with stop sequence 2, enter the value as 2. Ex: \"2\"" }, { "name": "stopReferenceId", "kind": "required", "type": "string", "description": "Enter the stop reference ID of the stop in the load for which the appointment time should be updated. The stopSequence is used to identify the stop for which the appointment time or status reason code is updated. Note: The stop reference ID you specify should be present at the stop in the load (BOL) mentioned. For example, if you wish to update the appointment time or reason code for a stop with stop reference id 1234, enter the value as 1234. Ex: \"1234\"\n\n\n" }, { "name": "postalCode", "kind": "required", "type": "string", "description": "It indicates the postal/zip code of the stop. Ex: \"75201\"" }, { "name": "statusCode", "kind": "optional", "type": "string", "description": "It indicates the status code for processing stop level event Note: The stopSequence or the stopReferenceId should also be specified. Ex: \"AF\"" }, { "name": "statusDescription", "kind": "optional", "type": "string", "description": "It indicates the status message for processing stop level event Note: The stopSequence or the stopReferenceId should also be specified. Ex: \"Picked Up\"" }, { "name": "statusReasonCode", "kind": "optional", "type": "string", "description": "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. Ex: \"Severe_Weather_Conditions\"" }, { "name": "eventTimeStamp", "kind": "optional", "type": "string", "description": "It indicates the date time for processing stop level event Note: The stopSequence or the stopReferenceId should also be specified. Ex: \"2017-11-23T07:55:00Z\"" }, { "name": "modeType", "kind": "optional", "type": "string", "description": "Specifies the transportation mode for the load. Must be set to \"intermodal\" to enable creation or updating of terminal stops via the terminalStops array. Without this value, terminalStops data will not be processed." }, { "name": "terminalStops", "kind": "optional", "type": "object", "description": "Array of terminal stop objects for intermodal loads. Use this to create or update origin and destination terminal stops on a load. Requires modeType to be set to \"intermodal\". Each terminal stop must have a unique stopSequence. Valid stopType values are \"originTerminal\" and \"destinationTerminal\".", "children": [ { "name": "appointmentTime", "kind": "optional", "type": "string", "description": "The scheduled appointment time at the stop. Format: YYYY-MM-DDTHH:MM:SSZ" }, { "name": "earliestAppointmentTime", "kind": "optional", "type": "string", "description": "The earliest acceptable appointment time at the stop. Format: YYYY-MM-DDTHH:MM:SSZ" }, { "name": "latestAppointmentTime", "kind": "optional", "type": "string", "description": "The latest acceptable appointment time at the stop. Format: YYYY-MM-DDTHH:MM:SSZ" }, { "name": "stopType", "kind": "required", "type": "string", "description": "Indicates the role of the stop in the journey. Example value: \"originTerminal\"" }, { "name": "transportationMode", "kind": "optional", "type": "string", "description": "The mode of transport used at or from this stop (e.g., rail, truck)." }, { "name": "stopSequence", "kind": "required", "type": "string", "description": "The order of this stop in the overall route. Starts at 1 for the first stop." }, { "name": "stopReferenceId", "kind": "optional", "type": "string", "description": "A unique identifier for the stop, used for referencing or matching against existing stop records." }, { "name": "name", "kind": "required", "type": "string", "description": "The display name of the terminal stop." }, { "name": "city", "kind": "required", "type": "string", "description": "The city where the terminal stop is located." }, { "name": "state", "kind": "optional", "type": "string", "description": "The state or province where the terminal stop is located." }, { "name": "country", "kind": "required", "type": "string", "description": "The country where the terminal stop is located." }, { "name": "latitude", "kind": "optional", "type": "string", "description": "The geographic latitude of the stop. Example: \"47.1667\"" }, { "name": "longitude", "kind": "optional", "type": "string", "description": "The geographic longitude of the stop. Example: \"-2.1667\"" } ] } ] }, { "name": "loadUpdate", "kind": "optional", "type": "object", "description": "LoadUpdate key is to update Load level information. ", "children": [ { "name": "locationUpdate", "kind": "optional", "type": "object", "description": "LocationUpdate key can be used for providing latest GPS coordinates updates to the FourKites load. ", "children": [ { "name": "latitude", "kind": "required", "type": "string", "description": "Enter the latitude of the truck's current location The only accepted format of lat/long by FOURKITES® is the \"Decimal Degrees\" format. For example, 41.8781 (lat) and -87.6298 (long). Ex: \"41.898274\"" }, { "name": "longitude", "kind": "required", "type": "string", "description": "Enter the longitude of the truck's current location The only accepted format of lat/long by FOURKITES® is the \"Decimal Degrees\" format. For example, 41.8781 (lat) and -87.6298 (long). Ex: \"-88.028452\"" }, { "name": "locatedAt", "kind": "required", "type": "string", "description": "Enter the timestamp at which the latitude and longitude values were recorded for location. This field is usually given along with the latitude/longitude values. If no value is given, the current time will be considered as locatedAt value. Ex: \"2017-11-23T07:55:00Z\"\n" }, { "name": "city", "kind": "optional", "type": "string", "description": "Enter the city name of the truck's current location. Ex: \"Chicago\"" }, { "name": "state", "kind": "optional", "type": "string", "description": "Enter the 2 digit state code of the truck location. Ex: \"IL\"" }, { "name": "deliveredAt", "kind": "optional", "type": "string", "description": "Enter the time at which the shipment was delivered at the final consignee, given in ISO 8601 format. This value is usually provided to indicate that a load was delivered. If no value is given, deliveredAt will default to the current time. Ex: \"2017-11-23T07:55:00Z\"" } ] }, { "name": "etaUpdate", "kind": "optional", "type": "object", "description": "EtaUpdate key can be used to send carrier ETA for the Load. This eta fields given is processed as overall Load Eta or the final delivery ETA.", "children": [ { "name": "estimatedArrivalAtDestination", "kind": "optional", "type": "string", "description": "It indicates the Load ETA datetime to destination provided by the carrier. Ex: \"2017-11-23T07:55:00Z\"" }, { "name": "estimatedArrivalAtDestinationDateOnly", "kind": "optional", "type": "string", "description": "If there is only Load Date available and no time, this field can be used to pass the date only format. Ex: \"2017-11-23\"" } ] }, { "name": "temperatureUpdate", "kind": "optional", "type": "object", "description": "Temperature Update key is to provide Temperature updates to the FourKites Load", "children": [ { "name": "temperature", "kind": "required", "type": "string", "description": "Enter the target temperature at which a product is maintained. Ex: \"20\"" }, { "name": "sensorName", "kind": "optional", "type": "string", "description": "\"Enter the sensor name\". Ex: \"SensorName1\"" }, { "name": "temperatureUnit", "kind": "optional", "type": "string", "description": "Enter the unit of the temperature in which the product is maintained. The valid values are \"C\" for Celsius and \"F\" for Fahrenheit. If no value is given, the unit defaults to Fahrenheit. Ex: \"F\"\n" }, { "name": "temperatureCheckCallTime", "kind": "optional", "type": "string", "description": "It indicates the check call time at which the temperature reading of the product was taken. Ex: \"2017-11-23T07:55:00Z\"" }, { "name": "temperatureTimestamp", "kind": "optional", "type": "string", "description": "Enter the timestamp at which the temperature reading was sent. If no value is given, the current time will be taken. \"2017-11-23T07:55:00Z\"" } ] }, { "name": "loadInfoUpdate", "kind": "optional", "type": "object", "description": "LoadInfoUpdate key is to update Load level information. These can be tags, proNumbers, or any of the below - which can be updated to the FourKites Load.", "children": [ { "name": "tags", "kind": "optional", "type": "array", "description": "It indicates the tag specified by a company for a load. Ex: \"tags\":[\"tag1\", \"tag2\", \"tag3\"]" }, { "name": "updatableProNumber", "kind": "optional", "type": "string", "description": "It indicates the updatable field where carrier can update (if not already) proNumber to the FourKites load. Note: This is not an identifying field, which will be used to search and match loads. Ex: \"proNumber\"" }, { "name": "updatableCarrierReferenceNumber", "kind": "optional", "type": "string", "description": "It is the list of carrier reference numbers assigned by managing carriers for operating carriers to match on loads." }, { "name": "brokeredLoad", "kind": "optional", "type": "boolean", "description": "It indicates if the load is a brokered load or not. Ex: true or false" }, { "name": "relayLoad", "kind": "optional", "type": "boolean", "description": "It indicates if the load is a relay load or not. Ex: true or false" }, { "name": "simultaneousTrackingReferenceNumber", "kind": "optional", "type": "string", "description": "It indicates a simultaneous tracking reference number across a group of simultaneous loads in order to group them. Ex: \"sim007654\"" }, { "name": "endPoint", "kind": "optional", "type": "string", "description": "" }, { "name": "startPoint", "kind": "optional", "type": "string", "description": "" }, { "name": "startTime", "kind": "optional", "type": "string", "description": "" }, { "name": "forceStart", "kind": "optional", "type": "string", "description": "It indicates the timestamp the sequenced load is due to start tracking. Ex: \"2021-10-25T10:00:00.000Z\"" }, { "name": "stopTracking", "kind": "optional", "type": "boolean", "description": "It indicates that the tracking of the load is stopped. Ex: True or False" }, { "name": "weight", "kind": "optional", "type": "string", "description": "It indicates the load’s weight. Ex: \"96\"" }, { "name": "weightUnit", "kind": "optional", "type": "string", "description": "It indicates the unit of mass and weight of the load. Ex: \"KG\"" }, { "name": "freightCharges", "kind": "optional", "type": "string", "description": "It indicates the freight charges" }, { "name": "freightChargeUnit", "kind": "optional", "type": "string", "description": "It indicates the unit of currency of the freight charges. Ex: \"USD\"" }, { "name": "quantity", "kind": "optional", "type": "string", "description": "It indicates the total quantity of the load. Ex: \"88\"" }, { "name": "simultaneousTrackingSequenceNumber", "kind": "optional", "type": "number", "description": "It is the unique sequence number that represents the sequence of deliveries for the simultaneous loads to predict better ETAs." } ] }, { "name": "eventUpdate", "kind": "optional", "type": "object", "description": "EventUpdate key can be used for providing event or status updates to the FourKites load.", "children": [ { "name": "modeType", "kind": "optional", "type": "array", "description": "Load mode types." }, { "name": "statusCode", "kind": "optional", "type": "string", "description": "It indicates the load event status code. Ex: \"AF\"" }, { "name": "statusDescription", "kind": "optional", "type": "string", "description": "It indicates the load event status message. Ex: \"Picked Up\"" }, { "name": "statusReasonCode", "kind": "optional", "type": "string", "description": "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. Ex: \"Severe_Weather_Conditions\"" }, { "name": "eventTimeStamp", "kind": "optional", "type": "string", "description": "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. Ex: \"2017-11-23T07:55:00Z\"" }, { "name": "ecta", "kind": "optional", "type": "object", "description": "Carrier can send ECTA (European Chemical Transport Association) event codes in this object key Note: This is applicable only for LTL mode loads", "children": [ { "name": "status", "kind": "optional", "type": "string", "description": "Ecta Status. Ex: { \"Status\": \"Booking confirmation\", \"Timestamp\": \"2021-06-03T14:30:00Z\", \"StatusDescription\": \"Booking confirmation\" }" } ] }, { "name": "city", "kind": "optional", "type": "string", "description": "Enter the city name of the load event. Ex: \"Chicago\"" }, { "name": "state", "kind": "optional", "type": "string", "description": "Enter the 2 digit state code of the load event. Ex: \"IL\"" }, { "name": "country", "kind": "optional", "type": "string", "description": "Enter the 2 digit county code. Ex: \"US\"" }, { "name": "pickupTime", "kind": "optional", "type": "string", "description": "It indicates the time when the load was picked up Note: This is applicable only for LTL mode loads. Ex: \"2017-11-23T07:55:00Z\"" }, { "name": "deliveryTime", "kind": "optional", "type": "string", "description": "It indicates the time when the load was delivered Note: This is applicable only for LTL mode loads. Ex: \"2017-11-23T07:55:00Z\"" }, { "name": "delivered", "kind": "optional", "type": "boolean", "description": "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. Ex: True or False" }, { "name": "oceanDataHash", "kind": "optional", "type": "object", "description": "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\" }" }, { "name": "vesselLocation", "kind": "optional", "type": "string", "description": "Note: This is applicable only for Ocean/Intermodal mode loads Also OceanContainer is mandatory in \"assignmentUpdate\" Key" }, { "name": "railEventCode", "kind": "optional", "type": "string", "description": "It indicates the rail event code Note: This is applicable for only Rail mode loads. Ex: \"X6\"" }, { "name": "shipmentStatusIndicator", "kind": "optional", "type": "string", "description": "It indicates the status indicator of the shipment Note: This is applicable for only Rail mode loads. Ex: \"X6\"" }, { "name": "shipmentStatus", "kind": "optional", "type": "string", "description": "It indicates the status of the shipment Note: This is applicable for only Rail mode loads. Ex: \"AR\"" }, { "name": "failedLoads", "kind": "optional", "type": "string", "description": "" }, { "name": "airDataHash", "kind": "optional", "type": "object", "description": "Enter Air event tracking update if applicable in this object key Note: This is applicable only for Air mode loads", "children": [ { "name": "quantity", "kind": "optional", "type": "string", "description": "Total quantity." } ] } ] } ] } ] } ], "formDataParameters": [] }, "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" }, "hasTryItOut": false, "autoGeneratedAnchorSlug": "production", "legacyHash": "FMbg3UgTK1ajC244e5tLH" } ``` ::: :::ApiMethodV2 ```json { "name": "Staging", "method": "POST", "url": "https://api-staging.fourkites.com/load/update/dispatcher-api/async", "description": "", "tab": "examples", "examples": { "languages": [ { "id": "2-mv4wZW9C7PZX70j1kQw", "language": "curl", "code": "curl --location 'https://api-staging.fourkites.com/load/update/dispatcher-api/async' \\\n--header 'Content-Type: application/json' \\\n--header 'apikey: testkey' \\\n--data '{\n \"updates\": [\n {\n \"timeZone\": \"UTC\",\n \"billToCode\": \"Shipper unique id\",\n \"identifierKeys\": [\n {\n \"identifier\": \"Load reference #1\",\n \"rawIdentifier\": \"Carrier format - Load reference #1\",\n \"identifierType\": \"Load reference identifier type in FourKites or Carrier company\" \n },\n {\n \"identifier\": \"Load reference #2\",\n \"rawIdentifier\": \"Carrier format - Load reference #2\",\n \"identifierType\": \"Load reference identifier type in FourKites or Carrier company\"\n },\n {\n \"identifier\": \"Load reference #3\",\n \"rawIdentifier\": \"Carrier format - Load reference #3\",\n \"identifierType\": \"Load reference identifier type in FourKites or Carrier company\"\n },\n {\n \"identifier\": \"Load reference #4\",\n \"rawIdentifier\": \"Carrier format - Load reference #4\",\n \"identifierType\": \"Load reference identifier type in FourKites or Carrier company\"\n }\n ],\n \"assignmentUpdate\": {\n \"operatingCarrierScac\": \"Operating Carrier SCAC ID\",\n \"truckNumber\": \"Truck Number as in the GPS/ELD portal\",\n \"trailerNumber\": \"Trailer Number as in the GPS/ELD portal\",\n \"deviceId\": \"Device Id as in the GPS/ELD portal\",\n \"driverPhone\": \"Driver Phone Number with the Country Code\",\n \"driverName\": \"Driver Name\",\n \"driverLicenseNumber\": \"Driver Truck License Number\",\n \"railEquipmentInitials\": \"4-character rail equipment prefix\",\n \"railEquipmentNumber\": \"6-digit rail equipment number\",\n \"wagonNumber\": \"Wagon Number\",\n \"oceanContainer\": \"Ocean Containter\",\n \"loadMode\": \"Mode of the load to be assigned\"\n },\n \"stopUpdate\": {\n \"appointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"earliestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"latestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"stopType\": \"pickup\",\n \"stopSequence\": 1,\n \"stopReferenceId\": \"stopReferenceId\",\n \"postalCode\": \"postalCode\",\n \"statusCode\": \"statusCodestop\",\n \"statusDescription\": \"statusDescriptionstop\",\n \"statusReasonCode\": \"statusReasonCodestop\",\n \"eventTimeStamp\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"earliestAppointmentDateOnly\": \"YYYY-MM-DD\",\n \"earliestAppointmentTimeOnly\": \"HH:MM:SS\",\n \"latestAppointmentDateOnly\": \"YYYY-MM-DD\",\n \"latestAppointmentTimeOnly\": \"HH:MM:SS\",\n \"modeType\": [\n \"modeType generally specified as '\\''intermodal'\\'' to update the terminalStops for load\"\n ],\n \"terminalStops\": [\n {\n \"appointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"earliestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"latestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"stopType\": \"originTerminal\",\n \"transportationMode\": \"transportationMode\",\n \"stopSequence\": 1,\n \"stopReferenceId\": \"stopReferenceId\",\n \"name\": \"stopName\",\n \"city\": \"stopCity\",\n \"state\": \"stopState\",\n \"country\": \"stopCountry\",\n \"latitude\": \"47.1667\",\n \"longitude\": \"-2.1667\"\n },\n {\n \"appointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"earliestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"latestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"stopType\": \"destinationTerminal\",\n \"transportationMode\": \"transportationMode\",\n \"stopSequence\": 2,\n \"stopReferenceId\": \"stopReferenceId\",\n \"name\": \"stopName\",\n \"city\": \"stopCity\",\n \"state\": \"stopState\",\n \"country\": \"stopCountry\",\n \"latitude\": \"47.1667\",\n \"longitude\": \"-2.1667\"\n }\n ]\n },\n \"loadUpdate\": [\n {\n \"locationUpdate\": {\n \"latitude\": \"42.42\",\n \"longitude\": \"-87.622003\",\n \"locatedAt\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"city\": \"Location City\",\n \"state\": \"Location State code\",\n \"deliveredAt\": \"YYYY-MM-DDTHH:MM:SSZ\"\n },\n \"etaUpdate\": {\n \"estimatedArrivalAtDestination\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"estimatedArrivalAtDestinationDateOnly\": \"YYYY-MM-DD\"\n },\n \"temperatureUpdate\": {\n \"temperature\": \"0.2\",\n \"sensorName\": \"sensorName\",\n \"temperatureUnit\": \"C\",\n \"temperatureCheckCallTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"temperatureTimestamp\": \"YYYY-MM-DDTHH:MM:SSZ\"\n },\n \"loadInfoUpdate\": {\n \"tags\": [\n \"tags\"\n ],\n \"updatableProNumber\": \"updatableProNumber\",\n \"updatableCarrierReferenceNumber\": \"updatableCarrierReferenceNumber\",\n \"brokeredLoad\": false,\n \"relayLoad\": true,\n \"simultaneousTrackingReferenceNumber\": \"simultaneousTrackingReferenceNumberloadinfo\",\n \"endPoint\": \"endPoint\",\n \"startPoint\": \"startPoint\",\n \"startTime\": \"startTime\",\n \"forceStart\": true,\n \"stopTracking\": \"stopTracking\",\n \"weight\": \"weight\",\n \"weightUnit\": \"weightUnit\",\n \"freightCharges\": \"freightCharges\",\n \"freightChargeUnit\": \"freightChargeUnit\",\n \"quantity\": \"quantity\",\n \"simultaneousTrackingSequenceNumber\": 1\n },\n \"eventUpdate\": {\n \"modeType\": [\n \"ftl\"\n ],\n \"statusCode\": \"statusCodeevent\",\n \"statusDescription\": \"statusDescriptionevent\",\n \"statusReasonCode\": \"statusReasonCodeevent\",\n \"eventTimeStamp\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"ecta\": {\n \"ecta\": \"ecta\"\n },\n \"city\": \"Event City Code\",\n \"state\": \"Event state code\",\n \"country\": \"Event Country code\",\n \"pickupTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"deliveryTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"delivered\": false,\n \"deliveredAt\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"oceanDataHash\": {\n \"city\": \"City\",\n \"state\": \"State code\",\n \"country\": \"Country Code\",\n \"event_timezone\": \"UTC\",\n \"event_source\": \"dispatcher_async\",\n \"event_date_time\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"ocean_container_number\": \"ocean_container_number\",\n \"update_action\": \"update_action\"\n },\n \"vesselLocation\": \"vesselLocation\",\n \"railEventCode\": \"railEventCode\",\n \"shipmentStatusIndicator\": \"shipmentStatusIndicator\",\n \"shipmentStatus\": \"shipmentStatus\",\n \"failedLoads\": \"failedLoads\",\n \"airDataHash\": {\n \"quantity\": \"1\"\n }\n },\n \"additionalData\": {\n \"simultaneousTrackingReferenceNumber\": \"simultaneousTrackingReferenceNumberadditional\"\n }\n }\n ]\n }\n ]\n}'" }, { "id": "chcZtISPenV8BlOo7LzxX", "language": "csharp", "code": "var client = new HttpClient();\nvar request = new HttpRequestMessage(HttpMethod.Post, \"https://api-staging.fourkites.com/load/update/dispatcher-api/async\");\nrequest.Headers.Add(\"apikey\", \"testkey\");\nvar content = new StringContent(\"{\\n \\\"updates\\\": [\\n {\\n \\\"timeZone\\\": \\\"UTC\\\",\\n \\\"billToCode\\\": \\\"Shipper unique id\\\",\\n \\\"identifierKeys\\\": [\\n {\\n \\\"identifier\\\": \\\"Load reference #1\\\",\\n \\\"rawIdentifier\\\": \\\"Carrier format - Load reference #1\\\",\\n \\\"identifierType\\\": \\\"Load reference identifier type in FourKites or Carrier company\\\" \\n },\\n {\\n \\\"identifier\\\": \\\"Load reference #2\\\",\\n \\\"rawIdentifier\\\": \\\"Carrier format - Load reference #2\\\",\\n \\\"identifierType\\\": \\\"Load reference identifier type in FourKites or Carrier company\\\"\\n },\\n {\\n \\\"identifier\\\": \\\"Load reference #3\\\",\\n \\\"rawIdentifier\\\": \\\"Carrier format - Load reference #3\\\",\\n \\\"identifierType\\\": \\\"Load reference identifier type in FourKites or Carrier company\\\"\\n },\\n {\\n \\\"identifier\\\": \\\"Load reference #4\\\",\\n \\\"rawIdentifier\\\": \\\"Carrier format - Load reference #4\\\",\\n \\\"identifierType\\\": \\\"Load reference identifier type in FourKites or Carrier company\\\"\\n }\\n ],\\n \\\"assignmentUpdate\\\": {\\n \\\"operatingCarrierScac\\\": \\\"Operating Carrier SCAC ID\\\",\\n \\\"truckNumber\\\": \\\"Truck Number as in the GPS/ELD portal\\\",\\n \\\"trailerNumber\\\": \\\"Trailer Number as in the GPS/ELD portal\\\",\\n \\\"deviceId\\\": \\\"Device Id as in the GPS/ELD portal\\\",\\n \\\"driverPhone\\\": \\\"Driver Phone Number with the Country Code\\\",\\n \\\"driverName\\\": \\\"Driver Name\\\",\\n \\\"driverLicenseNumber\\\": \\\"Driver Truck License Number\\\",\\n \\\"railEquipmentInitials\\\": \\\"4-character rail equipment prefix\\\",\\n \\\"railEquipmentNumber\\\": \\\"6-digit rail equipment number\\\",\\n \\\"wagonNumber\\\": \\\"Wagon Number\\\",\\n \\\"oceanContainer\\\": \\\"Ocean Containter\\\",\\n \\\"loadMode\\\": \\\"Mode of the load to be assigned\\\"\\n },\\n \\\"stopUpdate\\\": {\\n \\\"appointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"earliestAppointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"latestAppointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"stopType\\\": \\\"pickup\\\",\\n \\\"stopSequence\\\": 1,\\n \\\"stopReferenceId\\\": \\\"stopReferenceId\\\",\\n \\\"postalCode\\\": \\\"postalCode\\\",\\n \\\"statusCode\\\": \\\"statusCodestop\\\",\\n \\\"statusDescription\\\": \\\"statusDescriptionstop\\\",\\n \\\"statusReasonCode\\\": \\\"statusReasonCodestop\\\",\\n \\\"eventTimeStamp\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"earliestAppointmentDateOnly\\\": \\\"YYYY-MM-DD\\\",\\n \\\"earliestAppointmentTimeOnly\\\": \\\"HH:MM:SS\\\",\\n \\\"latestAppointmentDateOnly\\\": \\\"YYYY-MM-DD\\\",\\n \\\"latestAppointmentTimeOnly\\\": \\\"HH:MM:SS\\\",\\n \\\"modeType\\\": [\\n \\\"modeType generally specified as 'intermodal' to update the terminalStops for load\\\"\\n ],\\n \\\"terminalStops\\\": [\\n {\\n \\\"appointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"earliestAppointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"latestAppointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"stopType\\\": \\\"originTerminal\\\",\\n \\\"transportationMode\\\": \\\"transportationMode\\\",\\n \\\"stopSequence\\\": 1,\\n \\\"stopReferenceId\\\": \\\"stopReferenceId\\\",\\n \\\"name\\\": \\\"stopName\\\",\\n \\\"city\\\": \\\"stopCity\\\",\\n \\\"state\\\": \\\"stopState\\\",\\n \\\"country\\\": \\\"stopCountry\\\",\\n \\\"latitude\\\": \\\"47.1667\\\",\\n \\\"longitude\\\": \\\"-2.1667\\\"\\n },\\n {\\n \\\"appointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"earliestAppointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"latestAppointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"stopType\\\": \\\"destinationTerminal\\\",\\n \\\"transportationMode\\\": \\\"transportationMode\\\",\\n \\\"stopSequence\\\": 2,\\n \\\"stopReferenceId\\\": \\\"stopReferenceId\\\",\\n \\\"name\\\": \\\"stopName\\\",\\n \\\"city\\\": \\\"stopCity\\\",\\n \\\"state\\\": \\\"stopState\\\",\\n \\\"country\\\": \\\"stopCountry\\\",\\n \\\"latitude\\\": \\\"47.1667\\\",\\n \\\"longitude\\\": \\\"-2.1667\\\"\\n }\\n ]\\n },\\n \\\"loadUpdate\\\": [\\n {\\n \\\"locationUpdate\\\": {\\n \\\"latitude\\\": \\\"42.42\\\",\\n \\\"longitude\\\": \\\"-87.622003\\\",\\n \\\"locatedAt\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"city\\\": \\\"Location City\\\",\\n \\\"state\\\": \\\"Location State code\\\",\\n \\\"deliveredAt\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\"\\n },\\n \\\"etaUpdate\\\": {\\n \\\"estimatedArrivalAtDestination\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"estimatedArrivalAtDestinationDateOnly\\\": \\\"YYYY-MM-DD\\\"\\n },\\n \\\"temperatureUpdate\\\": {\\n \\\"temperature\\\": \\\"0.2\\\",\\n \\\"sensorName\\\": \\\"sensorName\\\",\\n \\\"temperatureUnit\\\": \\\"C\\\",\\n \\\"temperatureCheckCallTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"temperatureTimestamp\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\"\\n },\\n \\\"loadInfoUpdate\\\": {\\n \\\"tags\\\": [\\n \\\"tags\\\"\\n ],\\n \\\"updatableProNumber\\\": \\\"updatableProNumber\\\",\\n \\\"updatableCarrierReferenceNumber\\\": \\\"updatableCarrierReferenceNumber\\\",\\n \\\"brokeredLoad\\\": false,\\n \\\"relayLoad\\\": true,\\n \\\"simultaneousTrackingReferenceNumber\\\": \\\"simultaneousTrackingReferenceNumberloadinfo\\\",\\n \\\"endPoint\\\": \\\"endPoint\\\",\\n \\\"startPoint\\\": \\\"startPoint\\\",\\n \\\"startTime\\\": \\\"startTime\\\",\\n \\\"forceStart\\\": true,\\n \\\"stopTracking\\\": \\\"stopTracking\\\",\\n \\\"weight\\\": \\\"weight\\\",\\n \\\"weightUnit\\\": \\\"weightUnit\\\",\\n \\\"freightCharges\\\": \\\"freightCharges\\\",\\n \\\"freightChargeUnit\\\": \\\"freightChargeUnit\\\",\\n \\\"quantity\\\": \\\"quantity\\\",\\n \\\"simultaneousTrackingSequenceNumber\\\": 1\\n },\\n \\\"eventUpdate\\\": {\\n \\\"modeType\\\": [\\n \\\"ftl\\\"\\n ],\\n \\\"statusCode\\\": \\\"statusCodeevent\\\",\\n \\\"statusDescription\\\": \\\"statusDescriptionevent\\\",\\n \\\"statusReasonCode\\\": \\\"statusReasonCodeevent\\\",\\n \\\"eventTimeStamp\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"ecta\\\": {\\n \\\"ecta\\\": \\\"ecta\\\"\\n },\\n \\\"city\\\": \\\"Event City Code\\\",\\n \\\"state\\\": \\\"Event state code\\\",\\n \\\"country\\\": \\\"Event Country code\\\",\\n \\\"pickupTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"deliveryTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"delivered\\\": false,\\n \\\"deliveredAt\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"oceanDataHash\\\": {\\n \\\"city\\\": \\\"City\\\",\\n \\\"state\\\": \\\"State code\\\",\\n \\\"country\\\": \\\"Country Code\\\",\\n \\\"event_timezone\\\": \\\"UTC\\\",\\n \\\"event_source\\\": \\\"dispatcher_async\\\",\\n \\\"event_date_time\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"ocean_container_number\\\": \\\"ocean_container_number\\\",\\n \\\"update_action\\\": \\\"update_action\\\"\\n },\\n \\\"vesselLocation\\\": \\\"vesselLocation\\\",\\n \\\"railEventCode\\\": \\\"railEventCode\\\",\\n \\\"shipmentStatusIndicator\\\": \\\"shipmentStatusIndicator\\\",\\n \\\"shipmentStatus\\\": \\\"shipmentStatus\\\",\\n \\\"failedLoads\\\": \\\"failedLoads\\\",\\n \\\"airDataHash\\\": {\\n \\\"quantity\\\": \\\"1\\\"\\n }\\n },\\n \\\"additionalData\\\": {\\n \\\"simultaneousTrackingReferenceNumber\\\": \\\"simultaneousTrackingReferenceNumberadditional\\\"\\n }\\n }\\n ]\\n }\\n ]\\n}\", null, \"application/json\");\nrequest.Content = content;\nvar response = await client.SendAsync(request);\nresponse.EnsureSuccessStatusCode();\nConsole.WriteLine(await response.Content.ReadAsStringAsync());\n" }, { "id": "_UHvDpZc5X3BQbyCZ-KV5", "language": "go", "code": "package main\n\nimport (\n \"fmt\"\n \"strings\"\n \"net/http\"\n \"io/ioutil\"\n)\n\nfunc main() {\n\n url := \"https://api-staging.fourkites.com/load/update/dispatcher-api/async\"\n method := \"POST\"\n\n payload := strings.NewReader(`{\n \"updates\": [\n {\n \"timeZone\": \"UTC\",\n \"billToCode\": \"Shipper unique id\",\n \"identifierKeys\": [\n {\n \"identifier\": \"Load reference #1\",\n \"rawIdentifier\": \"Carrier format - Load reference #1\",\n \"identifierType\": \"Load reference identifier type in FourKites or Carrier company\" \n },\n {\n \"identifier\": \"Load reference #2\",\n \"rawIdentifier\": \"Carrier format - Load reference #2\",\n \"identifierType\": \"Load reference identifier type in FourKites or Carrier company\"\n },\n {\n \"identifier\": \"Load reference #3\",\n \"rawIdentifier\": \"Carrier format - Load reference #3\",\n \"identifierType\": \"Load reference identifier type in FourKites or Carrier company\"\n },\n {\n \"identifier\": \"Load reference #4\",\n \"rawIdentifier\": \"Carrier format - Load reference #4\",\n \"identifierType\": \"Load reference identifier type in FourKites or Carrier company\"\n }\n ],\n \"assignmentUpdate\": {\n \"operatingCarrierScac\": \"Operating Carrier SCAC ID\",\n \"truckNumber\": \"Truck Number as in the GPS/ELD portal\",\n \"trailerNumber\": \"Trailer Number as in the GPS/ELD portal\",\n \"deviceId\": \"Device Id as in the GPS/ELD portal\",\n \"driverPhone\": \"Driver Phone Number with the Country Code\",\n \"driverName\": \"Driver Name\",\n \"driverLicenseNumber\": \"Driver Truck License Number\",\n \"railEquipmentInitials\": \"4-character rail equipment prefix\",\n \"railEquipmentNumber\": \"6-digit rail equipment number\",\n \"wagonNumber\": \"Wagon Number\",\n \"oceanContainer\": \"Ocean Containter\",\n \"loadMode\": \"Mode of the load to be assigned\"\n },\n \"stopUpdate\": {\n \"appointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"earliestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"latestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"stopType\": \"pickup\",\n \"stopSequence\": 1,\n \"stopReferenceId\": \"stopReferenceId\",\n \"postalCode\": \"postalCode\",\n \"statusCode\": \"statusCodestop\",\n \"statusDescription\": \"statusDescriptionstop\",\n \"statusReasonCode\": \"statusReasonCodestop\",\n \"eventTimeStamp\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"earliestAppointmentDateOnly\": \"YYYY-MM-DD\",\n \"earliestAppointmentTimeOnly\": \"HH:MM:SS\",\n \"latestAppointmentDateOnly\": \"YYYY-MM-DD\",\n \"latestAppointmentTimeOnly\": \"HH:MM:SS\",\n \"modeType\": [\n \"modeType generally specified as 'intermodal' to update the terminalStops for load\"\n ],\n \"terminalStops\": [\n {\n \"appointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"earliestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"latestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"stopType\": \"originTerminal\",\n \"transportationMode\": \"transportationMode\",\n \"stopSequence\": 1,\n \"stopReferenceId\": \"stopReferenceId\",\n \"name\": \"stopName\",\n \"city\": \"stopCity\",\n \"state\": \"stopState\",\n \"country\": \"stopCountry\",\n \"latitude\": \"47.1667\",\n \"longitude\": \"-2.1667\"\n },\n {\n \"appointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"earliestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"latestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"stopType\": \"destinationTerminal\",\n \"transportationMode\": \"transportationMode\",\n \"stopSequence\": 2,\n \"stopReferenceId\": \"stopReferenceId\",\n \"name\": \"stopName\",\n \"city\": \"stopCity\",\n \"state\": \"stopState\",\n \"country\": \"stopCountry\",\n \"latitude\": \"47.1667\",\n \"longitude\": \"-2.1667\"\n }\n ]\n },\n \"loadUpdate\": [\n {\n \"locationUpdate\": {\n \"latitude\": \"42.42\",\n \"longitude\": \"-87.622003\",\n \"locatedAt\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"city\": \"Location City\",\n \"state\": \"Location State code\",\n \"deliveredAt\": \"YYYY-MM-DDTHH:MM:SSZ\"\n },\n \"etaUpdate\": {\n \"estimatedArrivalAtDestination\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"estimatedArrivalAtDestinationDateOnly\": \"YYYY-MM-DD\"\n },\n \"temperatureUpdate\": {\n \"temperature\": \"0.2\",\n \"sensorName\": \"sensorName\",\n \"temperatureUnit\": \"C\",\n \"temperatureCheckCallTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"temperatureTimestamp\": \"YYYY-MM-DDTHH:MM:SSZ\"\n },\n \"loadInfoUpdate\": {\n \"tags\": [\n \"tags\"\n ],\n \"updatableProNumber\": \"updatableProNumber\",\n \"updatableCarrierReferenceNumber\": \"updatableCarrierReferenceNumber\",\n \"brokeredLoad\": false,\n \"relayLoad\": true,\n \"simultaneousTrackingReferenceNumber\": \"simultaneousTrackingReferenceNumberloadinfo\",\n \"endPoint\": \"endPoint\",\n \"startPoint\": \"startPoint\",\n \"startTime\": \"startTime\",\n \"forceStart\": true,\n \"stopTracking\": \"stopTracking\",\n \"weight\": \"weight\",\n \"weightUnit\": \"weightUnit\",\n \"freightCharges\": \"freightCharges\",\n \"freightChargeUnit\": \"freightChargeUnit\",\n \"quantity\": \"quantity\",\n \"simultaneousTrackingSequenceNumber\": 1\n },\n \"eventUpdate\": {\n \"modeType\": [\n \"ftl\"\n ],\n \"statusCode\": \"statusCodeevent\",\n \"statusDescription\": \"statusDescriptionevent\",\n \"statusReasonCode\": \"statusReasonCodeevent\",\n \"eventTimeStamp\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"ecta\": {\n \"ecta\": \"ecta\"\n },\n \"city\": \"Event City Code\",\n \"state\": \"Event state code\",\n \"country\": \"Event Country code\",\n \"pickupTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"deliveryTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"delivered\": false,\n \"deliveredAt\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"oceanDataHash\": {\n \"city\": \"City\",\n \"state\": \"State code\",\n \"country\": \"Country Code\",\n \"event_timezone\": \"UTC\",\n \"event_source\": \"dispatcher_async\",\n \"event_date_time\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"ocean_container_number\": \"ocean_container_number\",\n \"update_action\": \"update_action\"\n },\n \"vesselLocation\": \"vesselLocation\",\n \"railEventCode\": \"railEventCode\",\n \"shipmentStatusIndicator\": \"shipmentStatusIndicator\",\n \"shipmentStatus\": \"shipmentStatus\",\n \"failedLoads\": \"failedLoads\",\n \"airDataHash\": {\n \"quantity\": \"1\"\n }\n },\n \"additionalData\": {\n \"simultaneousTrackingReferenceNumber\": \"simultaneousTrackingReferenceNumberadditional\"\n }\n }\n ]\n }\n ]\n}`)\n\n client := &http.Client {\n }\n req, err := http.NewRequest(method, url, payload)\n\n if err != nil {\n fmt.Println(err)\n return\n }\n req.Header.Add(\"Content-Type\", \"application/json\")\n req.Header.Add(\"apikey\", \"testkey\")\n\n res, err := client.Do(req)\n if err != nil {\n fmt.Println(err)\n return\n }\n defer res.Body.Close()\n\n body, err := ioutil.ReadAll(res.Body)\n if err != nil {\n fmt.Println(err)\n return\n }\n fmt.Println(string(body))\n}" }, { "id": "QFQ-FGCbnsv7Q8X_bN53O", "language": "java", "code": "OkHttpClient client = new OkHttpClient().newBuilder()\n .build();\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\n \\\"updates\\\": [\\n {\\n \\\"timeZone\\\": \\\"UTC\\\",\\n \\\"billToCode\\\": \\\"Shipper unique id\\\",\\n \\\"identifierKeys\\\": [\\n {\\n \\\"identifier\\\": \\\"Load reference #1\\\",\\n \\\"rawIdentifier\\\": \\\"Carrier format - Load reference #1\\\",\\n \\\"identifierType\\\": \\\"Load reference identifier type in FourKites or Carrier company\\\" \\n },\\n {\\n \\\"identifier\\\": \\\"Load reference #2\\\",\\n \\\"rawIdentifier\\\": \\\"Carrier format - Load reference #2\\\",\\n \\\"identifierType\\\": \\\"Load reference identifier type in FourKites or Carrier company\\\"\\n },\\n {\\n \\\"identifier\\\": \\\"Load reference #3\\\",\\n \\\"rawIdentifier\\\": \\\"Carrier format - Load reference #3\\\",\\n \\\"identifierType\\\": \\\"Load reference identifier type in FourKites or Carrier company\\\"\\n },\\n {\\n \\\"identifier\\\": \\\"Load reference #4\\\",\\n \\\"rawIdentifier\\\": \\\"Carrier format - Load reference #4\\\",\\n \\\"identifierType\\\": \\\"Load reference identifier type in FourKites or Carrier company\\\"\\n }\\n ],\\n \\\"assignmentUpdate\\\": {\\n \\\"operatingCarrierScac\\\": \\\"Operating Carrier SCAC ID\\\",\\n \\\"truckNumber\\\": \\\"Truck Number as in the GPS/ELD portal\\\",\\n \\\"trailerNumber\\\": \\\"Trailer Number as in the GPS/ELD portal\\\",\\n \\\"deviceId\\\": \\\"Device Id as in the GPS/ELD portal\\\",\\n \\\"driverPhone\\\": \\\"Driver Phone Number with the Country Code\\\",\\n \\\"driverName\\\": \\\"Driver Name\\\",\\n \\\"driverLicenseNumber\\\": \\\"Driver Truck License Number\\\",\\n \\\"railEquipmentInitials\\\": \\\"4-character rail equipment prefix\\\",\\n \\\"railEquipmentNumber\\\": \\\"6-digit rail equipment number\\\",\\n \\\"wagonNumber\\\": \\\"Wagon Number\\\",\\n \\\"oceanContainer\\\": \\\"Ocean Containter\\\",\\n \\\"loadMode\\\": \\\"Mode of the load to be assigned\\\"\\n },\\n \\\"stopUpdate\\\": {\\n \\\"appointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"earliestAppointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"latestAppointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"stopType\\\": \\\"pickup\\\",\\n \\\"stopSequence\\\": 1,\\n \\\"stopReferenceId\\\": \\\"stopReferenceId\\\",\\n \\\"postalCode\\\": \\\"postalCode\\\",\\n \\\"statusCode\\\": \\\"statusCodestop\\\",\\n \\\"statusDescription\\\": \\\"statusDescriptionstop\\\",\\n \\\"statusReasonCode\\\": \\\"statusReasonCodestop\\\",\\n \\\"eventTimeStamp\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"earliestAppointmentDateOnly\\\": \\\"YYYY-MM-DD\\\",\\n \\\"earliestAppointmentTimeOnly\\\": \\\"HH:MM:SS\\\",\\n \\\"latestAppointmentDateOnly\\\": \\\"YYYY-MM-DD\\\",\\n \\\"latestAppointmentTimeOnly\\\": \\\"HH:MM:SS\\\",\\n \\\"modeType\\\": [\\n \\\"modeType generally specified as 'intermodal' to update the terminalStops for load\\\"\\n ],\\n \\\"terminalStops\\\": [\\n {\\n \\\"appointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"earliestAppointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"latestAppointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"stopType\\\": \\\"originTerminal\\\",\\n \\\"transportationMode\\\": \\\"transportationMode\\\",\\n \\\"stopSequence\\\": 1,\\n \\\"stopReferenceId\\\": \\\"stopReferenceId\\\",\\n \\\"name\\\": \\\"stopName\\\",\\n \\\"city\\\": \\\"stopCity\\\",\\n \\\"state\\\": \\\"stopState\\\",\\n \\\"country\\\": \\\"stopCountry\\\",\\n \\\"latitude\\\": \\\"47.1667\\\",\\n \\\"longitude\\\": \\\"-2.1667\\\"\\n },\\n {\\n \\\"appointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"earliestAppointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"latestAppointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"stopType\\\": \\\"destinationTerminal\\\",\\n \\\"transportationMode\\\": \\\"transportationMode\\\",\\n \\\"stopSequence\\\": 2,\\n \\\"stopReferenceId\\\": \\\"stopReferenceId\\\",\\n \\\"name\\\": \\\"stopName\\\",\\n \\\"city\\\": \\\"stopCity\\\",\\n \\\"state\\\": \\\"stopState\\\",\\n \\\"country\\\": \\\"stopCountry\\\",\\n \\\"latitude\\\": \\\"47.1667\\\",\\n \\\"longitude\\\": \\\"-2.1667\\\"\\n }\\n ]\\n },\\n \\\"loadUpdate\\\": [\\n {\\n \\\"locationUpdate\\\": {\\n \\\"latitude\\\": \\\"42.42\\\",\\n \\\"longitude\\\": \\\"-87.622003\\\",\\n \\\"locatedAt\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"city\\\": \\\"Location City\\\",\\n \\\"state\\\": \\\"Location State code\\\",\\n \\\"deliveredAt\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\"\\n },\\n \\\"etaUpdate\\\": {\\n \\\"estimatedArrivalAtDestination\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"estimatedArrivalAtDestinationDateOnly\\\": \\\"YYYY-MM-DD\\\"\\n },\\n \\\"temperatureUpdate\\\": {\\n \\\"temperature\\\": \\\"0.2\\\",\\n \\\"sensorName\\\": \\\"sensorName\\\",\\n \\\"temperatureUnit\\\": \\\"C\\\",\\n \\\"temperatureCheckCallTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"temperatureTimestamp\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\"\\n },\\n \\\"loadInfoUpdate\\\": {\\n \\\"tags\\\": [\\n \\\"tags\\\"\\n ],\\n \\\"updatableProNumber\\\": \\\"updatableProNumber\\\",\\n \\\"updatableCarrierReferenceNumber\\\": \\\"updatableCarrierReferenceNumber\\\",\\n \\\"brokeredLoad\\\": false,\\n \\\"relayLoad\\\": true,\\n \\\"simultaneousTrackingReferenceNumber\\\": \\\"simultaneousTrackingReferenceNumberloadinfo\\\",\\n \\\"endPoint\\\": \\\"endPoint\\\",\\n \\\"startPoint\\\": \\\"startPoint\\\",\\n \\\"startTime\\\": \\\"startTime\\\",\\n \\\"forceStart\\\": true,\\n \\\"stopTracking\\\": \\\"stopTracking\\\",\\n \\\"weight\\\": \\\"weight\\\",\\n \\\"weightUnit\\\": \\\"weightUnit\\\",\\n \\\"freightCharges\\\": \\\"freightCharges\\\",\\n \\\"freightChargeUnit\\\": \\\"freightChargeUnit\\\",\\n \\\"quantity\\\": \\\"quantity\\\",\\n \\\"simultaneousTrackingSequenceNumber\\\": 1\\n },\\n \\\"eventUpdate\\\": {\\n \\\"modeType\\\": [\\n \\\"ftl\\\"\\n ],\\n \\\"statusCode\\\": \\\"statusCodeevent\\\",\\n \\\"statusDescription\\\": \\\"statusDescriptionevent\\\",\\n \\\"statusReasonCode\\\": \\\"statusReasonCodeevent\\\",\\n \\\"eventTimeStamp\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"ecta\\\": {\\n \\\"ecta\\\": \\\"ecta\\\"\\n },\\n \\\"city\\\": \\\"Event City Code\\\",\\n \\\"state\\\": \\\"Event state code\\\",\\n \\\"country\\\": \\\"Event Country code\\\",\\n \\\"pickupTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"deliveryTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"delivered\\\": false,\\n \\\"deliveredAt\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"oceanDataHash\\\": {\\n \\\"city\\\": \\\"City\\\",\\n \\\"state\\\": \\\"State code\\\",\\n \\\"country\\\": \\\"Country Code\\\",\\n \\\"event_timezone\\\": \\\"UTC\\\",\\n \\\"event_source\\\": \\\"dispatcher_async\\\",\\n \\\"event_date_time\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"ocean_container_number\\\": \\\"ocean_container_number\\\",\\n \\\"update_action\\\": \\\"update_action\\\"\\n },\\n \\\"vesselLocation\\\": \\\"vesselLocation\\\",\\n \\\"railEventCode\\\": \\\"railEventCode\\\",\\n \\\"shipmentStatusIndicator\\\": \\\"shipmentStatusIndicator\\\",\\n \\\"shipmentStatus\\\": \\\"shipmentStatus\\\",\\n \\\"failedLoads\\\": \\\"failedLoads\\\",\\n \\\"airDataHash\\\": {\\n \\\"quantity\\\": \\\"1\\\"\\n }\\n },\\n \\\"additionalData\\\": {\\n \\\"simultaneousTrackingReferenceNumber\\\": \\\"simultaneousTrackingReferenceNumberadditional\\\"\\n }\\n }\\n ]\\n }\\n ]\\n}\");\nRequest request = new Request.Builder()\n .url(\"https://api-staging.fourkites.com/load/update/dispatcher-api/async\")\n .method(\"POST\", body)\n .addHeader(\"Content-Type\", \"application/json\")\n .addHeader(\"apikey\", \"testkey\")\n .build();\nResponse response = client.newCall(request).execute();" }, { "id": "iFwQVVednnDxfdVbQIzkn", "language": "javascript", "code": "var settings = {\n \"url\": \"https://api-staging.fourkites.com/load/update/dispatcher-api/async\",\n \"method\": \"POST\",\n \"timeout\": 0,\n \"headers\": {\n \"Content-Type\": \"application/json\",\n \"apikey\": \"testkey\"\n },\n \"data\": JSON.stringify({\n \"updates\": [\n {\n \"timeZone\": \"UTC\",\n \"billToCode\": \"Shipper unique id\",\n \"identifierKeys\": [\n {\n \"identifier\": \"Load reference #1\",\n \"rawIdentifier\": \"Carrier format - Load reference #1\",\n \"identifierType\": \"Load reference identifier type in FourKites or Carrier company\"\n },\n {\n \"identifier\": \"Load reference #2\",\n \"rawIdentifier\": \"Carrier format - Load reference #2\",\n \"identifierType\": \"Load reference identifier type in FourKites or Carrier company\"\n },\n {\n \"identifier\": \"Load reference #3\",\n \"rawIdentifier\": \"Carrier format - Load reference #3\",\n \"identifierType\": \"Load reference identifier type in FourKites or Carrier company\"\n },\n {\n \"identifier\": \"Load reference #4\",\n \"rawIdentifier\": \"Carrier format - Load reference #4\",\n \"identifierType\": \"Load reference identifier type in FourKites or Carrier company\"\n }\n ],\n \"assignmentUpdate\": {\n \"operatingCarrierScac\": \"Operating Carrier SCAC ID\",\n \"truckNumber\": \"Truck Number as in the GPS/ELD portal\",\n \"trailerNumber\": \"Trailer Number as in the GPS/ELD portal\",\n \"deviceId\": \"Device Id as in the GPS/ELD portal\",\n \"driverPhone\": \"Driver Phone Number with the Country Code\",\n \"driverName\": \"Driver Name\",\n \"driverLicenseNumber\": \"Driver Truck License Number\",\n \"railEquipmentInitials\": \"4-character rail equipment prefix\",\n \"railEquipmentNumber\": \"6-digit rail equipment number\",\n \"wagonNumber\": \"Wagon Number\",\n \"oceanContainer\": \"Ocean Containter\",\n \"loadMode\": \"Mode of the load to be assigned\"\n },\n \"stopUpdate\": {\n \"appointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"earliestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"latestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"stopType\": \"pickup\",\n \"stopSequence\": 1,\n \"stopReferenceId\": \"stopReferenceId\",\n \"postalCode\": \"postalCode\",\n \"statusCode\": \"statusCodestop\",\n \"statusDescription\": \"statusDescriptionstop\",\n \"statusReasonCode\": \"statusReasonCodestop\",\n \"eventTimeStamp\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"earliestAppointmentDateOnly\": \"YYYY-MM-DD\",\n \"earliestAppointmentTimeOnly\": \"HH:MM:SS\",\n \"latestAppointmentDateOnly\": \"YYYY-MM-DD\",\n \"latestAppointmentTimeOnly\": \"HH:MM:SS\",\n \"modeType\": [\n \"modeType generally specified as 'intermodal' to update the terminalStops for load\"\n ],\n \"terminalStops\": [\n {\n \"appointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"earliestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"latestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"stopType\": \"originTerminal\",\n \"transportationMode\": \"transportationMode\",\n \"stopSequence\": 1,\n \"stopReferenceId\": \"stopReferenceId\",\n \"name\": \"stopName\",\n \"city\": \"stopCity\",\n \"state\": \"stopState\",\n \"country\": \"stopCountry\",\n \"latitude\": \"47.1667\",\n \"longitude\": \"-2.1667\"\n },\n {\n \"appointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"earliestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"latestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"stopType\": \"destinationTerminal\",\n \"transportationMode\": \"transportationMode\",\n \"stopSequence\": 2,\n \"stopReferenceId\": \"stopReferenceId\",\n \"name\": \"stopName\",\n \"city\": \"stopCity\",\n \"state\": \"stopState\",\n \"country\": \"stopCountry\",\n \"latitude\": \"47.1667\",\n \"longitude\": \"-2.1667\"\n }\n ]\n },\n \"loadUpdate\": [\n {\n \"locationUpdate\": {\n \"latitude\": \"42.42\",\n \"longitude\": \"-87.622003\",\n \"locatedAt\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"city\": \"Location City\",\n \"state\": \"Location State code\",\n \"deliveredAt\": \"YYYY-MM-DDTHH:MM:SSZ\"\n },\n \"etaUpdate\": {\n \"estimatedArrivalAtDestination\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"estimatedArrivalAtDestinationDateOnly\": \"YYYY-MM-DD\"\n },\n \"temperatureUpdate\": {\n \"temperature\": \"0.2\",\n \"sensorName\": \"sensorName\",\n \"temperatureUnit\": \"C\",\n \"temperatureCheckCallTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"temperatureTimestamp\": \"YYYY-MM-DDTHH:MM:SSZ\"\n },\n \"loadInfoUpdate\": {\n \"tags\": [\n \"tags\"\n ],\n \"updatableProNumber\": \"updatableProNumber\",\n \"updatableCarrierReferenceNumber\": \"updatableCarrierReferenceNumber\",\n \"brokeredLoad\": false,\n \"relayLoad\": true,\n \"simultaneousTrackingReferenceNumber\": \"simultaneousTrackingReferenceNumberloadinfo\",\n \"endPoint\": \"endPoint\",\n \"startPoint\": \"startPoint\",\n \"startTime\": \"startTime\",\n \"forceStart\": true,\n \"stopTracking\": \"stopTracking\",\n \"weight\": \"weight\",\n \"weightUnit\": \"weightUnit\",\n \"freightCharges\": \"freightCharges\",\n \"freightChargeUnit\": \"freightChargeUnit\",\n \"quantity\": \"quantity\",\n \"simultaneousTrackingSequenceNumber\": 1\n },\n \"eventUpdate\": {\n \"modeType\": [\n \"ftl\"\n ],\n \"statusCode\": \"statusCodeevent\",\n \"statusDescription\": \"statusDescriptionevent\",\n \"statusReasonCode\": \"statusReasonCodeevent\",\n \"eventTimeStamp\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"ecta\": {\n \"ecta\": \"ecta\"\n },\n \"city\": \"Event City Code\",\n \"state\": \"Event state code\",\n \"country\": \"Event Country code\",\n \"pickupTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"deliveryTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"delivered\": false,\n \"deliveredAt\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"oceanDataHash\": {\n \"city\": \"City\",\n \"state\": \"State code\",\n \"country\": \"Country Code\",\n \"event_timezone\": \"UTC\",\n \"event_source\": \"dispatcher_async\",\n \"event_date_time\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"ocean_container_number\": \"ocean_container_number\",\n \"update_action\": \"update_action\"\n },\n \"vesselLocation\": \"vesselLocation\",\n \"railEventCode\": \"railEventCode\",\n \"shipmentStatusIndicator\": \"shipmentStatusIndicator\",\n \"shipmentStatus\": \"shipmentStatus\",\n \"failedLoads\": \"failedLoads\",\n \"airDataHash\": {\n \"quantity\": \"1\"\n }\n },\n \"additionalData\": {\n \"simultaneousTrackingReferenceNumber\": \"simultaneousTrackingReferenceNumberadditional\"\n }\n }\n ]\n }\n ]\n }),\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});" }, { "id": "iybyxJDg0eLE0oqz1CAtO", "language": "swift", "code": "let parameters = \"{\\n \\\"updates\\\": [\\n {\\n \\\"timeZone\\\": \\\"UTC\\\",\\n \\\"billToCode\\\": \\\"Shipper unique id\\\",\\n \\\"identifierKeys\\\": [\\n {\\n \\\"identifier\\\": \\\"Load reference #1\\\",\\n \\\"rawIdentifier\\\": \\\"Carrier format - Load reference #1\\\",\\n \\\"identifierType\\\": \\\"Load reference identifier type in FourKites or Carrier company\\\" \\n },\\n {\\n \\\"identifier\\\": \\\"Load reference #2\\\",\\n \\\"rawIdentifier\\\": \\\"Carrier format - Load reference #2\\\",\\n \\\"identifierType\\\": \\\"Load reference identifier type in FourKites or Carrier company\\\"\\n },\\n {\\n \\\"identifier\\\": \\\"Load reference #3\\\",\\n \\\"rawIdentifier\\\": \\\"Carrier format - Load reference #3\\\",\\n \\\"identifierType\\\": \\\"Load reference identifier type in FourKites or Carrier company\\\"\\n },\\n {\\n \\\"identifier\\\": \\\"Load reference #4\\\",\\n \\\"rawIdentifier\\\": \\\"Carrier format - Load reference #4\\\",\\n \\\"identifierType\\\": \\\"Load reference identifier type in FourKites or Carrier company\\\"\\n }\\n ],\\n \\\"assignmentUpdate\\\": {\\n \\\"operatingCarrierScac\\\": \\\"Operating Carrier SCAC ID\\\",\\n \\\"truckNumber\\\": \\\"Truck Number as in the GPS/ELD portal\\\",\\n \\\"trailerNumber\\\": \\\"Trailer Number as in the GPS/ELD portal\\\",\\n \\\"deviceId\\\": \\\"Device Id as in the GPS/ELD portal\\\",\\n \\\"driverPhone\\\": \\\"Driver Phone Number with the Country Code\\\",\\n \\\"driverName\\\": \\\"Driver Name\\\",\\n \\\"driverLicenseNumber\\\": \\\"Driver Truck License Number\\\",\\n \\\"railEquipmentInitials\\\": \\\"4-character rail equipment prefix\\\",\\n \\\"railEquipmentNumber\\\": \\\"6-digit rail equipment number\\\",\\n \\\"wagonNumber\\\": \\\"Wagon Number\\\",\\n \\\"oceanContainer\\\": \\\"Ocean Containter\\\",\\n \\\"loadMode\\\": \\\"Mode of the load to be assigned\\\"\\n },\\n \\\"stopUpdate\\\": {\\n \\\"appointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"earliestAppointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"latestAppointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"stopType\\\": \\\"pickup\\\",\\n \\\"stopSequence\\\": 1,\\n \\\"stopReferenceId\\\": \\\"stopReferenceId\\\",\\n \\\"postalCode\\\": \\\"postalCode\\\",\\n \\\"statusCode\\\": \\\"statusCodestop\\\",\\n \\\"statusDescription\\\": \\\"statusDescriptionstop\\\",\\n \\\"statusReasonCode\\\": \\\"statusReasonCodestop\\\",\\n \\\"eventTimeStamp\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"earliestAppointmentDateOnly\\\": \\\"YYYY-MM-DD\\\",\\n \\\"earliestAppointmentTimeOnly\\\": \\\"HH:MM:SS\\\",\\n \\\"latestAppointmentDateOnly\\\": \\\"YYYY-MM-DD\\\",\\n \\\"latestAppointmentTimeOnly\\\": \\\"HH:MM:SS\\\",\\n \\\"modeType\\\": [\\n \\\"modeType generally specified as 'intermodal' to update the terminalStops for load\\\"\\n ],\\n \\\"terminalStops\\\": [\\n {\\n \\\"appointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"earliestAppointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"latestAppointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"stopType\\\": \\\"originTerminal\\\",\\n \\\"transportationMode\\\": \\\"transportationMode\\\",\\n \\\"stopSequence\\\": 1,\\n \\\"stopReferenceId\\\": \\\"stopReferenceId\\\",\\n \\\"name\\\": \\\"stopName\\\",\\n \\\"city\\\": \\\"stopCity\\\",\\n \\\"state\\\": \\\"stopState\\\",\\n \\\"country\\\": \\\"stopCountry\\\",\\n \\\"latitude\\\": \\\"47.1667\\\",\\n \\\"longitude\\\": \\\"-2.1667\\\"\\n },\\n {\\n \\\"appointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"earliestAppointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"latestAppointmentTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"stopType\\\": \\\"destinationTerminal\\\",\\n \\\"transportationMode\\\": \\\"transportationMode\\\",\\n \\\"stopSequence\\\": 2,\\n \\\"stopReferenceId\\\": \\\"stopReferenceId\\\",\\n \\\"name\\\": \\\"stopName\\\",\\n \\\"city\\\": \\\"stopCity\\\",\\n \\\"state\\\": \\\"stopState\\\",\\n \\\"country\\\": \\\"stopCountry\\\",\\n \\\"latitude\\\": \\\"47.1667\\\",\\n \\\"longitude\\\": \\\"-2.1667\\\"\\n }\\n ]\\n },\\n \\\"loadUpdate\\\": [\\n {\\n \\\"locationUpdate\\\": {\\n \\\"latitude\\\": \\\"42.42\\\",\\n \\\"longitude\\\": \\\"-87.622003\\\",\\n \\\"locatedAt\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"city\\\": \\\"Location City\\\",\\n \\\"state\\\": \\\"Location State code\\\",\\n \\\"deliveredAt\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\"\\n },\\n \\\"etaUpdate\\\": {\\n \\\"estimatedArrivalAtDestination\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"estimatedArrivalAtDestinationDateOnly\\\": \\\"YYYY-MM-DD\\\"\\n },\\n \\\"temperatureUpdate\\\": {\\n \\\"temperature\\\": \\\"0.2\\\",\\n \\\"sensorName\\\": \\\"sensorName\\\",\\n \\\"temperatureUnit\\\": \\\"C\\\",\\n \\\"temperatureCheckCallTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"temperatureTimestamp\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\"\\n },\\n \\\"loadInfoUpdate\\\": {\\n \\\"tags\\\": [\\n \\\"tags\\\"\\n ],\\n \\\"updatableProNumber\\\": \\\"updatableProNumber\\\",\\n \\\"updatableCarrierReferenceNumber\\\": \\\"updatableCarrierReferenceNumber\\\",\\n \\\"brokeredLoad\\\": false,\\n \\\"relayLoad\\\": true,\\n \\\"simultaneousTrackingReferenceNumber\\\": \\\"simultaneousTrackingReferenceNumberloadinfo\\\",\\n \\\"endPoint\\\": \\\"endPoint\\\",\\n \\\"startPoint\\\": \\\"startPoint\\\",\\n \\\"startTime\\\": \\\"startTime\\\",\\n \\\"forceStart\\\": true,\\n \\\"stopTracking\\\": \\\"stopTracking\\\",\\n \\\"weight\\\": \\\"weight\\\",\\n \\\"weightUnit\\\": \\\"weightUnit\\\",\\n \\\"freightCharges\\\": \\\"freightCharges\\\",\\n \\\"freightChargeUnit\\\": \\\"freightChargeUnit\\\",\\n \\\"quantity\\\": \\\"quantity\\\",\\n \\\"simultaneousTrackingSequenceNumber\\\": 1\\n },\\n \\\"eventUpdate\\\": {\\n \\\"modeType\\\": [\\n \\\"ftl\\\"\\n ],\\n \\\"statusCode\\\": \\\"statusCodeevent\\\",\\n \\\"statusDescription\\\": \\\"statusDescriptionevent\\\",\\n \\\"statusReasonCode\\\": \\\"statusReasonCodeevent\\\",\\n \\\"eventTimeStamp\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"ecta\\\": {\\n \\\"ecta\\\": \\\"ecta\\\"\\n },\\n \\\"city\\\": \\\"Event City Code\\\",\\n \\\"state\\\": \\\"Event state code\\\",\\n \\\"country\\\": \\\"Event Country code\\\",\\n \\\"pickupTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"deliveryTime\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"delivered\\\": false,\\n \\\"deliveredAt\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"oceanDataHash\\\": {\\n \\\"city\\\": \\\"City\\\",\\n \\\"state\\\": \\\"State code\\\",\\n \\\"country\\\": \\\"Country Code\\\",\\n \\\"event_timezone\\\": \\\"UTC\\\",\\n \\\"event_source\\\": \\\"dispatcher_async\\\",\\n \\\"event_date_time\\\": \\\"YYYY-MM-DDTHH:MM:SSZ\\\",\\n \\\"ocean_container_number\\\": \\\"ocean_container_number\\\",\\n \\\"update_action\\\": \\\"update_action\\\"\\n },\\n \\\"vesselLocation\\\": \\\"vesselLocation\\\",\\n \\\"railEventCode\\\": \\\"railEventCode\\\",\\n \\\"shipmentStatusIndicator\\\": \\\"shipmentStatusIndicator\\\",\\n \\\"shipmentStatus\\\": \\\"shipmentStatus\\\",\\n \\\"failedLoads\\\": \\\"failedLoads\\\",\\n \\\"airDataHash\\\": {\\n \\\"quantity\\\": \\\"1\\\"\\n }\\n },\\n \\\"additionalData\\\": {\\n \\\"simultaneousTrackingReferenceNumber\\\": \\\"simultaneousTrackingReferenceNumberadditional\\\"\\n }\\n }\\n ]\\n }\\n ]\\n}\"\nlet postData = parameters.data(using: .utf8)\n\nvar request = URLRequest(url: URL(string: \"https://api-staging.fourkites.com/load/update/dispatcher-api/async\")!,timeoutInterval: Double.infinity)\nrequest.addValue(\"application/json\", forHTTPHeaderField: \"Content-Type\")\nrequest.addValue(\"testkey\", forHTTPHeaderField: \"apikey\")\n\nrequest.httpMethod = \"POST\"\nrequest.httpBody = postData\n\nlet task = URLSession.shared.dataTask(with: request) { data, response, error in \n guard let data = data else {\n print(String(describing: error))\n return\n }\n print(String(data: data, encoding: .utf8)!)\n}\n\ntask.resume()\n" }, { "id": "XMw60pJBOeBdqV0StPytQ", "language": "ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api-staging.fourkites.com/load/update/dispatcher-api/async\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"Content-Type\"] = \"application/json\"\nrequest[\"apikey\"] = \"testkey\"\nrequest.body = JSON.dump({\n \"updates\": [\n {\n \"timeZone\": \"UTC\",\n \"billToCode\": \"Shipper unique id\",\n \"identifierKeys\": [\n {\n \"identifier\": \"Load reference #1\",\n \"rawIdentifier\": \"Carrier format - Load reference #1\",\n \"identifierType\": \"Load reference identifier type in FourKites or Carrier company\"\n },\n {\n \"identifier\": \"Load reference #2\",\n \"rawIdentifier\": \"Carrier format - Load reference #2\",\n \"identifierType\": \"Load reference identifier type in FourKites or Carrier company\"\n },\n {\n \"identifier\": \"Load reference #3\",\n \"rawIdentifier\": \"Carrier format - Load reference #3\",\n \"identifierType\": \"Load reference identifier type in FourKites or Carrier company\"\n },\n {\n \"identifier\": \"Load reference #4\",\n \"rawIdentifier\": \"Carrier format - Load reference #4\",\n \"identifierType\": \"Load reference identifier type in FourKites or Carrier company\"\n }\n ],\n \"assignmentUpdate\": {\n \"operatingCarrierScac\": \"Operating Carrier SCAC ID\",\n \"truckNumber\": \"Truck Number as in the GPS/ELD portal\",\n \"trailerNumber\": \"Trailer Number as in the GPS/ELD portal\",\n \"deviceId\": \"Device Id as in the GPS/ELD portal\",\n \"driverPhone\": \"Driver Phone Number with the Country Code\",\n \"driverName\": \"Driver Name\",\n \"driverLicenseNumber\": \"Driver Truck License Number\",\n \"railEquipmentInitials\": \"4-character rail equipment prefix\",\n \"railEquipmentNumber\": \"6-digit rail equipment number\",\n \"wagonNumber\": \"Wagon Number\",\n \"oceanContainer\": \"Ocean Containter\",\n \"loadMode\": \"Mode of the load to be assigned\"\n },\n \"stopUpdate\": {\n \"appointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"earliestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"latestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"stopType\": \"pickup\",\n \"stopSequence\": 1,\n \"stopReferenceId\": \"stopReferenceId\",\n \"postalCode\": \"postalCode\",\n \"statusCode\": \"statusCodestop\",\n \"statusDescription\": \"statusDescriptionstop\",\n \"statusReasonCode\": \"statusReasonCodestop\",\n \"eventTimeStamp\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"earliestAppointmentDateOnly\": \"YYYY-MM-DD\",\n \"earliestAppointmentTimeOnly\": \"HH:MM:SS\",\n \"latestAppointmentDateOnly\": \"YYYY-MM-DD\",\n \"latestAppointmentTimeOnly\": \"HH:MM:SS\",\n \"modeType\": [\n \"modeType generally specified as 'intermodal' to update the terminalStops for load\"\n ],\n \"terminalStops\": [\n {\n \"appointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"earliestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"latestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"stopType\": \"originTerminal\",\n \"transportationMode\": \"transportationMode\",\n \"stopSequence\": 1,\n \"stopReferenceId\": \"stopReferenceId\",\n \"name\": \"stopName\",\n \"city\": \"stopCity\",\n \"state\": \"stopState\",\n \"country\": \"stopCountry\",\n \"latitude\": \"47.1667\",\n \"longitude\": \"-2.1667\"\n },\n {\n \"appointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"earliestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"latestAppointmentTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"stopType\": \"destinationTerminal\",\n \"transportationMode\": \"transportationMode\",\n \"stopSequence\": 2,\n \"stopReferenceId\": \"stopReferenceId\",\n \"name\": \"stopName\",\n \"city\": \"stopCity\",\n \"state\": \"stopState\",\n \"country\": \"stopCountry\",\n \"latitude\": \"47.1667\",\n \"longitude\": \"-2.1667\"\n }\n ]\n },\n \"loadUpdate\": [\n {\n \"locationUpdate\": {\n \"latitude\": \"42.42\",\n \"longitude\": \"-87.622003\",\n \"locatedAt\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"city\": \"Location City\",\n \"state\": \"Location State code\",\n \"deliveredAt\": \"YYYY-MM-DDTHH:MM:SSZ\"\n },\n \"etaUpdate\": {\n \"estimatedArrivalAtDestination\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"estimatedArrivalAtDestinationDateOnly\": \"YYYY-MM-DD\"\n },\n \"temperatureUpdate\": {\n \"temperature\": \"0.2\",\n \"sensorName\": \"sensorName\",\n \"temperatureUnit\": \"C\",\n \"temperatureCheckCallTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"temperatureTimestamp\": \"YYYY-MM-DDTHH:MM:SSZ\"\n },\n \"loadInfoUpdate\": {\n \"tags\": [\n \"tags\"\n ],\n \"updatableProNumber\": \"updatableProNumber\",\n \"updatableCarrierReferenceNumber\": \"updatableCarrierReferenceNumber\",\n \"brokeredLoad\": false,\n \"relayLoad\": true,\n \"simultaneousTrackingReferenceNumber\": \"simultaneousTrackingReferenceNumberloadinfo\",\n \"endPoint\": \"endPoint\",\n \"startPoint\": \"startPoint\",\n \"startTime\": \"startTime\",\n \"forceStart\": true,\n \"stopTracking\": \"stopTracking\",\n \"weight\": \"weight\",\n \"weightUnit\": \"weightUnit\",\n \"freightCharges\": \"freightCharges\",\n \"freightChargeUnit\": \"freightChargeUnit\",\n \"quantity\": \"quantity\",\n \"simultaneousTrackingSequenceNumber\": 1\n },\n \"eventUpdate\": {\n \"modeType\": [\n \"ftl\"\n ],\n \"statusCode\": \"statusCodeevent\",\n \"statusDescription\": \"statusDescriptionevent\",\n \"statusReasonCode\": \"statusReasonCodeevent\",\n \"eventTimeStamp\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"ecta\": {\n \"ecta\": \"ecta\"\n },\n \"city\": \"Event City Code\",\n \"state\": \"Event state code\",\n \"country\": \"Event Country code\",\n \"pickupTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"deliveryTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"delivered\": false,\n \"deliveredAt\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"oceanDataHash\": {\n \"city\": \"City\",\n \"state\": \"State code\",\n \"country\": \"Country Code\",\n \"event_timezone\": \"UTC\",\n \"event_source\": \"dispatcher_async\",\n \"event_date_time\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"ocean_container_number\": \"ocean_container_number\",\n \"update_action\": \"update_action\"\n },\n \"vesselLocation\": \"vesselLocation\",\n \"railEventCode\": \"railEventCode\",\n \"shipmentStatusIndicator\": \"shipmentStatusIndicator\",\n \"shipmentStatus\": \"shipmentStatus\",\n \"failedLoads\": \"failedLoads\",\n \"airDataHash\": {\n \"quantity\": \"1\"\n }\n },\n \"additionalData\": {\n \"simultaneousTrackingReferenceNumber\": \"simultaneousTrackingReferenceNumberadditional\"\n }\n }\n ]\n }\n ]\n})\n\nresponse = https.request(request)\nputs response.read_body\n" } ], "selectedLanguageId": "2-mv4wZW9C7PZX70j1kQw" }, "results": { "languages": [ { "id": "WddmdrqmVG0OooSGjBrDt", "language": "202", "customLabel": "", "code": "{\n \"requestId\": \"294626f6-f822-42f9-9a9f-bcb6dc6ccb27\",\n \"status\": \"202\",\n \"message\": \"API Request Accepted\",\n \"timestamp\": \"2023-09-29T13:56:41.511402\"\n}" } ], "selectedLanguageId": "WddmdrqmVG0OooSGjBrDt" }, "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [], "bodyDataParameters": [ { "name": "updates", "kind": "required", "type": "object", "description": "The updates object contains all the relevant, event-specific parameters.", "children": [ { "name": "timeZone", "kind": "optional", "type": "string", "description": "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" }, { "name": "billToCode", "kind": "optional", "type": "string", "description": "The Bill-to Code is an internal identifier in the carrier's TMS system -- it is used to identify the shipper to which an individual load belongs. " }, { "name": "identifierKeys", "kind": "optional", "type": "object", "description": "Different types of identifier keys.", "children": [ { "name": "identifier", "kind": "optional", "type": "string", "description": "" }, { "name": "rawIdentifier", "kind": "optional", "type": "string", "description": "" }, { "name": "identifierType", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "assignmentUpdate", "kind": "optional", "type": "object", "description": "AssignmentUpdate keys can have one or more fields (given below) of tracking assignment to the FourKites load.", "children": [ { "name": "operatingCarrierScac", "kind": "optional", "type": "string", "description": "Enter the SCAC assigned by a Managing Carrier (3PL or broker) to an Operating Carrier. When a Carrier brokers out a load to another Operating Carrier, this field will be used to identify the load in an operating carrier's file" }, { "name": "truckNumber", "kind": "optional", "type": "string", "description": "Enter the tractor number assigned to the load. Ex: \"TrucktoTrack\"" }, { "name": "trailerNumber", "kind": "optional", "type": "string", "description": "Enter the trailer number assigned to the load. Ex: \"TrailertoTrailer\"" }, { "name": "deviceId", "kind": "optional", "type": "string", "description": "Enter the device id number assigned to the load. Ex: \"DeviceIdtoTrack\"" }, { "name": "driverPhone", "kind": "optional", "type": "string", "description": "Enter the phone number of the driver currently assigned to the load. The phone number must start with a \"+\" sign followed by the ISD code and then the mobile number. Ex: \"+19999999999\"" }, { "name": "driverName", "kind": "optional", "type": "string", "description": "It indicates the name of the driver. \"Jack\"" }, { "name": "driverLicenseNumber", "kind": "optional", "type": "string", "description": "It indicates the driver’s truck license number. \"AU 73777\"" }, { "name": "railEquipmentInitials", "kind": "optional", "type": "string", "description": "Enter the 4-character rail equipment prefix. \"AXYZ\"" }, { "name": "railEquipmentNumber", "kind": "optional", "type": "string", "description": "Enter the 6-digit rail equipment number. \"985472\"" }, { "name": "wagonNumber", "kind": "optional", "type": "string", "description": "Enter the Wagon Number if applicable" }, { "name": "oceanContainer", "kind": "optional", "type": "string", "description": "Enter the Ocean Container if applicable. Note: this field is mandatory if any ocean mode event updates. \"ABC12345678\"" } ] }, { "name": "stopUpdate", "kind": "optional", "type": "object", "description": "StopUpdates key can be used to provide any stop level (pickup, delivery or terminal) updates to the FourKites load. Any of the relevant fields below can be used to update the Load stop. Given “stopSequence” or “stopReferenceId” or “postalCode” - any one of these fields are mandatory required on the API request for “stopUpdate” to identify the stop of the load.", "children": [ { "name": "appointmentTime", "kind": "optional", "type": "string", "description": "It indicates the scheduled appointment time at the stop in the stop's local timezone in ISO 8601 format. Ex: \"2017-11-23T07:55:00Z\"" }, { "name": "earliestAppointmentTime", "kind": "optional", "type": "string", "description": "Enter the earliest scheduled arrival time for the stop in stop's local timezone, given in ISO 8601 format. To update a stop's appointment time, the stopSequence or the stopReferenceId should also be specified. If you wish to provide a single appointment time and not a time range, use the same value here as with latestAppointmentTime. Ex: \"2017-11-23T07:55:00Z\"" }, { "name": "latestAppointmentTime", "kind": "optional", "type": "string", "description": "Enter the latest scheduled arrival time for the stop in stop's local timezone, given in ISO 8601 format. To update a stop's appointment time, the stopSequence or the stopReferenceId should also be specified. If you wish to provide a single appointment time and not a time range, use the same value here as with earliestAppointmentTime. Ex: \"2017-11-23T07:55:00Z\"" }, { "name": "stopType", "kind": "required", "type": "string", "description": "It defines the function of the stop. Valid values: \"pickup\", \"delivery\", \"transfer\", \"portOfLoading\", \"transshipmentPort\", \"portOfDischarge\". There should be at least one pickup and delivery stop or one transfer (terminal) and one delivery. For ocean loads, there should be at least one portOfLoading and one portOfDischarge stop." }, { "name": "stopSequence", "kind": "required", "type": "string", "description": "Enter the stop sequence of the stop. The stopSequence is used to identify the stop for which the appointment time or status reason code is updated. Note: This stop sequence you specify should be present at the stop in the load (BOL) mentioned. For example, if you wish to update the appointment time or reason code for a stop with stop sequence 2, enter the value as 2. Ex: \"2\"" }, { "name": "stopReferenceId", "kind": "required", "type": "string", "description": "Enter the stop reference ID of the stop in the load for which the appointment time should be updated. The stopSequence is used to identify the stop for which the appointment time or status reason code is updated. Note: The stop reference ID you specify should be present at the stop in the load (BOL) mentioned. For example, if you wish to update the appointment time or reason code for a stop with stop reference id 1234, enter the value as 1234. Ex: \"1234\"\n\n\n" }, { "name": "postalCode", "kind": "required", "type": "string", "description": "It indicates the postal/zip code of the stop. Ex: \"75201\"" }, { "name": "statusCode", "kind": "optional", "type": "string", "description": "It indicates the status code for processing stop level event Note: The stopSequence or the stopReferenceId should also be specified. Ex: \"AF\"" }, { "name": "statusDescription", "kind": "optional", "type": "string", "description": "It indicates the status message for processing stop level event Note: The stopSequence or the stopReferenceId should also be specified. Ex: \"Picked Up\"" }, { "name": "statusReasonCode", "kind": "optional", "type": "string", "description": "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. Ex: \"Severe_Weather_Conditions\"" }, { "name": "eventTimeStamp", "kind": "optional", "type": "string", "description": "It indicates the date time for processing stop level event Note: The stopSequence or the stopReferenceId should also be specified. Ex: \"2017-11-23T07:55:00Z\"" }, { "name": "modeType", "kind": "optional", "type": "string", "description": "Specifies the transportation mode for the load. Typically set to \"intermodal\" to enable updating of terminal stops." }, { "name": "terminalStops", "kind": "optional", "type": "object", "description": "List of terminal stop objects associated with the load. Each object represents a stop with scheduling, location, and routing details.", "children": [ { "name": "appointmentTime", "kind": "optional", "type": "string", "description": "The scheduled appointment time at the stop. Format: YYYY-MM-DDTHH:MM:SSZ" }, { "name": "earliestAppointmentTime", "kind": "optional", "type": "string", "description": "The earliest acceptable appointment time at the stop. Format: YYYY-MM-DDTHH:MM:SSZ" }, { "name": "latestAppointmentTime", "kind": "optional", "type": "string", "description": "The latest acceptable appointment time at the stop. Format: YYYY-MM-DDTHH:MM:SSZ" }, { "name": "stopType", "kind": "required", "type": "string", "description": "Indicates the role of the stop in the journey. Example value: \"originTerminal\"" }, { "name": "transportationMode", "kind": "optional", "type": "string", "description": "The mode of transport used at or from this stop (e.g., rail, truck)." }, { "name": "stopSequence", "kind": "required", "type": "string", "description": "The order of this stop in the overall route. Starts at 1 for the first stop." }, { "name": "stopReferenceId", "kind": "optional", "type": "string", "description": "A unique identifier for the stop, used for referencing or matching against existing stop records." }, { "name": "name", "kind": "required", "type": "string", "description": "The display name of the terminal stop." }, { "name": "city", "kind": "required", "type": "string", "description": "The city where the terminal stop is located." }, { "name": "state", "kind": "optional", "type": "string", "description": "The state or province where the terminal stop is located." }, { "name": "country", "kind": "required", "type": "string", "description": "The country where the terminal stop is located." }, { "name": "latitude", "kind": "optional", "type": "string", "description": "The geographic latitude of the stop. Example: \"47.1667\"" }, { "name": "longitude", "kind": "optional", "type": "string", "description": "The geographic longitude of the stop. Example: \"-2.1667\"" } ] } ] }, { "name": "loadUpdate", "kind": "optional", "type": "object", "description": "LoadUpdate key is to update Load level information. ", "children": [ { "name": "locationUpdate", "kind": "optional", "type": "object", "description": "LocationUpdate key can be used for providing latest GPS coordinates updates to the FourKites load. ", "children": [ { "name": "latitude", "kind": "required", "type": "string", "description": "Enter the latitude of the truck's current location The only accepted format of lat/long by FOURKITES® is the \"Decimal Degrees\" format. For example, 41.8781 (lat) and -87.6298 (long). Ex: \"41.898274\"" }, { "name": "longitude", "kind": "required", "type": "string", "description": "Enter the longitude of the truck's current location The only accepted format of lat/long by FOURKITES® is the \"Decimal Degrees\" format. For example, 41.8781 (lat) and -87.6298 (long). Ex: \"-88.028452\"" }, { "name": "locatedAt", "kind": "required", "type": "string", "description": "Enter the timestamp at which the latitude and longitude values were recorded for location. This field is usually given along with the latitude/longitude values. If no value is given, the current time will be considered as locatedAt value. Ex: \"2017-11-23T07:55:00Z\"\n" }, { "name": "city", "kind": "optional", "type": "string", "description": "Enter the city name of the truck's current location. Ex: \"Chicago\"" }, { "name": "state", "kind": "optional", "type": "string", "description": "Enter the 2 digit state code of the truck location. Ex: \"IL\"" }, { "name": "deliveredAt", "kind": "optional", "type": "string", "description": "Enter the time at which the shipment was delivered at the final consignee, given in ISO 8601 format. This value is usually provided to indicate that a load was delivered. If no value is given, deliveredAt will default to the current time. Ex: \"2017-11-23T07:55:00Z\"" } ] }, { "name": "etaUpdate", "kind": "optional", "type": "object", "description": "EtaUpdate key can be used to send carrier ETA for the Load. This eta fields given is processed as overall Load Eta or the final delivery ETA.", "children": [ { "name": "estimatedArrivalAtDestination", "kind": "optional", "type": "string", "description": "It indicates the Load ETA datetime to destination provided by the carrier. Ex: \"2017-11-23T07:55:00Z\"" }, { "name": "estimatedArrivalAtDestinationDateOnly", "kind": "optional", "type": "string", "description": "If there is only Load Date available and no time, this field can be used to pass the date only format. Ex: \"2017-11-23\"" } ] }, { "name": "temperatureUpdate", "kind": "optional", "type": "object", "description": "Temperature Update key is to provide Temperature updates to the FourKites Load", "children": [ { "name": "temperature", "kind": "required", "type": "string", "description": "Enter the target temperature at which a product is maintained. Ex: \"20\"" }, { "name": "sensorName", "kind": "optional", "type": "string", "description": "\"Enter the sensor name\". Ex: \"SensorName1\"" }, { "name": "temperatureUnit", "kind": "optional", "type": "string", "description": "Enter the unit of the temperature in which the product is maintained. The valid values are \"C\" for Celsius and \"F\" for Fahrenheit. If no value is given, the unit defaults to Fahrenheit. Ex: \"F\"\n" }, { "name": "temperatureCheckCallTime", "kind": "optional", "type": "string", "description": "It indicates the check call time at which the temperature reading of the product was taken. Ex: \"2017-11-23T07:55:00Z\"" }, { "name": "temperatureTimestamp", "kind": "optional", "type": "string", "description": "Enter the timestamp at which the temperature reading was sent. If no value is given, the current time will be taken. \"2017-11-23T07:55:00Z\"" } ] }, { "name": "loadInfoUpdate", "kind": "optional", "type": "object", "description": "LoadInfoUpdate key is to update Load level information. These can be tags, proNumbers, or any of the below - which can be updated to the FourKites Load.", "children": [ { "name": "tags", "kind": "optional", "type": "array", "description": "It indicates the tag specified by a company for a load. Ex: \"tags\":[\"tag1\", \"tag2\", \"tag3\"]" }, { "name": "updatableProNumber", "kind": "optional", "type": "string", "description": "It indicates the updatable field where carrier can update (if not already) proNumber to the FourKites load. Note: This is not an identifying field, which will be used to search and match loads. Ex: \"proNumber\"" }, { "name": "updatableCarrierReferenceNumber", "kind": "optional", "type": "string", "description": "It is the list of carrier reference numbers assigned by managing carriers for operating carriers to match on loads." }, { "name": "brokeredLoad", "kind": "optional", "type": "boolean", "description": "It indicates if the load is a brokered load or not. Ex: true or false" }, { "name": "relayLoad", "kind": "optional", "type": "boolean", "description": "It indicates if the load is a relay load or not. Ex: true or false" }, { "name": "simultaneousTrackingReferenceNumber", "kind": "optional", "type": "string", "description": "It indicates a simultaneous tracking reference number across a group of simultaneous loads in order to group them. Ex: \"sim007654\"" }, { "name": "endPoint", "kind": "optional", "type": "string", "description": "" }, { "name": "startPoint", "kind": "optional", "type": "string", "description": "" }, { "name": "startTime", "kind": "optional", "type": "string", "description": "" }, { "name": "forceStart", "kind": "optional", "type": "string", "description": "It indicates the timestamp the sequenced load is due to start tracking. Ex: \"2021-10-25T10:00:00.000Z\"" }, { "name": "stopTracking", "kind": "optional", "type": "boolean", "description": "It indicates that the tracking of the load is stopped. Ex: True or False" }, { "name": "weight", "kind": "optional", "type": "string", "description": "It indicates the load’s weight. Ex: \"96\"" }, { "name": "weightUnit", "kind": "optional", "type": "string", "description": "It indicates the unit of mass and weight of the load. Ex: \"KG\"" }, { "name": "freightCharges", "kind": "optional", "type": "string", "description": "It indicates the freight charges" }, { "name": "freightChargeUnit", "kind": "optional", "type": "string", "description": "It indicates the unit of currency of the freight charges. Ex: \"USD\"" }, { "name": "quantity", "kind": "optional", "type": "string", "description": "It indicates the total quantity of the load. Ex: \"88\"" }, { "name": "simultaneousTrackingSequenceNumber", "kind": "optional", "type": "number", "description": "It is the unique sequence number that represents the sequence of deliveries for the simultaneous loads to predict better ETAs." } ] }, { "name": "eventUpdate", "kind": "optional", "type": "object", "description": "EventUpdate key can be used for providing event or status updates to the FourKites load.", "children": [ { "name": "modeType", "kind": "optional", "type": "array", "description": "Load mode types." }, { "name": "statusCode", "kind": "optional", "type": "string", "description": "It indicates the load event status code. Ex: \"AF\"" }, { "name": "statusDescription", "kind": "optional", "type": "string", "description": "It indicates the load event status message. Ex: \"Picked Up\"" }, { "name": "statusReasonCode", "kind": "optional", "type": "string", "description": "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. Ex: \"Severe_Weather_Conditions\"" }, { "name": "eventTimeStamp", "kind": "optional", "type": "string", "description": "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. Ex: \"2017-11-23T07:55:00Z\"" }, { "name": "ecta", "kind": "optional", "type": "object", "description": "Carrier can send ECTA (European Chemical Transport Association) event codes in this object key Note: This is applicable only for LTL mode loads", "children": [ { "name": "status", "kind": "optional", "type": "string", "description": "Ecta Status. Ex: { \"Status\": \"Booking confirmation\", \"Timestamp\": \"2021-06-03T14:30:00Z\", \"StatusDescription\": \"Booking confirmation\" }" } ] }, { "name": "city", "kind": "optional", "type": "string", "description": "Enter the city name of the load event. Ex: \"Chicago\"" }, { "name": "state", "kind": "optional", "type": "string", "description": "Enter the 2 digit state code of the load event. Ex: \"IL\"" }, { "name": "country", "kind": "optional", "type": "string", "description": "Enter the 2 digit county code. Ex: \"US\"" }, { "name": "pickupTime", "kind": "optional", "type": "string", "description": "It indicates the time when the load was picked up Note: This is applicable only for LTL mode loads. Ex: \"2017-11-23T07:55:00Z\"" }, { "name": "deliveryTime", "kind": "optional", "type": "string", "description": "It indicates the time when the load was delivered Note: This is applicable only for LTL mode loads. Ex: \"2017-11-23T07:55:00Z\"" }, { "name": "delivered", "kind": "optional", "type": "boolean", "description": "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. Ex: True or False" }, { "name": "oceanDataHash", "kind": "optional", "type": "object", "description": "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\" }" }, { "name": "vesselLocation", "kind": "optional", "type": "string", "description": "Note: This is applicable only for Ocean/Intermodal mode loads Also OceanContainer is mandatory in \"assignmentUpdate\" Key" }, { "name": "railEventCode", "kind": "optional", "type": "string", "description": "It indicates the rail event code Note: This is applicable for only Rail mode loads. Ex: \"X6\"" }, { "name": "shipmentStatusIndicator", "kind": "optional", "type": "string", "description": "It indicates the status indicator of the shipment Note: This is applicable for only Rail mode loads. Ex: \"X6\"" }, { "name": "shipmentStatus", "kind": "optional", "type": "string", "description": "It indicates the status of the shipment Note: This is applicable for only Rail mode loads. Ex: \"AR\"" }, { "name": "failedLoads", "kind": "optional", "type": "string", "description": "" }, { "name": "airDataHash", "kind": "optional", "type": "object", "description": "Enter Air event tracking update if applicable in this object key Note: This is applicable only for Air mode loads", "children": [ { "name": "quantity", "kind": "optional", "type": "string", "description": "Total quantity." } ] } ] } ] } ], "schema": [ { "name": "timeZone", "kind": "optional", "type": "string", "description": "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" }, { "name": "billToCode", "kind": "optional", "type": "string", "description": "The Bill-to Code is an internal identifier in the carrier's TMS system -- it is used to identify the shipper to which an individual load belongs. " }, { "name": "identifierKeys", "kind": "optional", "type": "object", "description": "Different types of identifier keys.", "children": [ { "name": "identifier", "kind": "optional", "type": "string", "description": "" }, { "name": "rawIdentifier", "kind": "optional", "type": "string", "description": "" }, { "name": "identifierType", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "assignmentUpdate", "kind": "optional", "type": "object", "description": "AssignmentUpdate keys can have one or more fields (given below) of tracking assignment to the FourKites load.", "children": [ { "name": "operatingCarrierScac", "kind": "optional", "type": "string", "description": "Enter the SCAC assigned by a Managing Carrier (3PL or broker) to an Operating Carrier. When a Carrier brokers out a load to another Operating Carrier, this field will be used to identify the load in an operating carrier's file" }, { "name": "truckNumber", "kind": "optional", "type": "string", "description": "Enter the tractor number assigned to the load. Ex: \"TrucktoTrack\"" }, { "name": "trailerNumber", "kind": "optional", "type": "string", "description": "Enter the trailer number assigned to the load. Ex: \"TrailertoTrailer\"" }, { "name": "deviceId", "kind": "optional", "type": "string", "description": "Enter the device id number assigned to the load. Ex: \"DeviceIdtoTrack\"" }, { "name": "driverPhone", "kind": "optional", "type": "string", "description": "Enter the phone number of the driver currently assigned to the load. The phone number must start with a \"+\" sign followed by the ISD code and then the mobile number. Ex: \"+19999999999\"" }, { "name": "driverName", "kind": "optional", "type": "string", "description": "It indicates the name of the driver. \"Jack\"" }, { "name": "driverLicenseNumber", "kind": "optional", "type": "string", "description": "It indicates the driver’s truck license number. \"AU 73777\"" }, { "name": "railEquipmentInitials", "kind": "optional", "type": "string", "description": "Enter the 4-character rail equipment prefix. \"AXYZ\"" }, { "name": "railEquipmentNumber", "kind": "optional", "type": "string", "description": "Enter the 6-digit rail equipment number. \"985472\"" }, { "name": "wagonNumber", "kind": "optional", "type": "string", "description": "Enter the Wagon Number if applicable" }, { "name": "oceanContainer", "kind": "optional", "type": "string", "description": "Enter the Ocean Container if applicable. Note: this field is mandatory if any ocean mode event updates. \"ABC12345678\"" } ] }, { "name": "stopUpdate", "kind": "optional", "type": "object", "description": "StopUpdates key can be used to provide any stop level (pickup, delivery or terminal) updates to the FourKites load. Any of the relevant fields below can be used to update the Load stop. Given “stopSequence” or “stopReferenceId” or “postalCode” - any one of these fields are mandatory required on the API request for “stopUpdate” to identify the stop of the load.", "children": [ { "name": "appointmentTime", "kind": "optional", "type": "string", "description": "It indicates the scheduled appointment time at the stop in the stop's local timezone in ISO 8601 format. Ex: \"2017-11-23T07:55:00Z\"" }, { "name": "earliestAppointmentTime", "kind": "optional", "type": "string", "description": "Enter the earliest scheduled arrival time for the stop in stop's local timezone, given in ISO 8601 format. To update a stop's appointment time, the stopSequence or the stopReferenceId should also be specified. If you wish to provide a single appointment time and not a time range, use the same value here as with latestAppointmentTime. Ex: \"2017-11-23T07:55:00Z\"" }, { "name": "latestAppointmentTime", "kind": "optional", "type": "string", "description": "Enter the latest scheduled arrival time for the stop in stop's local timezone, given in ISO 8601 format. To update a stop's appointment time, the stopSequence or the stopReferenceId should also be specified. If you wish to provide a single appointment time and not a time range, use the same value here as with earliestAppointmentTime. Ex: \"2017-11-23T07:55:00Z\"" }, { "name": "stopType", "kind": "required", "type": "string", "description": "It defines the function of the stop. Valid values: \"pickup\", \"delivery\", \"transfer\", \"portOfLoading\", \"transshipmentPort\", \"portOfDischarge\". There should be at least one pickup and delivery stop or one transfer (terminal) and one delivery. For ocean loads, there should be at least one portOfLoading and one portOfDischarge stop." }, { "name": "stopSequence", "kind": "required", "type": "string", "description": "Enter the stop sequence of the stop. The stopSequence is used to identify the stop for which the appointment time or status reason code is updated. Note: This stop sequence you specify should be present at the stop in the load (BOL) mentioned. For example, if you wish to update the appointment time or reason code for a stop with stop sequence 2, enter the value as 2. Ex: \"2\"" }, { "name": "stopReferenceId", "kind": "required", "type": "string", "description": "Enter the stop reference ID of the stop in the load for which the appointment time should be updated. The stopSequence is used to identify the stop for which the appointment time or status reason code is updated. Note: The stop reference ID you specify should be present at the stop in the load (BOL) mentioned. For example, if you wish to update the appointment time or reason code for a stop with stop reference id 1234, enter the value as 1234. Ex: \"1234\"\n\n\n" }, { "name": "postalCode", "kind": "required", "type": "string", "description": "It indicates the postal/zip code of the stop. Ex: \"75201\"" }, { "name": "statusCode", "kind": "optional", "type": "string", "description": "It indicates the status code for processing stop level event Note: The stopSequence or the stopReferenceId should also be specified. Ex: \"AF\"" }, { "name": "statusDescription", "kind": "optional", "type": "string", "description": "It indicates the status message for processing stop level event Note: The stopSequence or the stopReferenceId should also be specified. Ex: \"Picked Up\"" }, { "name": "statusReasonCode", "kind": "optional", "type": "string", "description": "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. Ex: \"Severe_Weather_Conditions\"" }, { "name": "eventTimeStamp", "kind": "optional", "type": "string", "description": "It indicates the date time for processing stop level event Note: The stopSequence or the stopReferenceId should also be specified. Ex: \"2017-11-23T07:55:00Z\"" }, { "name": "modeType", "kind": "optional", "type": "string", "description": "Specifies the transportation mode for the load. Typically set to \"intermodal\" to enable updating of terminal stops." }, { "name": "terminalStops", "kind": "optional", "type": "object", "description": "List of terminal stop objects associated with the load. Each object represents a stop with scheduling, location, and routing details.", "children": [ { "name": "appointmentTime", "kind": "optional", "type": "string", "description": "The scheduled appointment time at the stop. Format: YYYY-MM-DDTHH:MM:SSZ" }, { "name": "earliestAppointmentTime", "kind": "optional", "type": "string", "description": "The earliest acceptable appointment time at the stop. Format: YYYY-MM-DDTHH:MM:SSZ" }, { "name": "latestAppointmentTime", "kind": "optional", "type": "string", "description": "The latest acceptable appointment time at the stop. Format: YYYY-MM-DDTHH:MM:SSZ" }, { "name": "stopType", "kind": "required", "type": "string", "description": "Indicates the role of the stop in the journey. Example value: \"originTerminal\"" }, { "name": "transportationMode", "kind": "optional", "type": "string", "description": "The mode of transport used at or from this stop (e.g., rail, truck)." }, { "name": "stopSequence", "kind": "required", "type": "string", "description": "The order of this stop in the overall route. Starts at 1 for the first stop." }, { "name": "stopReferenceId", "kind": "optional", "type": "string", "description": "A unique identifier for the stop, used for referencing or matching against existing stop records." }, { "name": "name", "kind": "required", "type": "string", "description": "The display name of the terminal stop." }, { "name": "city", "kind": "required", "type": "string", "description": "The city where the terminal stop is located." }, { "name": "state", "kind": "optional", "type": "string", "description": "The state or province where the terminal stop is located." }, { "name": "country", "kind": "required", "type": "string", "description": "The country where the terminal stop is located." }, { "name": "latitude", "kind": "optional", "type": "string", "description": "The geographic latitude of the stop. Example: \"47.1667\"" }, { "name": "longitude", "kind": "optional", "type": "string", "description": "The geographic longitude of the stop. Example: \"-2.1667\"" } ] } ] }, { "name": "loadUpdate", "kind": "optional", "type": "object", "description": "LoadUpdate key is to update Load level information. ", "children": [ { "name": "locationUpdate", "kind": "optional", "type": "object", "description": "LocationUpdate key can be used for providing latest GPS coordinates updates to the FourKites load. ", "children": [ { "name": "latitude", "kind": "required", "type": "string", "description": "Enter the latitude of the truck's current location The only accepted format of lat/long by FOURKITES® is the \"Decimal Degrees\" format. For example, 41.8781 (lat) and -87.6298 (long). Ex: \"41.898274\"" }, { "name": "longitude", "kind": "required", "type": "string", "description": "Enter the longitude of the truck's current location The only accepted format of lat/long by FOURKITES® is the \"Decimal Degrees\" format. For example, 41.8781 (lat) and -87.6298 (long). Ex: \"-88.028452\"" }, { "name": "locatedAt", "kind": "required", "type": "string", "description": "Enter the timestamp at which the latitude and longitude values were recorded for location. This field is usually given along with the latitude/longitude values. If no value is given, the current time will be considered as locatedAt value. Ex: \"2017-11-23T07:55:00Z\"\n" }, { "name": "city", "kind": "optional", "type": "string", "description": "Enter the city name of the truck's current location. Ex: \"Chicago\"" }, { "name": "state", "kind": "optional", "type": "string", "description": "Enter the 2 digit state code of the truck location. Ex: \"IL\"" }, { "name": "deliveredAt", "kind": "optional", "type": "string", "description": "Enter the time at which the shipment was delivered at the final consignee, given in ISO 8601 format. This value is usually provided to indicate that a load was delivered. If no value is given, deliveredAt will default to the current time. Ex: \"2017-11-23T07:55:00Z\"" } ] }, { "name": "etaUpdate", "kind": "optional", "type": "object", "description": "EtaUpdate key can be used to send carrier ETA for the Load. This eta fields given is processed as overall Load Eta or the final delivery ETA.", "children": [ { "name": "estimatedArrivalAtDestination", "kind": "optional", "type": "string", "description": "It indicates the Load ETA datetime to destination provided by the carrier. Ex: \"2017-11-23T07:55:00Z\"" }, { "name": "estimatedArrivalAtDestinationDateOnly", "kind": "optional", "type": "string", "description": "If there is only Load Date available and no time, this field can be used to pass the date only format. Ex: \"2017-11-23\"" } ] }, { "name": "temperatureUpdate", "kind": "optional", "type": "object", "description": "Temperature Update key is to provide Temperature updates to the FourKites Load", "children": [ { "name": "temperature", "kind": "required", "type": "string", "description": "Enter the target temperature at which a product is maintained. Ex: \"20\"" }, { "name": "sensorName", "kind": "optional", "type": "string", "description": "\"Enter the sensor name\". Ex: \"SensorName1\"" }, { "name": "temperatureUnit", "kind": "optional", "type": "string", "description": "Enter the unit of the temperature in which the product is maintained. The valid values are \"C\" for Celsius and \"F\" for Fahrenheit. If no value is given, the unit defaults to Fahrenheit. Ex: \"F\"\n" }, { "name": "temperatureCheckCallTime", "kind": "optional", "type": "string", "description": "It indicates the check call time at which the temperature reading of the product was taken. Ex: \"2017-11-23T07:55:00Z\"" }, { "name": "temperatureTimestamp", "kind": "optional", "type": "string", "description": "Enter the timestamp at which the temperature reading was sent. If no value is given, the current time will be taken. \"2017-11-23T07:55:00Z\"" } ] }, { "name": "loadInfoUpdate", "kind": "optional", "type": "object", "description": "LoadInfoUpdate key is to update Load level information. These can be tags, proNumbers, or any of the below - which can be updated to the FourKites Load.", "children": [ { "name": "tags", "kind": "optional", "type": "array", "description": "It indicates the tag specified by a company for a load. Ex: \"tags\":[\"tag1\", \"tag2\", \"tag3\"]" }, { "name": "updatableProNumber", "kind": "optional", "type": "string", "description": "It indicates the updatable field where carrier can update (if not already) proNumber to the FourKites load. Note: This is not an identifying field, which will be used to search and match loads. Ex: \"proNumber\"" }, { "name": "updatableCarrierReferenceNumber", "kind": "optional", "type": "string", "description": "It is the list of carrier reference numbers assigned by managing carriers for operating carriers to match on loads." }, { "name": "brokeredLoad", "kind": "optional", "type": "boolean", "description": "It indicates if the load is a brokered load or not. Ex: true or false" }, { "name": "relayLoad", "kind": "optional", "type": "boolean", "description": "It indicates if the load is a relay load or not. Ex: true or false" }, { "name": "simultaneousTrackingReferenceNumber", "kind": "optional", "type": "string", "description": "It indicates a simultaneous tracking reference number across a group of simultaneous loads in order to group them. Ex: \"sim007654\"" }, { "name": "endPoint", "kind": "optional", "type": "string", "description": "" }, { "name": "startPoint", "kind": "optional", "type": "string", "description": "" }, { "name": "startTime", "kind": "optional", "type": "string", "description": "" }, { "name": "forceStart", "kind": "optional", "type": "string", "description": "It indicates the timestamp the sequenced load is due to start tracking. Ex: \"2021-10-25T10:00:00.000Z\"" }, { "name": "stopTracking", "kind": "optional", "type": "boolean", "description": "It indicates that the tracking of the load is stopped. Ex: True or False" }, { "name": "weight", "kind": "optional", "type": "string", "description": "It indicates the load’s weight. Ex: \"96\"" }, { "name": "weightUnit", "kind": "optional", "type": "string", "description": "It indicates the unit of mass and weight of the load. Ex: \"KG\"" }, { "name": "freightCharges", "kind": "optional", "type": "string", "description": "It indicates the freight charges" }, { "name": "freightChargeUnit", "kind": "optional", "type": "string", "description": "It indicates the unit of currency of the freight charges. Ex: \"USD\"" }, { "name": "quantity", "kind": "optional", "type": "string", "description": "It indicates the total quantity of the load. Ex: \"88\"" }, { "name": "simultaneousTrackingSequenceNumber", "kind": "optional", "type": "number", "description": "It is the unique sequence number that represents the sequence of deliveries for the simultaneous loads to predict better ETAs." } ] }, { "name": "eventUpdate", "kind": "optional", "type": "object", "description": "EventUpdate key can be used for providing event or status updates to the FourKites load.", "children": [ { "name": "modeType", "kind": "optional", "type": "array", "description": "Load mode types." }, { "name": "statusCode", "kind": "optional", "type": "string", "description": "It indicates the load event status code. Ex: \"AF\"" }, { "name": "statusDescription", "kind": "optional", "type": "string", "description": "It indicates the load event status message. Ex: \"Picked Up\"" }, { "name": "statusReasonCode", "kind": "optional", "type": "string", "description": "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. Ex: \"Severe_Weather_Conditions\"" }, { "name": "eventTimeStamp", "kind": "optional", "type": "string", "description": "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. Ex: \"2017-11-23T07:55:00Z\"" }, { "name": "ecta", "kind": "optional", "type": "object", "description": "Carrier can send ECTA (European Chemical Transport Association) event codes in this object key Note: This is applicable only for LTL mode loads", "children": [ { "name": "status", "kind": "optional", "type": "string", "description": "Ecta Status. Ex: { \"Status\": \"Booking confirmation\", \"Timestamp\": \"2021-06-03T14:30:00Z\", \"StatusDescription\": \"Booking confirmation\" }" } ] }, { "name": "city", "kind": "optional", "type": "string", "description": "Enter the city name of the load event. Ex: \"Chicago\"" }, { "name": "state", "kind": "optional", "type": "string", "description": "Enter the 2 digit state code of the load event. Ex: \"IL\"" }, { "name": "country", "kind": "optional", "type": "string", "description": "Enter the 2 digit county code. Ex: \"US\"" }, { "name": "pickupTime", "kind": "optional", "type": "string", "description": "It indicates the time when the load was picked up Note: This is applicable only for LTL mode loads. Ex: \"2017-11-23T07:55:00Z\"" }, { "name": "deliveryTime", "kind": "optional", "type": "string", "description": "It indicates the time when the load was delivered Note: This is applicable only for LTL mode loads. Ex: \"2017-11-23T07:55:00Z\"" }, { "name": "delivered", "kind": "optional", "type": "boolean", "description": "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. Ex: True or False" }, { "name": "oceanDataHash", "kind": "optional", "type": "object", "description": "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\" }" }, { "name": "vesselLocation", "kind": "optional", "type": "string", "description": "Note: This is applicable only for Ocean/Intermodal mode loads Also OceanContainer is mandatory in \"assignmentUpdate\" Key" }, { "name": "railEventCode", "kind": "optional", "type": "string", "description": "It indicates the rail event code Note: This is applicable for only Rail mode loads. Ex: \"X6\"" }, { "name": "shipmentStatusIndicator", "kind": "optional", "type": "string", "description": "It indicates the status indicator of the shipment Note: This is applicable for only Rail mode loads. Ex: \"X6\"" }, { "name": "shipmentStatus", "kind": "optional", "type": "string", "description": "It indicates the status of the shipment Note: This is applicable for only Rail mode loads. Ex: \"AR\"" }, { "name": "failedLoads", "kind": "optional", "type": "string", "description": "" }, { "name": "airDataHash", "kind": "optional", "type": "object", "description": "Enter Air event tracking update if applicable in this object key Note: This is applicable only for Air mode loads", "children": [ { "name": "quantity", "kind": "optional", "type": "string", "description": "Total quantity." } ] } ] } ] } ] } ], "formDataParameters": [] }, "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" }, "hasTryItOut": false, "autoGeneratedAnchorSlug": "staging", "legacyHash": "PaPezFh2D10lC1yRDHImz" } ``` ::: *** ***