---
title: Port-to-Port
slug: fourkites-api-reference/port-to-port
description: Learn how to use the "Create Load API" to efficiently create new loads for tracking in our comprehensive document. Discover code examples, response examples, crucial header information, and the necessary body parameters for seamless API requests. Ensure t
icon: {"apiMethod":"POST"}
createdAt: 2023-08-03T18:22:19.000Z
---
Create a Port-to-Port load with Port of Loading and Port of Discharge stop types -- or, a purely ocean leg.
:::hint{type="danger"}
### ⚠️ Important Update:
The Pallets structure is being deprecated. Please transition to for product details. [Learn more](https://docs.fourkites.com/api-reference/BXk7-create-shipment#ICU0Y)
:::
:::hint{type="info"}
**Note**: This documentation provides load mode-specific API payloads for this transportation type. For a comprehensive reference of **all available API parameters** that can be applied to these payloads, including parameters across all load modes, please refer to the [Create Shipment](https://docs.fourkites.com/api-reference/BXk7-create-shipment) / [Update Shipment](https://docs.fourkites.com/api-reference/update-shipment) documentation.
:::
:::hint{type="warning"}
This API is called after the carrier has accepted the tender for the load. FourKites does not limit customers from creating more than one load with the same load number or PRO number -- creation of more than one load with the same load or PRO number will cause duplication of loads, which will end up affecting the tracking performance. Customers are advised to handle this on their side. To learn more about Idempotency Protection, [refer here](https://docs.fourkites.com/api-reference/idempotency-protection).
:::
:::hint{type="info"}
If you receive a server error **(5xx error code)**, please try again a few times. It's best to wait a little longer between each retry attempt. Try at least 3-5 times before giving up, as many server issues resolve themselves quickly.
:::
Supporting Document: [Create Shipment](https://docs.fourkites.com/api-reference/BXk7-create-shipment#4xc3cRbgZT-au2XAHx_w3)
:::hint{type="info"}
### Rate Limit
**1 request per second**
:::
:::hint{type="info"}
### Format Supported
**JSON**
:::
:::hint{type="info"}
### Authenticated Resource
**API Key**
:::
For more information on Authentication, [click here](https://docs.fourkites.com/api-reference/authentication).
:::hint{type="info"}
FourKites does not limit customers from creating more than one load with the same load number or PRO number. When making POST requests to create a load, please ensure that it is the first time that specific load number has been used to create a load. If multiple POST requests are made with the same data, FourKites will generate duplicate loads
:::
:::hint{type="warning"}
It's mandatory to send either `bookingNumber` or `billOfLading` while creating port-to-port loads.
:::
:::ApiMethodV2
```json
{
"name": "Production",
"method": "POST",
"url": "https://api.fourkites.com/api/v1/tracking",
"description": "",
"tab": "examples",
"examples": {
"languages": [
{
"id": "R9fUapNeQ5A5Ft6WMmxI2",
"language": "java",
"code": "OkHttpClient client = new OkHttpClient().newBuilder()\n .build();\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\n \\\"trackingInfo\\\": {\\n \\\"driverPhone\\\": \\\"\\\",\\n \\\"truckNumber\\\": \\\"\\\",\\n \\\"vesselName\\\": \\\"\\\",\\n \\\"imo\\\": \\\"\\\",\\n \\\"mmsi\\\": \\\"\\\",\\n \\\"containerNumber\\\": \\\"OOLU4404637\\\"\\n },\\n \\\"containerInfo\\\": {\\n \\\"containerNumber\\\": \\\"OOLU4404637\\\"\\n },\\n \\\"load\\\": {\\n \\\"loadNumber\\\": \\\"stop_completion_1\\\",\\n \\\"priority\\\": \\\"normal\\\",\\n \\\"operatingCarrierScac\\\": null,\\n \\\"carrier\\\": \\\"1234\\\",\\n \\\"carrierName\\\": \\\"\\\",\\n \\\"carrierPermalink\\\": \\\"oceancarrier\\\",\\n \\\"products\\\": [],\\n \\\"bookingNumber\\\": \\\"\\\",\\n \\\"trackingNumber\\\": \\\"\\\",\\n \\\"billOfLading\\\": \\\"GOA230437868\\\",\\n \\\"referenceNumbers\\\": [],\\n \\\"stops\\\": [\\n {\\n \\\"stopType\\\": \\\"portOfLoading\\\",\\n \\\"customer\\\": {\\n \\\"id\\\": null,\\n \\\"originalCustomerId\\\": null,\\n \\\"poNumbers\\\": []\\n },\\n \\\"addressLine1\\\": \\\"\\\",\\n \\\"city\\\": \\\"\\\",\\n \\\"state\\\": \\\"\\\",\\n \\\"country\\\": \\\"\\\",\\n \\\"postalCode\\\": \\\"\\\",\\n \\\"latitude\\\": \\\"\\\",\\n \\\"longitude\\\": \\\"\\\",\\n \\\"geofencePoints\\\": [],\\n \\\"externalAddressId\\\": \\\"INMAA\\\",\\n \\\"appointmentTime\\\": null,\\n \\\"stopReferenceId\\\": \\\"\\\",\\n \\\"earliestAppointmentTime\\\": null,\\n \\\"latestAppointmentTime\\\": null,\\n \\\"estimatedDepartureTime\\\": \\\"2023-07-20T06:00:00\\\",\\n \\\"wantTime\\\": null\\n },\\n {\\n \\\"stopType\\\": \\\"transshipmentPort\\\",\\n \\\"customer\\\": {\\n \\\"id\\\": null,\\n \\\"originalCustomerId\\\": null,\\n \\\"poNumbers\\\": []\\n },\\n \\\"addressLine1\\\": \\\"\\\",\\n \\\"city\\\": \\\"\\\",\\n \\\"state\\\": \\\"\\\",\\n \\\"country\\\": \\\"\\\",\\n \\\"postalCode\\\": \\\"\\\",\\n \\\"latitude\\\": \\\"\\\",\\n \\\"longitude\\\": \\\"\\\",\\n \\\"geofencePoints\\\": [],\\n \\\"externalAddressId\\\": \\\"SGSIN\\\",\\n \\\"appointmentTime\\\": null,\\n \\\"stopReferenceId\\\": \\\"\\\",\\n \\\"earliestAppointmentTime\\\": \\\"2023-07-21T06:00:00\\\",\\n \\\"latestAppointmentTime\\\": \\\"2023-07-21T16:00:00\\\",\\n \\\"wantTime\\\": null\\n },\\n {\\n \\\"stopType\\\": \\\"portOfDischarge\\\",\\n \\\"customer\\\": {\\n \\\"id\\\": null,\\n \\\"originalCustomerId\\\": null,\\n \\\"poNumbers\\\": []\\n },\\n \\\"addressLine1\\\": \\\"\\\",\\n \\\"city\\\": \\\"\\\",\\n \\\"state\\\": \\\"\\\",\\n \\\"country\\\": \\\"\\\",\\n \\\"postalCode\\\": \\\"\\\",\\n \\\"latitude\\\": \\\"\\\",\\n \\\"longitude\\\": \\\"\\\",\\n \\\"geofencePoints\\\": [],\\n \\\"externalAddressId\\\": \\\"USJAX\\\",\\n \\\"appointmentTime\\\": \\\"2024-03-31T16:00:00\\\",\\n \\\"stopReferenceId\\\": \\\"\\\",\\n \\\"earliestAppointmentTime\\\": null,\\n \\\"latestAppointmentTime\\\": null,\\n \\\"wantTime\\\": null\\n }\\n ]\\n }\\n}\");\nRequest request = new Request.Builder()\n .url(\"https://api.fourkites.com/api/v1/tracking\")\n .method(\"POST\", body)\n .addHeader(\"Content-Type\", \"application/json\")\n .addHeader(\"apikey\", \"REPLACE_KEY_VALUE\")\n .build();\nResponse response = client.newCall(request).execute();",
"customLabel": ""
},
{
"id": "qT5uNZIqgUvY8TitfBixf",
"language": "javascript",
"code": "var settings = {\n \"url\": \"https://api.fourkites.com/api/v1/tracking\",\n \"method\": \"POST\",\n \"timeout\": 0,\n \"headers\": {\n \"Content-Type\": \"application/json\",\n \"apikey\": \"REPLACE_KEY_VALUE\"\n },\n \"data\": JSON.stringify({\n \"trackingInfo\": {\n \"driverPhone\": \"\",\n \"truckNumber\": \"\",\n \"vesselName\": \"\",\n \"imo\": \"\",\n \"mmsi\": \"\",\n \"containerNumber\": \"OOLU4404637\"\n },\n \"containerInfo\": {\n \"containerNumber\": \"OOLU4404637\"\n },\n \"load\": {\n \"loadNumber\": \"stop_completion_1\",\n \"priority\": \"normal\",\n \"operatingCarrierScac\": null,\n \"carrier\": \"1234\",\n \"carrierName\": \"\",\n \"carrierPermalink\": \"oceancarrier\",\n \"products\": [],\n \"bookingNumber\": \"\",\n \"trackingNumber\": \"\",\n \"billOfLading\": \"GOA230437868\",\n \"referenceNumbers\": [],\n \"stops\": [\n {\n \"stopType\": \"portOfLoading\",\n \"customer\": {\n \"id\": null,\n \"originalCustomerId\": null,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"INMAA\",\n \"appointmentTime\": null,\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": null,\n \"latestAppointmentTime\": null,\n \"estimatedDepartureTime\": \"2023-07-20T06:00:00\",\n \"wantTime\": null\n },\n {\n \"stopType\": \"transshipmentPort\",\n \"customer\": {\n \"id\": null,\n \"originalCustomerId\": null,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"SGSIN\",\n \"appointmentTime\": null,\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": \"2023-07-21T06:00:00\",\n \"latestAppointmentTime\": \"2023-07-21T16:00:00\",\n \"wantTime\": null\n },\n {\n \"stopType\": \"portOfDischarge\",\n \"customer\": {\n \"id\": null,\n \"originalCustomerId\": null,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"USJAX\",\n \"appointmentTime\": \"2024-03-31T16:00:00\",\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": null,\n \"latestAppointmentTime\": null,\n \"wantTime\": null\n }\n ]\n }\n }),\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});",
"customLabel": ""
},
{
"id": "mViRMiSR81WSzY3jgFUSE",
"language": "swift",
"code": "import Foundation\n#if canImport(FoundationNetworking)\nimport FoundationNetworking\n#endif\n\nvar semaphore = DispatchSemaphore (value: 0)\n\nlet parameters = \"{\\n \\\"trackingInfo\\\": {\\n \\\"driverPhone\\\": \\\"\\\",\\n \\\"truckNumber\\\": \\\"\\\",\\n \\\"vesselName\\\": \\\"\\\",\\n \\\"imo\\\": \\\"\\\",\\n \\\"mmsi\\\": \\\"\\\",\\n \\\"containerNumber\\\": \\\"OOLU4404637\\\"\\n },\\n \\\"containerInfo\\\": {\\n \\\"containerNumber\\\": \\\"OOLU4404637\\\"\\n },\\n \\\"load\\\": {\\n \\\"loadNumber\\\": \\\"stop_completion_1\\\",\\n \\\"priority\\\": \\\"normal\\\",\\n \\\"operatingCarrierScac\\\": null,\\n \\\"carrier\\\": \\\"1234\\\",\\n \\\"carrierName\\\": \\\"\\\",\\n \\\"carrierPermalink\\\": \\\"oceancarrier\\\",\\n \\\"products\\\": [],\\n \\\"bookingNumber\\\": \\\"\\\",\\n \\\"trackingNumber\\\": \\\"\\\",\\n \\\"billOfLading\\\": \\\"GOA230437868\\\",\\n \\\"referenceNumbers\\\": [],\\n \\\"stops\\\": [\\n {\\n \\\"stopType\\\": \\\"portOfLoading\\\",\\n \\\"customer\\\": {\\n \\\"id\\\": null,\\n \\\"originalCustomerId\\\": null,\\n \\\"poNumbers\\\": []\\n },\\n \\\"addressLine1\\\": \\\"\\\",\\n \\\"city\\\": \\\"\\\",\\n \\\"state\\\": \\\"\\\",\\n \\\"country\\\": \\\"\\\",\\n \\\"postalCode\\\": \\\"\\\",\\n \\\"latitude\\\": \\\"\\\",\\n \\\"longitude\\\": \\\"\\\",\\n \\\"geofencePoints\\\": [],\\n \\\"externalAddressId\\\": \\\"INMAA\\\",\\n \\\"appointmentTime\\\": null,\\n \\\"stopReferenceId\\\": \\\"\\\",\\n \\\"earliestAppointmentTime\\\": null,\\n \\\"latestAppointmentTime\\\": null,\\n \\\"estimatedDepartureTime\\\": \\\"2023-07-20T06:00:00\\\",\\n \\\"wantTime\\\": null\\n },\\n {\\n \\\"stopType\\\": \\\"transshipmentPort\\\",\\n \\\"customer\\\": {\\n \\\"id\\\": null,\\n \\\"originalCustomerId\\\": null,\\n \\\"poNumbers\\\": []\\n },\\n \\\"addressLine1\\\": \\\"\\\",\\n \\\"city\\\": \\\"\\\",\\n \\\"state\\\": \\\"\\\",\\n \\\"country\\\": \\\"\\\",\\n \\\"postalCode\\\": \\\"\\\",\\n \\\"latitude\\\": \\\"\\\",\\n \\\"longitude\\\": \\\"\\\",\\n \\\"geofencePoints\\\": [],\\n \\\"externalAddressId\\\": \\\"SGSIN\\\",\\n \\\"appointmentTime\\\": null,\\n \\\"stopReferenceId\\\": \\\"\\\",\\n \\\"earliestAppointmentTime\\\": \\\"2023-07-21T06:00:00\\\",\\n \\\"latestAppointmentTime\\\": \\\"2023-07-21T16:00:00\\\",\\n \\\"wantTime\\\": null\\n },\\n {\\n \\\"stopType\\\": \\\"portOfDischarge\\\",\\n \\\"customer\\\": {\\n \\\"id\\\": null,\\n \\\"originalCustomerId\\\": null,\\n \\\"poNumbers\\\": []\\n },\\n \\\"addressLine1\\\": \\\"\\\",\\n \\\"city\\\": \\\"\\\",\\n \\\"state\\\": \\\"\\\",\\n \\\"country\\\": \\\"\\\",\\n \\\"postalCode\\\": \\\"\\\",\\n \\\"latitude\\\": \\\"\\\",\\n \\\"longitude\\\": \\\"\\\",\\n \\\"geofencePoints\\\": [],\\n \\\"externalAddressId\\\": \\\"USJAX\\\",\\n \\\"appointmentTime\\\": \\\"2024-03-31T16:00:00\\\",\\n \\\"stopReferenceId\\\": \\\"\\\",\\n \\\"earliestAppointmentTime\\\": null,\\n \\\"latestAppointmentTime\\\": null,\\n \\\"wantTime\\\": null\\n }\\n ]\\n }\\n}\"\nlet postData = parameters.data(using: .utf8)\n\nvar request = URLRequest(url: URL(string: \"https://api.fourkites.com/api/v1/tracking\")!,timeoutInterval: Double.infinity)\nrequest.addValue(\"application/json\", forHTTPHeaderField: \"Content-Type\")\nrequest.addValue(\"REPLACE_KEY_VALUE\", 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 semaphore.signal()\n return\n }\n print(String(data: data, encoding: .utf8)!)\n semaphore.signal()\n}\n\ntask.resume()\nsemaphore.wait()\n",
"customLabel": ""
},
{
"id": "jzpSj1-UF6Wq5Uwg3WWQY",
"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/api/v1/tracking\"\n method := \"POST\"\n\n payload := strings.NewReader(`{\n \"trackingInfo\": {\n \"driverPhone\": \"\",\n \"truckNumber\": \"\",\n \"vesselName\": \"\",\n \"imo\": \"\",\n \"mmsi\": \"\",\n \"containerNumber\": \"OOLU4404637\"\n },\n \"containerInfo\": {\n \"containerNumber\": \"OOLU4404637\"\n },\n \"load\": {\n \"loadNumber\": \"stop_completion_1\",\n \"priority\": \"normal\",\n \"operatingCarrierScac\": null,\n \"carrier\": \"1234\",\n \"carrierName\": \"\",\n \"carrierPermalink\": \"oceancarrier\",\n \"products\": [],\n \"bookingNumber\": \"\",\n \"trackingNumber\": \"\",\n \"billOfLading\": \"GOA230437868\",\n \"referenceNumbers\": [],\n \"stops\": [\n {\n \"stopType\": \"portOfLoading\",\n \"customer\": {\n \"id\": null,\n \"originalCustomerId\": null,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"INMAA\",\n \"appointmentTime\": null,\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": null,\n \"latestAppointmentTime\": null,\n \"estimatedDepartureTime\": \"2023-07-20T06:00:00\",\n \"wantTime\": null\n },\n {\n \"stopType\": \"transshipmentPort\",\n \"customer\": {\n \"id\": null,\n \"originalCustomerId\": null,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"SGSIN\",\n \"appointmentTime\": null,\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": \"2023-07-21T06:00:00\",\n \"latestAppointmentTime\": \"2023-07-21T16:00:00\",\n \"wantTime\": null\n },\n {\n \"stopType\": \"portOfDischarge\",\n \"customer\": {\n \"id\": null,\n \"originalCustomerId\": null,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"USJAX\",\n \"appointmentTime\": \"2024-03-31T16:00:00\",\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": null,\n \"latestAppointmentTime\": null,\n \"wantTime\": null\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\", \"REPLACE_KEY_VALUE\")\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}",
"customLabel": ""
},
{
"id": "sGD0P46h2XeSoAQyeN5-Q",
"language": "csharp",
"code": "var client = new RestClient(\"https://api.fourkites.com/api/v1/tracking\");\nclient.Timeout = -1;\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddHeader(\"apikey\", \"REPLACE_KEY_VALUE\");\nvar body = @\"{\" + \"\\n\" +\n@\" \"\"trackingInfo\"\": {\" + \"\\n\" +\n@\" \"\"driverPhone\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"truckNumber\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"vesselName\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"imo\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"mmsi\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"containerNumber\"\": \"\"OOLU4404637\"\"\" + \"\\n\" +\n@\" },\" + \"\\n\" +\n@\" \"\"containerInfo\"\": {\" + \"\\n\" +\n@\" \"\"containerNumber\"\": \"\"OOLU4404637\"\"\" + \"\\n\" +\n@\" },\" + \"\\n\" +\n@\" \"\"load\"\": {\" + \"\\n\" +\n@\" \"\"loadNumber\"\": \"\"stop_completion_1\"\",\" + \"\\n\" +\n@\" \"\"priority\"\": \"\"normal\"\",\" + \"\\n\" +\n@\" \"\"operatingCarrierScac\"\": null,\" + \"\\n\" +\n@\" \"\"carrier\"\": \"\"1234\"\",\" + \"\\n\" +\n@\" \"\"carrierName\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"carrierPermalink\"\": \"\"oceancarrier\"\",\" + \"\\n\" +\n@\" \"\"products\"\": [],\" + \"\\n\" +\n@\" \"\"bookingNumber\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"trackingNumber\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"billOfLading\"\": \"\"GOA230437868\"\",\" + \"\\n\" +\n@\" \"\"referenceNumbers\"\": [],\" + \"\\n\" +\n@\" \"\"stops\"\": [\" + \"\\n\" +\n@\" {\" + \"\\n\" +\n@\" \"\"stopType\"\": \"\"portOfLoading\"\",\" + \"\\n\" +\n@\" \"\"customer\"\": {\" + \"\\n\" +\n@\" \"\"id\"\": null,\" + \"\\n\" +\n@\" \"\"originalCustomerId\"\": null,\" + \"\\n\" +\n@\" \"\"poNumbers\"\": []\" + \"\\n\" +\n@\" },\" + \"\\n\" +\n@\" \"\"addressLine1\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"city\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"state\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"country\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"postalCode\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"latitude\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"longitude\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"geofencePoints\"\": [],\" + \"\\n\" +\n@\" \"\"externalAddressId\"\": \"\"INMAA\"\",\" + \"\\n\" +\n@\" \"\"appointmentTime\"\": null,\" + \"\\n\" +\n@\" \"\"stopReferenceId\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"earliestAppointmentTime\"\": null,\" + \"\\n\" +\n@\" \"\"latestAppointmentTime\"\": null,\" + \"\\n\" +\n@\" \"\"estimatedDepartureTime\"\": \"\"2023-07-20T06:00:00\"\",\" + \"\\n\" +\n@\" \"\"wantTime\"\": null\" + \"\\n\" +\n@\" },\" + \"\\n\" +\n@\" {\" + \"\\n\" +\n@\" \"\"stopType\"\": \"\"transshipmentPort\"\",\" + \"\\n\" +\n@\" \"\"customer\"\": {\" + \"\\n\" +\n@\" \"\"id\"\": null,\" + \"\\n\" +\n@\" \"\"originalCustomerId\"\": null,\" + \"\\n\" +\n@\" \"\"poNumbers\"\": []\" + \"\\n\" +\n@\" },\" + \"\\n\" +\n@\" \"\"addressLine1\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"city\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"state\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"country\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"postalCode\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"latitude\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"longitude\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"geofencePoints\"\": [],\" + \"\\n\" +\n@\" \"\"externalAddressId\"\": \"\"SGSIN\"\",\" + \"\\n\" +\n@\" \"\"appointmentTime\"\": null,\" + \"\\n\" +\n@\" \"\"stopReferenceId\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"earliestAppointmentTime\"\": \"\"2023-07-21T06:00:00\"\",\" + \"\\n\" +\n@\" \"\"latestAppointmentTime\"\": \"\"2023-07-21T16:00:00\"\",\" + \"\\n\" +\n@\" \"\"wantTime\"\": null\" + \"\\n\" +\n@\" },\" + \"\\n\" +\n@\" {\" + \"\\n\" +\n@\" \"\"stopType\"\": \"\"portOfDischarge\"\",\" + \"\\n\" +\n@\" \"\"customer\"\": {\" + \"\\n\" +\n@\" \"\"id\"\": null,\" + \"\\n\" +\n@\" \"\"originalCustomerId\"\": null,\" + \"\\n\" +\n@\" \"\"poNumbers\"\": []\" + \"\\n\" +\n@\" },\" + \"\\n\" +\n@\" \"\"addressLine1\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"city\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"state\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"country\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"postalCode\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"latitude\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"longitude\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"geofencePoints\"\": [],\" + \"\\n\" +\n@\" \"\"externalAddressId\"\": \"\"USJAX\"\",\" + \"\\n\" +\n@\" \"\"appointmentTime\"\": \"\"2024-03-31T16:00:00\"\",\" + \"\\n\" +\n@\" \"\"stopReferenceId\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"earliestAppointmentTime\"\": null,\" + \"\\n\" +\n@\" \"\"latestAppointmentTime\"\": null,\" + \"\\n\" +\n@\" \"\"wantTime\"\": null\" + \"\\n\" +\n@\" }\" + \"\\n\" +\n@\" ]\" + \"\\n\" +\n@\" }\" + \"\\n\" +\n@\"}\";\nrequest.AddParameter(\"application/json\", body, ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);\nConsole.WriteLine(response.Content);",
"customLabel": ""
},
{
"id": "l7iv2Zqs8dxiFMECmyUzF",
"language": "ruby",
"code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.fourkites.com/api/v1/tracking\")\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\"] = \"REPLACE_KEY_VALUE\"\nrequest.body = JSON.dump({\n \"trackingInfo\": {\n \"driverPhone\": \"\",\n \"truckNumber\": \"\",\n \"vesselName\": \"\",\n \"imo\": \"\",\n \"mmsi\": \"\",\n \"containerNumber\": \"OOLU4404637\"\n },\n \"containerInfo\": {\n \"containerNumber\": \"OOLU4404637\"\n },\n \"load\": {\n \"loadNumber\": \"stop_completion_1\",\n \"priority\": \"normal\",\n \"operatingCarrierScac\": nil,\n \"carrier\": \"1234\",\n \"carrierName\": \"\",\n \"carrierPermalink\": \"oceancarrier\",\n \"products\": [],\n \"bookingNumber\": \"\",\n \"trackingNumber\": \"\",\n \"billOfLading\": \"GOA230437868\",\n \"referenceNumbers\": [],\n \"stops\": [\n {\n \"stopType\": \"portOfLoading\",\n \"customer\": {\n \"id\": nil,\n \"originalCustomerId\": nil,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"INMAA\",\n \"appointmentTime\": nil,\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": nil,\n \"latestAppointmentTime\": nil,\n \"estimatedDepartureTime\": \"2023-07-20T06:00:00\",\n \"wantTime\": nil\n },\n {\n \"stopType\": \"transshipmentPort\",\n \"customer\": {\n \"id\": nil,\n \"originalCustomerId\": nil,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"SGSIN\",\n \"appointmentTime\": nil,\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": \"2023-07-21T06:00:00\",\n \"latestAppointmentTime\": \"2023-07-21T16:00:00\",\n \"wantTime\": nil\n },\n {\n \"stopType\": \"portOfDischarge\",\n \"customer\": {\n \"id\": nil,\n \"originalCustomerId\": nil,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"USJAX\",\n \"appointmentTime\": \"2024-03-31T16:00:00\",\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": nil,\n \"latestAppointmentTime\": nil,\n \"wantTime\": nil\n }\n ]\n }\n})\n\nresponse = https.request(request)\nputs response.read_body\n",
"customLabel": ""
},
{
"id": "HCOaGqoQDZrRW3y4fbQiw",
"language": "python",
"code": "import http.client\nimport json\n\nconn = http.client.HTTPSConnection(\"api.fourkites.com\")\npayload = json.dumps({\n \"trackingInfo\": {\n \"driverPhone\": \"\",\n \"truckNumber\": \"\",\n \"vesselName\": \"\",\n \"imo\": \"\",\n \"mmsi\": \"\",\n \"containerNumber\": \"OOLU4404637\"\n },\n \"containerInfo\": {\n \"containerNumber\": \"OOLU4404637\"\n },\n \"load\": {\n \"loadNumber\": \"stop_completion_1\",\n \"priority\": \"normal\",\n \"operatingCarrierScac\": None,\n \"carrier\": \"1234\",\n \"carrierName\": \"\",\n \"carrierPermalink\": \"oceancarrier\",\n \"products\": [],\n \"bookingNumber\": \"\",\n \"trackingNumber\": \"\",\n \"billOfLading\": \"GOA230437868\",\n \"referenceNumbers\": [],\n \"stops\": [\n {\n \"stopType\": \"portOfLoading\",\n \"customer\": {\n \"id\": None,\n \"originalCustomerId\": None,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"INMAA\",\n \"appointmentTime\": None,\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": None,\n \"latestAppointmentTime\": None,\n \"estimatedDepartureTime\": \"2023-07-20T06:00:00\",\n \"wantTime\": None\n },\n {\n \"stopType\": \"transshipmentPort\",\n \"customer\": {\n \"id\": None,\n \"originalCustomerId\": None,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"SGSIN\",\n \"appointmentTime\": None,\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": \"2023-07-21T06:00:00\",\n \"latestAppointmentTime\": \"2023-07-21T16:00:00\",\n \"wantTime\": None\n },\n {\n \"stopType\": \"portOfDischarge\",\n \"customer\": {\n \"id\": None,\n \"originalCustomerId\": None,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"USJAX\",\n \"appointmentTime\": \"2024-03-31T16:00:00\",\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": None,\n \"latestAppointmentTime\": None,\n \"wantTime\": None\n }\n ]\n }\n})\nheaders = {\n 'Content-Type': 'application/json',\n 'apikey': 'REPLACE_KEY_VALUE'\n}\nconn.request(\"POST\", \"/api/v1/tracking\", payload, headers)\nres = conn.getresponse()\ndata = res.read()\nprint(data.decode(\"utf-8\"))",
"customLabel": ""
},
{
"id": "lv3nnV3IgFPz7p6e15yal",
"language": "curl",
"code": "curl --location --request POST 'https://api.fourkites.com/api/v1/tracking' \\\n--header 'Content-Type: application/json' \\\n--header 'apikey: REPLACE_KEY_VALUE' \\\n--data-raw '{\n \"trackingInfo\": {\n \"driverPhone\": \"\",\n \"truckNumber\": \"\",\n \"vesselName\": \"\",\n \"imo\": \"\",\n \"mmsi\": \"\",\n \"containerNumber\": \"OOLU4404637\"\n },\n \"containerInfo\": {\n \"containerNumber\": \"OOLU4404637\"\n },\n \"load\": {\n \"loadNumber\": \"stop_completion_1\",\n \"priority\": \"normal\",\n \"operatingCarrierScac\": null,\n \"carrier\": \"1234\",\n \"carrierName\": \"\",\n \"carrierPermalink\": \"oceancarrier\",\n \"products\": [],\n \"bookingNumber\": \"\",\n \"trackingNumber\": \"\",\n \"billOfLading\": \"GOA230437868\",\n \"referenceNumbers\": [],\n \"stops\": [\n {\n \"stopType\": \"portOfLoading\",\n \"customer\": {\n \"id\": null,\n \"originalCustomerId\": null,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"INMAA\",\n \"appointmentTime\": null,\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": null,\n \"latestAppointmentTime\": null,\n \"estimatedDepartureTime\": \"2023-07-20T06:00:00\",\n \"wantTime\": null,\n \"productLineItems\": [\n {\n \"productId\": \"0123456\",\n \"productName\": \"Ocean Freight Item\",\n \"productDescription\": \"Port-to-port ocean shipment item\",\n \"productCategory\": \"General Freight\",\n \"quantity\": 25,\n \"measurementUnitCode\": \"PCE\",\n \"netWeight\": 44.8,\n \"weightUnit\": \"KGM\",\n \"unitCost\": 25.0,\n \"currencyCode\": \"USD\",\n \"extendedCost\": 625.00,\n \"freightCost\": 20.00,\n \"additionalCharges\": 5.00,\n \"tariffCost\": 2.50,\n \"fourKitesCalculatedTariffCost\": 2.50,\n \"totalLandedCost\": 655.00,\n \"countryOfOrigin\": \"IN\",\n \"harmonizedSystemCode\": \"8471499000\",\n \"commodityTypeCode\": \"OCEAN_FREIGHT\",\n \"htsusCode\": \"8471499000\",\n \"orderNumber\": \"GOA230437868\",\n \"deliveryNumber\": \"DN-INMAA\",\n \"handlingUnitId\": \"PAL-INMAA\",\n \"barcode\": \"PALINMAA\",\n \"containerType\": \"pallet\",\n \"gtin\": \"00012345678905\",\n \"customerPartNumber\": \"22EE\",\n \"supplierPartNumber\": \"22EE\",\n \"manufacturerPartNumber\": \"MFG-22EE\",\n \"itemNumber\": \"ITM-22EE\",\n \"productUpc\": \"012345678905\",\n \"deliveryReferences\": [\"OOLU4404637\"],\n \"orderReferences\": [\"GOA230437868\"],\n \"brandName\": \"Generic Ocean Freight Co\",\n \"minimumTemperature\": 0,\n \"maximumTemperature\": 0,\n \"temperatureUnitCode\": \"cel\",\n \"labelIdentifier\": \"LBL-22EE\",\n \"productTrackingNumber\": \"OOLU4404637-1\",\n \"deviceType\": \"RFID_TAG\"\n }\n ]\n },\n {\n \"stopType\": \"transshipmentPort\",\n \"customer\": {\n \"id\": null,\n \"originalCustomerId\": null,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"SGSIN\",\n \"appointmentTime\": null,\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": \"2023-07-21T06:00:00\",\n \"latestAppointmentTime\": \"2023-07-21T16:00:00\",\n \"wantTime\": null,\n \"productLineItems\": [\n {\n \"productId\": \"0123456\",\n \"productName\": \"Ocean Freight Item\",\n \"productDescription\": \"Port-to-port ocean shipment item\",\n \"productCategory\": \"General Freight\",\n \"quantity\": 25,\n \"measurementUnitCode\": \"PCE\",\n \"netWeight\": 44.8,\n \"weightUnit\": \"KGM\",\n \"unitCost\": 25.0,\n \"currencyCode\": \"USD\",\n \"extendedCost\": 625.00,\n \"freightCost\": 20.00,\n \"additionalCharges\": 5.00,\n \"tariffCost\": 2.50,\n \"fourKitesCalculatedTariffCost\": 2.50,\n \"totalLandedCost\": 655.00,\n \"countryOfOrigin\": \"IN\",\n \"harmonizedSystemCode\": \"8471499000\",\n \"commodityTypeCode\": \"OCEAN_FREIGHT\",\n \"htsusCode\": \"8471499000\",\n \"orderNumber\": \"GOA230437868\",\n \"deliveryNumber\": \"DN-INMAA\",\n \"handlingUnitId\": \"PAL-INMAA\",\n \"barcode\": \"PALINMAA\",\n \"containerType\": \"pallet\",\n \"gtin\": \"00012345678905\",\n \"customerPartNumber\": \"22EE\",\n \"supplierPartNumber\": \"22EE\",\n \"manufacturerPartNumber\": \"MFG-22EE\",\n \"itemNumber\": \"ITM-22EE\",\n \"productUpc\": \"012345678905\",\n \"deliveryReferences\": [\"OOLU4404637\"],\n \"orderReferences\": [\"GOA230437868\"],\n \"brandName\": \"Generic Ocean Freight Co\",\n \"minimumTemperature\": 0,\n \"maximumTemperature\": 0,\n \"temperatureUnitCode\": \"cel\",\n \"labelIdentifier\": \"LBL-22EE\",\n \"productTrackingNumber\": \"OOLU4404637-1\",\n \"deviceType\": \"RFID_TAG\"\n }\n ]\n },\n {\n \"stopType\": \"portOfDischarge\",\n \"customer\": {\n \"id\": null,\n \"originalCustomerId\": null,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"USJAX\",\n \"appointmentTime\": \"2024-03-31T16:00:00\",\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": null,\n \"latestAppointmentTime\": null,\n \"wantTime\": null,\n \"productLineItems\": [\n {\n \"productId\": \"0123456\",\n \"productName\": \"Ocean Freight Item\",\n \"productDescription\": \"Port-to-port ocean shipment item\",\n \"productCategory\": \"General Freight\",\n \"quantity\": 25,\n \"measurementUnitCode\": \"PCE\",\n \"netWeight\": 44.8,\n \"weightUnit\": \"KGM\",\n \"unitCost\": 25.0,\n \"currencyCode\": \"USD\",\n \"extendedCost\": 625.00,\n \"freightCost\": 20.00,\n \"additionalCharges\": 5.00,\n \"tariffCost\": 2.50,\n \"fourKitesCalculatedTariffCost\": 2.50,\n \"totalLandedCost\": 655.00,\n \"countryOfOrigin\": \"IN\",\n \"harmonizedSystemCode\": \"8471499000\",\n \"commodityTypeCode\": \"OCEAN_FREIGHT\",\n \"htsusCode\": \"8471499000\",\n \"orderNumber\": \"GOA230437868\",\n \"deliveryNumber\": \"DN-USJAX\",\n \"handlingUnitId\": \"PAL-USJAX\",\n \"barcode\": \"PALUSJAX\",\n \"containerType\": \"pallet\",\n \"gtin\": \"00012345678905\",\n \"customerPartNumber\": \"22EE\",\n \"supplierPartNumber\": \"22EE\",\n \"manufacturerPartNumber\": \"MFG-22EE\",\n \"itemNumber\": \"ITM-22EE\",\n \"productUpc\": \"012345678905\",\n \"deliveryReferences\": [\"OOLU4404637\"],\n \"orderReferences\": [\"GOA230437868\"],\n \"brandName\": \"Generic Ocean Freight Co\",\n \"minimumTemperature\": 0,\n \"maximumTemperature\": 0,\n \"temperatureUnitCode\": \"cel\",\n \"labelIdentifier\": \"LBL-22EE\",\n \"productTrackingNumber\": \"OOLU4404637-3\",\n \"deviceType\": \"QR_CODE\"\n }\n ]\n }\n ]\n }\n}'"
}
],
"selectedLanguageId": "lv3nnV3IgFPz7p6e15yal"
},
"results": {
"languages": [
{
"id": "Fgv8UpRlPL46aMGyQwH3T",
"language": "200",
"customLabel": "",
"code": "{\n \"statusCode\": 200,\n \"message\": \"Load creation request has been submitted successfully\",\n \"loadId\": 176366208\n}"
}
],
"selectedLanguageId": "Fgv8UpRlPL46aMGyQwH3T"
},
"request": {
"pathParameters": [],
"queryParameters": [],
"headerParameters": [],
"bodyDataParameters": [
{
"name": "trackingInfo",
"kind": "optional",
"type": "object",
"description": "It indicates the information required for tracking the load.",
"children": [
{
"name": "driverPhone",
"kind": "optional",
"type": "string",
"description": "It indicates a valid mobile number. Example: +13125555555"
},
{
"name": "truckNumber",
"kind": "optional",
"type": "string",
"description": "It indicates the tractor or asset number dispatched by the carrier for the load."
},
{
"name": "vesselName",
"kind": "optional",
"type": "string",
"description": "It indicates the name of the vessel carrying the load."
},
{
"name": "imo",
"kind": "optional",
"type": "string",
"description": "It indicates the international maritime organization number."
},
{
"name": "mmsi",
"kind": "optional",
"type": "string",
"description": "It indicates the Maritime Mobile Service Identity (MMSI) of the vessel."
},
{
"name": "containerNumber",
"kind": "required",
"type": "string",
"description": "It indicates the number of the container that is on the vessel. ISO6346 format."
}
]
},
{
"name": "containerInfo",
"kind": "optional",
"type": "object",
"description": "It indicates the information required for tracking the load.",
"children": [
{
"name": "containerNumber",
"kind": "required",
"type": "string",
"description": "It indicates the number of the container that is on the vessel."
}
]
},
{
"name": "load",
"kind": "optional",
"type": "object",
"description": "It is the parent object for the load. Place the load attributes inside this object.",
"children": [
{
"name": "loadNumber",
"kind": "required",
"type": "string",
"description": "It is the unique load identifier from shipper's system. The load Number or BOL is an important piece of information used to link the load with truck information received from the Carrier's TMS."
},
{
"name": "priority",
"kind": "optional",
"type": "string",
"description": "It indicates whether a load is of normal or high priority. If priority is set as ‘hot’, the load will be marked as ‘Hot’. Valid values: ‘normal’, ‘high’ and ‘hot’. Defaults to normal. Setting the 'Priority' as 'hot' will mark the load as 'Hot' load."
},
{
"name": "operatingCarrierScac",
"kind": "optional",
"type": "string",
"description": "SCAC or code of the operating carrier if setting up managing/operating carrier"
},
{
"name": "carrier",
"kind": "required",
"type": "string",
"description": "It is the SCAC or Service Provider ID of the carrier assigned to the load. The carrier should have approved sharing of their telematics data on FourKites® for the customer."
},
{
"name": "products",
"kind": "optional",
"type": "object",
"description": "It indicates the list of temperature tracked products on a load and their temperature tracking information.",
"children": []
},
{
"name": "bookingNumber",
"kind": "required",
"type": "string",
"description": "It indicates the shipping line's booking number. Sharing bookingNumber or billOfLading is mandatory for port-to-port loads."
},
{
"name": "billOfLading",
"kind": "required",
"type": "string",
"description": "It indicates the bill of lading associated with the Ocean load. Sharing bookingNumber or billOfLading is mandatory for port-to-port loads. "
},
{
"name": "referenceNumbers",
"kind": "optional",
"type": "array",
"description": "It is the list of load level reference numbers associated with a load. (CM)"
},
{
"name": "stops",
"kind": "required",
"type": "object",
"description": "It is the list of stops for the load.",
"children": [
{
"name": "stopType",
"kind": "required",
"type": "string",
"description": "It defines the function of the stop. Valid values: \"portOfLoading\", \"transshipmentPort\", etc. "
},
{
"name": "customer",
"kind": "optional",
"type": "object",
"description": "It indicates the customer information for the stop. (CM)",
"children": [
{
"name": "id",
"kind": "optional",
"type": "string",
"description": "It is the unique identifier of the shipper's customer."
},
{
"name": "poNumbers",
"kind": "optional",
"type": "array",
"description": "It indicates the list of Customer PO Numbers associated with the load's stop. (CM)"
}
]
},
{
"name": "addressLine1",
"kind": "required",
"type": "string",
"description": "It indicates the first line of the stop's address."
},
{
"name": "city",
"kind": "required",
"type": "string",
"description": "It indicates the name of the city."
},
{
"name": "state",
"kind": "required",
"type": "string",
"description": "It indicates the 2 character state code for US & Canada and 3 Character state code for Mexico. "
},
{
"name": "country",
"kind": "optional",
"type": "string",
"description": "It indicates the valid country code. It is the 2 digit country code."
},
{
"name": "postalCode",
"kind": "optional",
"type": "string",
"description": "It indicates the valid postal code for the stop."
},
{
"name": "latitude",
"kind": "optional",
"type": "string",
"description": "It indicates the latitude of the stop's location."
},
{
"name": "longitude",
"kind": "optional",
"type": "string",
"description": "It indicates the longitude of the stop's location."
},
{
"name": "geofencePoints",
"kind": "optional",
"type": "array",
"description": "It indicates the list of lat/long coordinates of the corners of the polygon geofence around the stop to be used for detecting arrival."
},
{
"name": "externalAddressId",
"kind": "optional",
"type": "string",
"description": "It is the unique identifier of the address in FourKites. This ID is sent in place of address information. UNLOCODE is preferred for port stop creation in the FK platform."
},
{
"name": "appointmentTime",
"kind": "required",
"type": "string",
"description": "It indicates the scheduled appointment time at the stop in the stop's local time zone in ISO 8601 format. ISO 8601 format Appointment times cannot be more than 4 days in the past from the current time."
},
{
"name": "stopReferenceId",
"kind": "optional",
"type": "string",
"description": "It is the unique identifier of the stop from the customer's system. This populates the \"Reference #\" field on the stop and is used to indicate which stop an update is applied to. (CM)"
},
{
"name": "earliestAppointmentTime",
"kind": "required",
"type": "string",
"description": "It indicates the earliest scheduled arrival time at the stop in the stop's local time zone in ISO 8601 format. ISO 8601 format If earliestAppointmentTi me is sent, then latestAppointmentTime must also be sent."
},
{
"name": "latestAppointmentTime",
"kind": "required",
"type": "string",
"description": "It indicates the latest scheduled arrival time at the stop in the stop's local time zone in ISO 8601 format. ISO 8601 format If latestAppointmentTime is sent, then earliestAppointmentTi me must also be sent.vlatestAppointmentTime should be greater than or equal to earliestAppointmentTime."
},
{
"name": "wantTime",
"kind": "optional",
"type": "string",
"description": "It indicates the time by which the load must be delivered to the consignee in stop's local time zone in ISO 8601 format. (CM)"
},
{
"name": "productLineItems",
"kind": "optional",
"type": "object",
"description": "It is the list of product level details associated with a stop. Replaces the legacy pallets/parts structure going forward.",
"children": [
{
"name": "productId",
"kind": "required",
"type": "string",
"description": "Unique identifier for the product. Mandatory if productLineItems object is present"
},
{
"name": "productName",
"kind": "optional",
"type": "string",
"description": "Name of the product"
},
{
"name": "productDescription",
"kind": "optional",
"type": "string",
"description": "Detailed description of the product"
},
{
"name": "productCategory",
"kind": "optional",
"type": "string",
"description": "Category classification of the product"
},
{
"name": "quantity",
"kind": "optional",
"type": "integer",
"description": "Number of units in the shipment"
},
{
"name": "measurementUnitCode",
"kind": "optional",
"type": "string",
"description": "Unit of measurement for quantity (e.g., PCE, KG, LB)"
},
{
"name": "netWeight",
"kind": "optional",
"type": "string",
"description": "Weight of the product excluding packaging"
},
{
"name": "weightUnit",
"kind": "optional",
"type": "string",
"description": "Unit of measurement for weight (e.g., KGM, LBM)"
},
{
"name": "unitCost",
"kind": "optional",
"type": "number",
"description": "Cost per unit of the product"
},
{
"name": "currencyCode",
"kind": "optional",
"type": "string",
"description": "Currency code for cost fields"
},
{
"name": "extendedCost",
"kind": "optional",
"type": "number",
"description": "Total cost for all units (unitCost x quantity)"
},
{
"name": "freightCost",
"kind": "optional",
"type": "number",
"description": "Freight cost allocated to this line item"
},
{
"name": "bestBeforeDate",
"kind": "optional",
"type": "string",
"description": "Expiration or best before date for the product"
},
{
"name": "additionalCharges",
"kind": "optional",
"type": "number",
"description": "Any additional charges specific to this line item"
},
{
"name": "tariffCost",
"kind": "optional",
"type": "number",
"description": "Tariff cost for this specific line item"
},
{
"name": "fourKitesCalculatedTariffCost",
"kind": "optional",
"type": "number",
"description": "System-calculated tariff cost"
},
{
"name": "totalLandedCost",
"kind": "optional",
"type": "number",
"description": "Total landed cost for this line item"
},
{
"name": "countryOfOrigin",
"kind": "optional",
"type": "string",
"description": "Country of origin for this product"
},
{
"name": "harmonizedSystemCode",
"kind": "optional",
"type": "string",
"description": "International trade classification code"
},
{
"name": "commodityTypeCode",
"kind": "optional",
"type": "string",
"description": "Commodity classification code"
},
{
"name": "htsusCode",
"kind": "optional",
"type": "string",
"description": "Harmonized Tariff Schedule code for US imports"
},
{
"name": "orderNumber",
"kind": "optional",
"type": "string",
"description": "Purchase order number"
},
{
"name": "deliveryNumber",
"kind": "optional",
"type": "string",
"description": "Delivery reference number"
},
{
"name": "handlingUnitId",
"kind": "optional",
"type": "string",
"description": "Identifier for the handling unit (pallet, box, etc.)"
},
{
"name": "barcode",
"kind": "optional",
"type": "string",
"description": "Product barcode"
},
{
"name": "containerType",
"kind": "optional",
"type": "string",
"description": "Type of container (pallet, box, carton, etc.)"
},
{
"name": "gtin",
"kind": "optional",
"type": "string",
"description": "Global Trade Item Number"
},
{
"name": "customerPartNumber",
"kind": "optional",
"type": "string",
"description": "Customer's part number for the product"
},
{
"name": "supplierPartNumber",
"kind": "optional",
"type": "string",
"description": "Supplier's part number for the product"
},
{
"name": "manufacturerPartNumber",
"kind": "optional",
"type": "string",
"description": "Manufacturer's part number"
},
{
"name": "itemNumber",
"kind": "optional",
"type": "string",
"description": "Internal item number"
},
{
"name": "productUpc",
"kind": "optional",
"type": "string",
"description": "Universal Product Code"
},
{
"name": "deliveryReferences",
"kind": "optional",
"type": "string",
"description": "Array of delivery reference numbers"
},
{
"name": "orderReferences",
"kind": "optional",
"type": "string",
"description": "Array of order reference numbers"
},
{
"name": "brandName",
"kind": "optional",
"type": "string",
"description": "Brand name of the product"
},
{
"name": "minimumTemperature",
"kind": "optional",
"type": "integer",
"description": "Minimum storage/transport temperature"
},
{
"name": "maximumTemperature",
"kind": "optional",
"type": "integer",
"description": "Maximum storage/transport temperature"
},
{
"name": "temperatureUnitCode",
"kind": "optional",
"type": "string",
"description": "Temperature unit (cel, fah)"
},
{
"name": "labelIdentifier",
"kind": "optional",
"type": "string",
"description": "Label identifier for tracking"
},
{
"name": "productTrackingNumber",
"kind": "optional",
"type": "string",
"description": "Unique tracking number for the product"
},
{
"name": "deviceType",
"kind": "optional",
"type": "string",
"description": "Type of tracking device (RFID_TAG, QR_CODE, etc.)"
}
]
}
]
}
],
"schema": [
{
"name": "loadNumber",
"kind": "required",
"type": "string",
"description": "It is the unique load identifier from shipper's system. The load Number or BOL is an important piece of information used to link the load with truck information received from the Carrier's TMS."
},
{
"name": "priority",
"kind": "optional",
"type": "string",
"description": "It indicates whether a load is of normal or high priority. If priority is set as ‘hot’, the load will be marked as ‘Hot’. Valid values: ‘normal’, ‘high’ and ‘hot’. Defaults to normal. Setting the 'Priority' as 'hot' will mark the load as 'Hot' load."
},
{
"name": "operatingCarrierScac",
"kind": "optional",
"type": "string",
"description": "SCAC or code of the operating carrier if setting up managing/operating carrier"
},
{
"name": "carrier",
"kind": "required",
"type": "string",
"description": "It is the SCAC or Service Provider ID of the carrier assigned to the load. The carrier should have approved sharing of their telematics data on FourKites® for the customer."
},
{
"name": "products",
"kind": "optional",
"type": "object",
"description": "It indicates the list of temperature tracked products on a load and their temperature tracking information.",
"children": []
},
{
"name": "bookingNumber",
"kind": "required",
"type": "string",
"description": "It indicates the shipping line's booking number. Sharing bookingNumber or billOfLading is mandatory for port-to-port loads."
},
{
"name": "billOfLading",
"kind": "required",
"type": "string",
"description": "It indicates the bill of lading associated with the Ocean load. Sharing bookingNumber or billOfLading is mandatory for port-to-port loads. "
},
{
"name": "referenceNumbers",
"kind": "optional",
"type": "array",
"description": "It is the list of load level reference numbers associated with a load. (CM)"
},
{
"name": "stops",
"kind": "required",
"type": "object",
"description": "It is the list of stops for the load.",
"children": [
{
"name": "stopType",
"kind": "required",
"type": "string",
"description": "It defines the function of the stop. Valid values: \"portOfLoading\", \"transshipmentPort\", etc. "
},
{
"name": "customer",
"kind": "optional",
"type": "object",
"description": "It indicates the customer information for the stop. (CM)",
"children": [
{
"name": "id",
"kind": "optional",
"type": "string",
"description": "It is the unique identifier of the shipper's customer."
},
{
"name": "poNumbers",
"kind": "optional",
"type": "array",
"description": "It indicates the list of Customer PO Numbers associated with the load's stop. (CM)"
}
]
},
{
"name": "addressLine1",
"kind": "required",
"type": "string",
"description": "It indicates the first line of the stop's address."
},
{
"name": "city",
"kind": "required",
"type": "string",
"description": "It indicates the name of the city."
},
{
"name": "state",
"kind": "required",
"type": "string",
"description": "It indicates the 2 character state code for US & Canada and 3 Character state code for Mexico. "
},
{
"name": "country",
"kind": "optional",
"type": "string",
"description": "It indicates the valid country code. It is the 2 digit country code."
},
{
"name": "postalCode",
"kind": "optional",
"type": "string",
"description": "It indicates the valid postal code for the stop."
},
{
"name": "latitude",
"kind": "optional",
"type": "string",
"description": "It indicates the latitude of the stop's location."
},
{
"name": "longitude",
"kind": "optional",
"type": "string",
"description": "It indicates the longitude of the stop's location."
},
{
"name": "geofencePoints",
"kind": "optional",
"type": "array",
"description": "It indicates the list of lat/long coordinates of the corners of the polygon geofence around the stop to be used for detecting arrival."
},
{
"name": "externalAddressId",
"kind": "optional",
"type": "string",
"description": "It is the unique identifier of the address in FourKites. This ID is sent in place of address information. UNLOCODE is preferred for port stop creation in the FK platform."
},
{
"name": "appointmentTime",
"kind": "required",
"type": "string",
"description": "It indicates the scheduled appointment time at the stop in the stop's local time zone in ISO 8601 format. ISO 8601 format Appointment times cannot be more than 4 days in the past from the current time."
},
{
"name": "stopReferenceId",
"kind": "optional",
"type": "string",
"description": "It is the unique identifier of the stop from the customer's system. This populates the \"Reference #\" field on the stop and is used to indicate which stop an update is applied to. (CM)"
},
{
"name": "earliestAppointmentTime",
"kind": "required",
"type": "string",
"description": "It indicates the earliest scheduled arrival time at the stop in the stop's local time zone in ISO 8601 format. ISO 8601 format If earliestAppointmentTi me is sent, then latestAppointmentTime must also be sent."
},
{
"name": "latestAppointmentTime",
"kind": "required",
"type": "string",
"description": "It indicates the latest scheduled arrival time at the stop in the stop's local time zone in ISO 8601 format. ISO 8601 format If latestAppointmentTime is sent, then earliestAppointmentTi me must also be sent.vlatestAppointmentTime should be greater than or equal to earliestAppointmentTime."
},
{
"name": "wantTime",
"kind": "optional",
"type": "string",
"description": "It indicates the time by which the load must be delivered to the consignee in stop's local time zone in ISO 8601 format. (CM)"
},
{
"name": "productLineItems",
"kind": "optional",
"type": "object",
"description": "It is the list of product level details associated with a stop. Replaces the legacy pallets/parts structure going forward.",
"children": [
{
"name": "productId",
"kind": "required",
"type": "string",
"description": "Unique identifier for the product. Mandatory if productLineItems object is present"
},
{
"name": "productName",
"kind": "optional",
"type": "string",
"description": "Name of the product"
},
{
"name": "productDescription",
"kind": "optional",
"type": "string",
"description": "Detailed description of the product"
},
{
"name": "productCategory",
"kind": "optional",
"type": "string",
"description": "Category classification of the product"
},
{
"name": "quantity",
"kind": "optional",
"type": "integer",
"description": "Number of units in the shipment"
},
{
"name": "measurementUnitCode",
"kind": "optional",
"type": "string",
"description": "Unit of measurement for quantity (e.g., PCE, KG, LB)"
},
{
"name": "netWeight",
"kind": "optional",
"type": "string",
"description": "Weight of the product excluding packaging"
},
{
"name": "weightUnit",
"kind": "optional",
"type": "string",
"description": "Unit of measurement for weight (e.g., KGM, LBM)"
},
{
"name": "unitCost",
"kind": "optional",
"type": "number",
"description": "Cost per unit of the product"
},
{
"name": "currencyCode",
"kind": "optional",
"type": "string",
"description": "Currency code for cost fields"
},
{
"name": "extendedCost",
"kind": "optional",
"type": "number",
"description": "Total cost for all units (unitCost x quantity)"
},
{
"name": "freightCost",
"kind": "optional",
"type": "number",
"description": "Freight cost allocated to this line item"
},
{
"name": "bestBeforeDate",
"kind": "optional",
"type": "string",
"description": "Expiration or best before date for the product"
},
{
"name": "additionalCharges",
"kind": "optional",
"type": "number",
"description": "Any additional charges specific to this line item"
},
{
"name": "tariffCost",
"kind": "optional",
"type": "number",
"description": "Tariff cost for this specific line item"
},
{
"name": "fourKitesCalculatedTariffCost",
"kind": "optional",
"type": "number",
"description": "System-calculated tariff cost"
},
{
"name": "totalLandedCost",
"kind": "optional",
"type": "number",
"description": "Total landed cost for this line item"
},
{
"name": "countryOfOrigin",
"kind": "optional",
"type": "string",
"description": "Country of origin for this product"
},
{
"name": "harmonizedSystemCode",
"kind": "optional",
"type": "string",
"description": "International trade classification code"
},
{
"name": "commodityTypeCode",
"kind": "optional",
"type": "string",
"description": "Commodity classification code"
},
{
"name": "htsusCode",
"kind": "optional",
"type": "string",
"description": "Harmonized Tariff Schedule code for US imports"
},
{
"name": "orderNumber",
"kind": "optional",
"type": "string",
"description": "Purchase order number"
},
{
"name": "deliveryNumber",
"kind": "optional",
"type": "string",
"description": "Delivery reference number"
},
{
"name": "handlingUnitId",
"kind": "optional",
"type": "string",
"description": "Identifier for the handling unit (pallet, box, etc.)"
},
{
"name": "barcode",
"kind": "optional",
"type": "string",
"description": "Product barcode"
},
{
"name": "containerType",
"kind": "optional",
"type": "string",
"description": "Type of container (pallet, box, carton, etc.)"
},
{
"name": "gtin",
"kind": "optional",
"type": "string",
"description": "Global Trade Item Number"
},
{
"name": "customerPartNumber",
"kind": "optional",
"type": "string",
"description": "Customer's part number for the product"
},
{
"name": "supplierPartNumber",
"kind": "optional",
"type": "string",
"description": "Supplier's part number for the product"
},
{
"name": "manufacturerPartNumber",
"kind": "optional",
"type": "string",
"description": "Manufacturer's part number"
},
{
"name": "itemNumber",
"kind": "optional",
"type": "string",
"description": "Internal item number"
},
{
"name": "productUpc",
"kind": "optional",
"type": "string",
"description": "Universal Product Code"
},
{
"name": "deliveryReferences",
"kind": "optional",
"type": "string",
"description": "Array of delivery reference numbers"
},
{
"name": "orderReferences",
"kind": "optional",
"type": "string",
"description": "Array of order reference numbers"
},
{
"name": "brandName",
"kind": "optional",
"type": "string",
"description": "Brand name of the product"
},
{
"name": "minimumTemperature",
"kind": "optional",
"type": "integer",
"description": "Minimum storage/transport temperature"
},
{
"name": "maximumTemperature",
"kind": "optional",
"type": "integer",
"description": "Maximum storage/transport temperature"
},
{
"name": "temperatureUnitCode",
"kind": "optional",
"type": "string",
"description": "Temperature unit (cel, fah)"
},
{
"name": "labelIdentifier",
"kind": "optional",
"type": "string",
"description": "Label identifier for tracking"
},
{
"name": "productTrackingNumber",
"kind": "optional",
"type": "string",
"description": "Unique tracking number for the product"
},
{
"name": "deviceType",
"kind": "optional",
"type": "string",
"description": "Type of tracking device (RFID_TAG, QR_CODE, etc.)"
}
]
}
]
}
]
}
],
"formDataParameters": []
},
"currentNewParameter": {
"label": "Body Parameter",
"value": "bodyDataParameters"
},
"hasTryItOut": false,
"autoGeneratedAnchorSlug": "production",
"legacyHash": "-HX_rYm2qdFOSnDW5xZtD"
}
```
:::
:::ApiMethodV2
```json
{
"name": "Staging",
"method": "POST",
"url": "https://api-staging.fourkites.com/api/v1/tracking",
"description": "",
"tab": "examples",
"examples": {
"languages": [
{
"id": "oXTLt8IGOBlfw2e4XGI96",
"language": "curl",
"code": "curl --location --request POST 'https://api-staging.fourkites.com/api/v1/tracking' \\\n--header 'Content-Type: application/json' \\\n--header 'apikey: REPLACE_KEY_VALUE' \\\n--data-raw '{\n \"trackingInfo\": {\n \"driverPhone\": \"\",\n \"truckNumber\": \"\",\n \"vesselName\": \"\",\n \"imo\": \"\",\n \"mmsi\": \"\",\n \"containerNumber\": \"OOLU4404637\"\n },\n \"containerInfo\": {\n \"containerNumber\": \"OOLU4404637\"\n },\n \"load\": {\n \"loadNumber\": \"stop_completion_1\",\n \"priority\": \"normal\",\n \"operatingCarrierScac\": null,\n \"carrier\": \"1234\",\n \"carrierName\": \"\",\n \"carrierPermalink\": \"oceancarrier\",\n \"products\": [],\n \"bookingNumber\": \"\",\n \"trackingNumber\": \"\",\n \"billOfLading\": \"GOA230437868\",\n \"referenceNumbers\": [],\n \"stops\": [\n {\n \"stopType\": \"portOfLoading\",\n \"customer\": {\n \"id\": null,\n \"originalCustomerId\": null,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"INMAA\",\n \"appointmentTime\": null,\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": null,\n \"latestAppointmentTime\": null,\n \"estimatedDepartureTime\": \"2023-07-20T06:00:00\",\n \"wantTime\": null,\n \"productLineItems\": [\n {\n \"productId\": \"0123456\",\n \"productName\": \"Ocean Freight Item\",\n \"productDescription\": \"Port-to-port ocean shipment item\",\n \"productCategory\": \"General Freight\",\n \"quantity\": 25,\n \"measurementUnitCode\": \"PCE\",\n \"netWeight\": 44.8,\n \"weightUnit\": \"KGM\",\n \"unitCost\": 25.0,\n \"currencyCode\": \"USD\",\n \"extendedCost\": 625.00,\n \"freightCost\": 20.00,\n \"additionalCharges\": 5.00,\n \"tariffCost\": 2.50,\n \"fourKitesCalculatedTariffCost\": 2.50,\n \"totalLandedCost\": 655.00,\n \"countryOfOrigin\": \"IN\",\n \"harmonizedSystemCode\": \"8471499000\",\n \"commodityTypeCode\": \"OCEAN_FREIGHT\",\n \"htsusCode\": \"8471499000\",\n \"orderNumber\": \"GOA230437868\",\n \"deliveryNumber\": \"DN-INMAA\",\n \"handlingUnitId\": \"PAL-INMAA\",\n \"barcode\": \"PALINMAA\",\n \"containerType\": \"pallet\",\n \"gtin\": \"00012345678905\",\n \"customerPartNumber\": \"22EE\",\n \"supplierPartNumber\": \"22EE\",\n \"manufacturerPartNumber\": \"MFG-22EE\",\n \"itemNumber\": \"ITM-22EE\",\n \"productUpc\": \"012345678905\",\n \"deliveryReferences\": [\"OOLU4404637\"],\n \"orderReferences\": [\"GOA230437868\"],\n \"brandName\": \"Generic Ocean Freight Co\",\n \"minimumTemperature\": 0,\n \"maximumTemperature\": 0,\n \"temperatureUnitCode\": \"cel\",\n \"labelIdentifier\": \"LBL-22EE\",\n \"productTrackingNumber\": \"OOLU4404637-1\",\n \"deviceType\": \"RFID_TAG\"\n }\n ]\n },\n {\n \"stopType\": \"transshipmentPort\",\n \"customer\": {\n \"id\": null,\n \"originalCustomerId\": null,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"SGSIN\",\n \"appointmentTime\": null,\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": \"2023-07-21T06:00:00\",\n \"latestAppointmentTime\": \"2023-07-21T16:00:00\",\n \"wantTime\": null,\n \"productLineItems\": [\n {\n \"productId\": \"0123456\",\n \"productName\": \"Ocean Freight Item\",\n \"productDescription\": \"Port-to-port ocean shipment item\",\n \"productCategory\": \"General Freight\",\n \"quantity\": 25,\n \"measurementUnitCode\": \"PCE\",\n \"netWeight\": 44.8,\n \"weightUnit\": \"KGM\",\n \"unitCost\": 25.0,\n \"currencyCode\": \"USD\",\n \"extendedCost\": 625.00,\n \"freightCost\": 20.00,\n \"additionalCharges\": 5.00,\n \"tariffCost\": 2.50,\n \"fourKitesCalculatedTariffCost\": 2.50,\n \"totalLandedCost\": 655.00,\n \"countryOfOrigin\": \"IN\",\n \"harmonizedSystemCode\": \"8471499000\",\n \"commodityTypeCode\": \"OCEAN_FREIGHT\",\n \"htsusCode\": \"8471499000\",\n \"orderNumber\": \"GOA230437868\",\n \"deliveryNumber\": \"DN-INMAA\",\n \"handlingUnitId\": \"PAL-INMAA\",\n \"barcode\": \"PALINMAA\",\n \"containerType\": \"pallet\",\n \"gtin\": \"00012345678905\",\n \"customerPartNumber\": \"22EE\",\n \"supplierPartNumber\": \"22EE\",\n \"manufacturerPartNumber\": \"MFG-22EE\",\n \"itemNumber\": \"ITM-22EE\",\n \"productUpc\": \"012345678905\",\n \"deliveryReferences\": [\"OOLU4404637\"],\n \"orderReferences\": [\"GOA230437868\"],\n \"brandName\": \"Generic Ocean Freight Co\",\n \"minimumTemperature\": 0,\n \"maximumTemperature\": 0,\n \"temperatureUnitCode\": \"cel\",\n \"labelIdentifier\": \"LBL-22EE\",\n \"productTrackingNumber\": \"OOLU4404637-1\",\n \"deviceType\": \"RFID_TAG\"\n }\n ]\n },\n {\n \"stopType\": \"portOfDischarge\",\n \"customer\": {\n \"id\": null,\n \"originalCustomerId\": null,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"USJAX\",\n \"appointmentTime\": \"2024-03-31T16:00:00\",\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": null,\n \"latestAppointmentTime\": null,\n \"wantTime\": null,\n \"productLineItems\": [\n {\n \"productId\": \"0123456\",\n \"productName\": \"Ocean Freight Item\",\n \"productDescription\": \"Port-to-port ocean shipment item\",\n \"productCategory\": \"General Freight\",\n \"quantity\": 25,\n \"measurementUnitCode\": \"PCE\",\n \"netWeight\": 44.8,\n \"weightUnit\": \"KGM\",\n \"unitCost\": 25.0,\n \"currencyCode\": \"USD\",\n \"extendedCost\": 625.00,\n \"freightCost\": 20.00,\n \"additionalCharges\": 5.00,\n \"tariffCost\": 2.50,\n \"fourKitesCalculatedTariffCost\": 2.50,\n \"totalLandedCost\": 655.00,\n \"countryOfOrigin\": \"IN\",\n \"harmonizedSystemCode\": \"8471499000\",\n \"commodityTypeCode\": \"OCEAN_FREIGHT\",\n \"htsusCode\": \"8471499000\",\n \"orderNumber\": \"GOA230437868\",\n \"deliveryNumber\": \"DN-USJAX\",\n \"handlingUnitId\": \"PAL-USJAX\",\n \"barcode\": \"PALUSJAX\",\n \"containerType\": \"pallet\",\n \"gtin\": \"00012345678905\",\n \"customerPartNumber\": \"22EE\",\n \"supplierPartNumber\": \"22EE\",\n \"manufacturerPartNumber\": \"MFG-22EE\",\n \"itemNumber\": \"ITM-22EE\",\n \"productUpc\": \"012345678905\",\n \"deliveryReferences\": [\"OOLU4404637\"],\n \"orderReferences\": [\"GOA230437868\"],\n \"brandName\": \"Generic Ocean Freight Co\",\n \"minimumTemperature\": 0,\n \"maximumTemperature\": 0,\n \"temperatureUnitCode\": \"cel\",\n \"labelIdentifier\": \"LBL-22EE\",\n \"productTrackingNumber\": \"OOLU4404637-3\",\n \"deviceType\": \"QR_CODE\"\n }\n ]\n }\n ]\n }\n}'",
"customLabel": ""
},
{
"id": "R9fUapNeQ5A5Ft6WMmxI2",
"language": "java",
"code": "OkHttpClient client = new OkHttpClient().newBuilder()\n .build();\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\n \\\"trackingInfo\\\": {\\n \\\"driverPhone\\\": \\\"\\\",\\n \\\"truckNumber\\\": \\\"\\\",\\n \\\"vesselName\\\": \\\"\\\",\\n \\\"imo\\\": \\\"\\\",\\n \\\"mmsi\\\": \\\"\\\",\\n \\\"containerNumber\\\": \\\"OOLU4404637\\\"\\n },\\n \\\"containerInfo\\\": {\\n \\\"containerNumber\\\": \\\"OOLU4404637\\\"\\n },\\n \\\"load\\\": {\\n \\\"loadNumber\\\": \\\"stop_completion_1\\\",\\n \\\"priority\\\": \\\"normal\\\",\\n \\\"operatingCarrierScac\\\": null,\\n \\\"carrier\\\": \\\"1234\\\",\\n \\\"carrierName\\\": \\\"\\\",\\n \\\"carrierPermalink\\\": \\\"oceancarrier\\\",\\n \\\"products\\\": [],\\n \\\"bookingNumber\\\": \\\"\\\",\\n \\\"trackingNumber\\\": \\\"\\\",\\n \\\"billOfLading\\\": \\\"GOA230437868\\\",\\n \\\"referenceNumbers\\\": [],\\n \\\"stops\\\": [\\n {\\n \\\"stopType\\\": \\\"portOfLoading\\\",\\n \\\"customer\\\": {\\n \\\"id\\\": null,\\n \\\"originalCustomerId\\\": null,\\n \\\"poNumbers\\\": []\\n },\\n \\\"addressLine1\\\": \\\"\\\",\\n \\\"city\\\": \\\"\\\",\\n \\\"state\\\": \\\"\\\",\\n \\\"country\\\": \\\"\\\",\\n \\\"postalCode\\\": \\\"\\\",\\n \\\"latitude\\\": \\\"\\\",\\n \\\"longitude\\\": \\\"\\\",\\n \\\"geofencePoints\\\": [],\\n \\\"externalAddressId\\\": \\\"INMAA\\\",\\n \\\"appointmentTime\\\": null,\\n \\\"stopReferenceId\\\": \\\"\\\",\\n \\\"earliestAppointmentTime\\\": null,\\n \\\"latestAppointmentTime\\\": null,\\n \\\"estimatedDepartureTime\\\": \\\"2023-07-20T06:00:00\\\",\\n \\\"wantTime\\\": null\\n },\\n {\\n \\\"stopType\\\": \\\"transshipmentPort\\\",\\n \\\"customer\\\": {\\n \\\"id\\\": null,\\n \\\"originalCustomerId\\\": null,\\n \\\"poNumbers\\\": []\\n },\\n \\\"addressLine1\\\": \\\"\\\",\\n \\\"city\\\": \\\"\\\",\\n \\\"state\\\": \\\"\\\",\\n \\\"country\\\": \\\"\\\",\\n \\\"postalCode\\\": \\\"\\\",\\n \\\"latitude\\\": \\\"\\\",\\n \\\"longitude\\\": \\\"\\\",\\n \\\"geofencePoints\\\": [],\\n \\\"externalAddressId\\\": \\\"SGSIN\\\",\\n \\\"appointmentTime\\\": null,\\n \\\"stopReferenceId\\\": \\\"\\\",\\n \\\"earliestAppointmentTime\\\": \\\"2023-07-21T06:00:00\\\",\\n \\\"latestAppointmentTime\\\": \\\"2023-07-21T16:00:00\\\",\\n \\\"wantTime\\\": null\\n },\\n {\\n \\\"stopType\\\": \\\"portOfDischarge\\\",\\n \\\"customer\\\": {\\n \\\"id\\\": null,\\n \\\"originalCustomerId\\\": null,\\n \\\"poNumbers\\\": []\\n },\\n \\\"addressLine1\\\": \\\"\\\",\\n \\\"city\\\": \\\"\\\",\\n \\\"state\\\": \\\"\\\",\\n \\\"country\\\": \\\"\\\",\\n \\\"postalCode\\\": \\\"\\\",\\n \\\"latitude\\\": \\\"\\\",\\n \\\"longitude\\\": \\\"\\\",\\n \\\"geofencePoints\\\": [],\\n \\\"externalAddressId\\\": \\\"USJAX\\\",\\n \\\"appointmentTime\\\": \\\"2024-03-31T16:00:00\\\",\\n \\\"stopReferenceId\\\": \\\"\\\",\\n \\\"earliestAppointmentTime\\\": null,\\n \\\"latestAppointmentTime\\\": null,\\n \\\"wantTime\\\": null\\n }\\n ]\\n }\\n}\");\nRequest request = new Request.Builder()\n .url(\"https://api-staging.fourkites.com/api/v1/tracking\")\n .method(\"POST\", body)\n .addHeader(\"Content-Type\", \"application/json\")\n .addHeader(\"apikey\", \"REPLACE_KEY_VALUE\")\n .build();\nResponse response = client.newCall(request).execute();",
"customLabel": ""
},
{
"id": "qT5uNZIqgUvY8TitfBixf",
"language": "javascript",
"code": "var settings = {\n \"url\": \"https://api-staging.fourkites.com/api/v1/tracking\",\n \"method\": \"POST\",\n \"timeout\": 0,\n \"headers\": {\n \"Content-Type\": \"application/json\",\n \"apikey\": \"REPLACE_KEY_VALUE\"\n },\n \"data\": JSON.stringify({\n \"trackingInfo\": {\n \"driverPhone\": \"\",\n \"truckNumber\": \"\",\n \"vesselName\": \"\",\n \"imo\": \"\",\n \"mmsi\": \"\",\n \"containerNumber\": \"OOLU4404637\"\n },\n \"containerInfo\": {\n \"containerNumber\": \"OOLU4404637\"\n },\n \"load\": {\n \"loadNumber\": \"stop_completion_1\",\n \"priority\": \"normal\",\n \"operatingCarrierScac\": null,\n \"carrier\": \"1234\",\n \"carrierName\": \"\",\n \"carrierPermalink\": \"oceancarrier\",\n \"products\": [],\n \"bookingNumber\": \"\",\n \"trackingNumber\": \"\",\n \"billOfLading\": \"GOA230437868\",\n \"referenceNumbers\": [],\n \"stops\": [\n {\n \"stopType\": \"portOfLoading\",\n \"customer\": {\n \"id\": null,\n \"originalCustomerId\": null,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"INMAA\",\n \"appointmentTime\": null,\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": null,\n \"latestAppointmentTime\": null,\n \"estimatedDepartureTime\": \"2023-07-20T06:00:00\",\n \"wantTime\": null\n },\n {\n \"stopType\": \"transshipmentPort\",\n \"customer\": {\n \"id\": null,\n \"originalCustomerId\": null,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"SGSIN\",\n \"appointmentTime\": null,\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": \"2023-07-21T06:00:00\",\n \"latestAppointmentTime\": \"2023-07-21T16:00:00\",\n \"wantTime\": null\n },\n {\n \"stopType\": \"portOfDischarge\",\n \"customer\": {\n \"id\": null,\n \"originalCustomerId\": null,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"USJAX\",\n \"appointmentTime\": \"2024-03-31T16:00:00\",\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": null,\n \"latestAppointmentTime\": null,\n \"wantTime\": null\n }\n ]\n }\n }),\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});",
"customLabel": ""
},
{
"id": "mViRMiSR81WSzY3jgFUSE",
"language": "swift",
"code": "import Foundation\n#if canImport(FoundationNetworking)\nimport FoundationNetworking\n#endif\n\nvar semaphore = DispatchSemaphore (value: 0)\n\nlet parameters = \"{\\n \\\"trackingInfo\\\": {\\n \\\"driverPhone\\\": \\\"\\\",\\n \\\"truckNumber\\\": \\\"\\\",\\n \\\"vesselName\\\": \\\"\\\",\\n \\\"imo\\\": \\\"\\\",\\n \\\"mmsi\\\": \\\"\\\",\\n \\\"containerNumber\\\": \\\"OOLU4404637\\\"\\n },\\n \\\"containerInfo\\\": {\\n \\\"containerNumber\\\": \\\"OOLU4404637\\\"\\n },\\n \\\"load\\\": {\\n \\\"loadNumber\\\": \\\"stop_completion_1\\\",\\n \\\"priority\\\": \\\"normal\\\",\\n \\\"operatingCarrierScac\\\": null,\\n \\\"carrier\\\": \\\"1234\\\",\\n \\\"carrierName\\\": \\\"\\\",\\n \\\"carrierPermalink\\\": \\\"oceancarrier\\\",\\n \\\"products\\\": [],\\n \\\"bookingNumber\\\": \\\"\\\",\\n \\\"trackingNumber\\\": \\\"\\\",\\n \\\"billOfLading\\\": \\\"GOA230437868\\\",\\n \\\"referenceNumbers\\\": [],\\n \\\"stops\\\": [\\n {\\n \\\"stopType\\\": \\\"portOfLoading\\\",\\n \\\"customer\\\": {\\n \\\"id\\\": null,\\n \\\"originalCustomerId\\\": null,\\n \\\"poNumbers\\\": []\\n },\\n \\\"addressLine1\\\": \\\"\\\",\\n \\\"city\\\": \\\"\\\",\\n \\\"state\\\": \\\"\\\",\\n \\\"country\\\": \\\"\\\",\\n \\\"postalCode\\\": \\\"\\\",\\n \\\"latitude\\\": \\\"\\\",\\n \\\"longitude\\\": \\\"\\\",\\n \\\"geofencePoints\\\": [],\\n \\\"externalAddressId\\\": \\\"INMAA\\\",\\n \\\"appointmentTime\\\": null,\\n \\\"stopReferenceId\\\": \\\"\\\",\\n \\\"earliestAppointmentTime\\\": null,\\n \\\"latestAppointmentTime\\\": null,\\n \\\"estimatedDepartureTime\\\": \\\"2023-07-20T06:00:00\\\",\\n \\\"wantTime\\\": null\\n },\\n {\\n \\\"stopType\\\": \\\"transshipmentPort\\\",\\n \\\"customer\\\": {\\n \\\"id\\\": null,\\n \\\"originalCustomerId\\\": null,\\n \\\"poNumbers\\\": []\\n },\\n \\\"addressLine1\\\": \\\"\\\",\\n \\\"city\\\": \\\"\\\",\\n \\\"state\\\": \\\"\\\",\\n \\\"country\\\": \\\"\\\",\\n \\\"postalCode\\\": \\\"\\\",\\n \\\"latitude\\\": \\\"\\\",\\n \\\"longitude\\\": \\\"\\\",\\n \\\"geofencePoints\\\": [],\\n \\\"externalAddressId\\\": \\\"SGSIN\\\",\\n \\\"appointmentTime\\\": null,\\n \\\"stopReferenceId\\\": \\\"\\\",\\n \\\"earliestAppointmentTime\\\": \\\"2023-07-21T06:00:00\\\",\\n \\\"latestAppointmentTime\\\": \\\"2023-07-21T16:00:00\\\",\\n \\\"wantTime\\\": null\\n },\\n {\\n \\\"stopType\\\": \\\"portOfDischarge\\\",\\n \\\"customer\\\": {\\n \\\"id\\\": null,\\n \\\"originalCustomerId\\\": null,\\n \\\"poNumbers\\\": []\\n },\\n \\\"addressLine1\\\": \\\"\\\",\\n \\\"city\\\": \\\"\\\",\\n \\\"state\\\": \\\"\\\",\\n \\\"country\\\": \\\"\\\",\\n \\\"postalCode\\\": \\\"\\\",\\n \\\"latitude\\\": \\\"\\\",\\n \\\"longitude\\\": \\\"\\\",\\n \\\"geofencePoints\\\": [],\\n \\\"externalAddressId\\\": \\\"USJAX\\\",\\n \\\"appointmentTime\\\": \\\"2024-03-31T16:00:00\\\",\\n \\\"stopReferenceId\\\": \\\"\\\",\\n \\\"earliestAppointmentTime\\\": null,\\n \\\"latestAppointmentTime\\\": null,\\n \\\"wantTime\\\": null\\n }\\n ]\\n }\\n}\"\nlet postData = parameters.data(using: .utf8)\n\nvar request = URLRequest(url: URL(string: \"https://api-staging.fourkites.com/api/v1/tracking\")!,timeoutInterval: Double.infinity)\nrequest.addValue(\"application/json\", forHTTPHeaderField: \"Content-Type\")\nrequest.addValue(\"REPLACE_KEY_VALUE\", 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 semaphore.signal()\n return\n }\n print(String(data: data, encoding: .utf8)!)\n semaphore.signal()\n}\n\ntask.resume()\nsemaphore.wait()\n",
"customLabel": ""
},
{
"id": "jzpSj1-UF6Wq5Uwg3WWQY",
"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/api/v1/tracking\"\n method := \"POST\"\n\n payload := strings.NewReader(`{\n \"trackingInfo\": {\n \"driverPhone\": \"\",\n \"truckNumber\": \"\",\n \"vesselName\": \"\",\n \"imo\": \"\",\n \"mmsi\": \"\",\n \"containerNumber\": \"OOLU4404637\"\n },\n \"containerInfo\": {\n \"containerNumber\": \"OOLU4404637\"\n },\n \"load\": {\n \"loadNumber\": \"stop_completion_1\",\n \"priority\": \"normal\",\n \"operatingCarrierScac\": null,\n \"carrier\": \"1234\",\n \"carrierName\": \"\",\n \"carrierPermalink\": \"oceancarrier\",\n \"products\": [],\n \"bookingNumber\": \"\",\n \"trackingNumber\": \"\",\n \"billOfLading\": \"GOA230437868\",\n \"referenceNumbers\": [],\n \"stops\": [\n {\n \"stopType\": \"portOfLoading\",\n \"customer\": {\n \"id\": null,\n \"originalCustomerId\": null,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"INMAA\",\n \"appointmentTime\": null,\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": null,\n \"latestAppointmentTime\": null,\n \"estimatedDepartureTime\": \"2023-07-20T06:00:00\",\n \"wantTime\": null\n },\n {\n \"stopType\": \"transshipmentPort\",\n \"customer\": {\n \"id\": null,\n \"originalCustomerId\": null,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"SGSIN\",\n \"appointmentTime\": null,\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": \"2023-07-21T06:00:00\",\n \"latestAppointmentTime\": \"2023-07-21T16:00:00\",\n \"wantTime\": null\n },\n {\n \"stopType\": \"portOfDischarge\",\n \"customer\": {\n \"id\": null,\n \"originalCustomerId\": null,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"USJAX\",\n \"appointmentTime\": \"2024-03-31T16:00:00\",\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": null,\n \"latestAppointmentTime\": null,\n \"wantTime\": null\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\", \"REPLACE_KEY_VALUE\")\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}",
"customLabel": ""
},
{
"id": "sGD0P46h2XeSoAQyeN5-Q",
"language": "csharp",
"code": "var client = new RestClient(\"https://api-staging.fourkites.com/api/v1/tracking\");\nclient.Timeout = -1;\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddHeader(\"apikey\", \"REPLACE_KEY_VALUE\");\nvar body = @\"{\" + \"\\n\" +\n@\" \"\"trackingInfo\"\": {\" + \"\\n\" +\n@\" \"\"driverPhone\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"truckNumber\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"vesselName\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"imo\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"mmsi\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"containerNumber\"\": \"\"OOLU4404637\"\"\" + \"\\n\" +\n@\" },\" + \"\\n\" +\n@\" \"\"containerInfo\"\": {\" + \"\\n\" +\n@\" \"\"containerNumber\"\": \"\"OOLU4404637\"\"\" + \"\\n\" +\n@\" },\" + \"\\n\" +\n@\" \"\"load\"\": {\" + \"\\n\" +\n@\" \"\"loadNumber\"\": \"\"stop_completion_1\"\",\" + \"\\n\" +\n@\" \"\"priority\"\": \"\"normal\"\",\" + \"\\n\" +\n@\" \"\"operatingCarrierScac\"\": null,\" + \"\\n\" +\n@\" \"\"carrier\"\": \"\"1234\"\",\" + \"\\n\" +\n@\" \"\"carrierName\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"carrierPermalink\"\": \"\"oceancarrier\"\",\" + \"\\n\" +\n@\" \"\"products\"\": [],\" + \"\\n\" +\n@\" \"\"bookingNumber\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"trackingNumber\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"billOfLading\"\": \"\"GOA230437868\"\",\" + \"\\n\" +\n@\" \"\"referenceNumbers\"\": [],\" + \"\\n\" +\n@\" \"\"stops\"\": [\" + \"\\n\" +\n@\" {\" + \"\\n\" +\n@\" \"\"stopType\"\": \"\"portOfLoading\"\",\" + \"\\n\" +\n@\" \"\"customer\"\": {\" + \"\\n\" +\n@\" \"\"id\"\": null,\" + \"\\n\" +\n@\" \"\"originalCustomerId\"\": null,\" + \"\\n\" +\n@\" \"\"poNumbers\"\": []\" + \"\\n\" +\n@\" },\" + \"\\n\" +\n@\" \"\"addressLine1\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"city\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"state\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"country\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"postalCode\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"latitude\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"longitude\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"geofencePoints\"\": [],\" + \"\\n\" +\n@\" \"\"externalAddressId\"\": \"\"INMAA\"\",\" + \"\\n\" +\n@\" \"\"appointmentTime\"\": null,\" + \"\\n\" +\n@\" \"\"stopReferenceId\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"earliestAppointmentTime\"\": null,\" + \"\\n\" +\n@\" \"\"latestAppointmentTime\"\": null,\" + \"\\n\" +\n@\" \"\"estimatedDepartureTime\"\": \"\"2023-07-20T06:00:00\"\",\" + \"\\n\" +\n@\" \"\"wantTime\"\": null\" + \"\\n\" +\n@\" },\" + \"\\n\" +\n@\" {\" + \"\\n\" +\n@\" \"\"stopType\"\": \"\"transshipmentPort\"\",\" + \"\\n\" +\n@\" \"\"customer\"\": {\" + \"\\n\" +\n@\" \"\"id\"\": null,\" + \"\\n\" +\n@\" \"\"originalCustomerId\"\": null,\" + \"\\n\" +\n@\" \"\"poNumbers\"\": []\" + \"\\n\" +\n@\" },\" + \"\\n\" +\n@\" \"\"addressLine1\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"city\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"state\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"country\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"postalCode\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"latitude\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"longitude\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"geofencePoints\"\": [],\" + \"\\n\" +\n@\" \"\"externalAddressId\"\": \"\"SGSIN\"\",\" + \"\\n\" +\n@\" \"\"appointmentTime\"\": null,\" + \"\\n\" +\n@\" \"\"stopReferenceId\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"earliestAppointmentTime\"\": \"\"2023-07-21T06:00:00\"\",\" + \"\\n\" +\n@\" \"\"latestAppointmentTime\"\": \"\"2023-07-21T16:00:00\"\",\" + \"\\n\" +\n@\" \"\"wantTime\"\": null\" + \"\\n\" +\n@\" },\" + \"\\n\" +\n@\" {\" + \"\\n\" +\n@\" \"\"stopType\"\": \"\"portOfDischarge\"\",\" + \"\\n\" +\n@\" \"\"customer\"\": {\" + \"\\n\" +\n@\" \"\"id\"\": null,\" + \"\\n\" +\n@\" \"\"originalCustomerId\"\": null,\" + \"\\n\" +\n@\" \"\"poNumbers\"\": []\" + \"\\n\" +\n@\" },\" + \"\\n\" +\n@\" \"\"addressLine1\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"city\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"state\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"country\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"postalCode\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"latitude\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"longitude\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"geofencePoints\"\": [],\" + \"\\n\" +\n@\" \"\"externalAddressId\"\": \"\"USJAX\"\",\" + \"\\n\" +\n@\" \"\"appointmentTime\"\": \"\"2024-03-31T16:00:00\"\",\" + \"\\n\" +\n@\" \"\"stopReferenceId\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"earliestAppointmentTime\"\": null,\" + \"\\n\" +\n@\" \"\"latestAppointmentTime\"\": null,\" + \"\\n\" +\n@\" \"\"wantTime\"\": null\" + \"\\n\" +\n@\" }\" + \"\\n\" +\n@\" ]\" + \"\\n\" +\n@\" }\" + \"\\n\" +\n@\"}\";\nrequest.AddParameter(\"application/json\", body, ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);\nConsole.WriteLine(response.Content);",
"customLabel": ""
},
{
"id": "l7iv2Zqs8dxiFMECmyUzF",
"language": "ruby",
"code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api-staging.fourkites.com/api/v1/tracking\")\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\"] = \"REPLACE_KEY_VALUE\"\nrequest.body = JSON.dump({\n \"trackingInfo\": {\n \"driverPhone\": \"\",\n \"truckNumber\": \"\",\n \"vesselName\": \"\",\n \"imo\": \"\",\n \"mmsi\": \"\",\n \"containerNumber\": \"OOLU4404637\"\n },\n \"containerInfo\": {\n \"containerNumber\": \"OOLU4404637\"\n },\n \"load\": {\n \"loadNumber\": \"stop_completion_1\",\n \"priority\": \"normal\",\n \"operatingCarrierScac\": nil,\n \"carrier\": \"1234\",\n \"carrierName\": \"\",\n \"carrierPermalink\": \"oceancarrier\",\n \"products\": [],\n \"bookingNumber\": \"\",\n \"trackingNumber\": \"\",\n \"billOfLading\": \"GOA230437868\",\n \"referenceNumbers\": [],\n \"stops\": [\n {\n \"stopType\": \"portOfLoading\",\n \"customer\": {\n \"id\": nil,\n \"originalCustomerId\": nil,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"INMAA\",\n \"appointmentTime\": nil,\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": nil,\n \"latestAppointmentTime\": nil,\n \"estimatedDepartureTime\": \"2023-07-20T06:00:00\",\n \"wantTime\": nil\n },\n {\n \"stopType\": \"transshipmentPort\",\n \"customer\": {\n \"id\": nil,\n \"originalCustomerId\": nil,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"SGSIN\",\n \"appointmentTime\": nil,\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": \"2023-07-21T06:00:00\",\n \"latestAppointmentTime\": \"2023-07-21T16:00:00\",\n \"wantTime\": nil\n },\n {\n \"stopType\": \"portOfDischarge\",\n \"customer\": {\n \"id\": nil,\n \"originalCustomerId\": nil,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"USJAX\",\n \"appointmentTime\": \"2024-03-31T16:00:00\",\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": nil,\n \"latestAppointmentTime\": nil,\n \"wantTime\": nil\n }\n ]\n }\n})\n\nresponse = https.request(request)\nputs response.read_body\n",
"customLabel": ""
},
{
"id": "HCOaGqoQDZrRW3y4fbQiw",
"language": "python",
"code": "import http.client\nimport json\n\nconn = http.client.HTTPSConnection(\"api-staging.fourkites.com\")\npayload = json.dumps({\n \"trackingInfo\": {\n \"driverPhone\": \"\",\n \"truckNumber\": \"\",\n \"vesselName\": \"\",\n \"imo\": \"\",\n \"mmsi\": \"\",\n \"containerNumber\": \"OOLU4404637\"\n },\n \"containerInfo\": {\n \"containerNumber\": \"OOLU4404637\"\n },\n \"load\": {\n \"loadNumber\": \"stop_completion_1\",\n \"priority\": \"normal\",\n \"operatingCarrierScac\": None,\n \"carrier\": \"1234\",\n \"carrierName\": \"\",\n \"carrierPermalink\": \"oceancarrier\",\n \"products\": [],\n \"bookingNumber\": \"\",\n \"trackingNumber\": \"\",\n \"billOfLading\": \"GOA230437868\",\n \"referenceNumbers\": [],\n \"stops\": [\n {\n \"stopType\": \"portOfLoading\",\n \"customer\": {\n \"id\": None,\n \"originalCustomerId\": None,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"INMAA\",\n \"appointmentTime\": None,\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": None,\n \"latestAppointmentTime\": None,\n \"estimatedDepartureTime\": \"2023-07-20T06:00:00\",\n \"wantTime\": None\n },\n {\n \"stopType\": \"transshipmentPort\",\n \"customer\": {\n \"id\": None,\n \"originalCustomerId\": None,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"SGSIN\",\n \"appointmentTime\": None,\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": \"2023-07-21T06:00:00\",\n \"latestAppointmentTime\": \"2023-07-21T16:00:00\",\n \"wantTime\": None\n },\n {\n \"stopType\": \"portOfDischarge\",\n \"customer\": {\n \"id\": None,\n \"originalCustomerId\": None,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"USJAX\",\n \"appointmentTime\": \"2024-03-31T16:00:00\",\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": None,\n \"latestAppointmentTime\": None,\n \"wantTime\": None\n }\n ]\n }\n})\nheaders = {\n 'Content-Type': 'application/json',\n 'apikey': 'REPLACE_KEY_VALUE'\n}\nconn.request(\"POST\", \"/api/v1/tracking\", payload, headers)\nres = conn.getresponse()\ndata = res.read()\nprint(data.decode(\"utf-8\"))",
"customLabel": ""
}
],
"selectedLanguageId": "oXTLt8IGOBlfw2e4XGI96"
},
"results": {
"languages": [
{
"id": "Fgv8UpRlPL46aMGyQwH3T",
"language": "200",
"customLabel": "",
"code": "{\n \"statusCode\": 200,\n \"message\": \"Load creation request has been submitted successfully\",\n \"loadId\": 176366208\n}"
}
],
"selectedLanguageId": "Fgv8UpRlPL46aMGyQwH3T"
},
"request": {
"pathParameters": [],
"queryParameters": [],
"headerParameters": [],
"bodyDataParameters": [
{
"name": "trackingInfo",
"kind": "optional",
"type": "object",
"description": "It indicates the information required for tracking the load.",
"children": [
{
"name": "driverPhone",
"kind": "optional",
"type": "string",
"description": "It indicates a valid mobile number. Example: +13125555555"
},
{
"name": "truckNumber",
"kind": "optional",
"type": "string",
"description": "It indicates the tractor or asset number dispatched by the carrier for the load."
},
{
"name": "vesselName",
"kind": "optional",
"type": "string",
"description": "It indicates the name of the vessel carrying the load."
},
{
"name": "imo",
"kind": "optional",
"type": "string",
"description": "It indicates the international maritime organization number."
},
{
"name": "mmsi",
"kind": "optional",
"type": "string",
"description": "It indicates the Maritime Mobile Service Identity (MMSI) of the vessel."
},
{
"name": "containerNumber",
"kind": "required",
"type": "string",
"description": "It indicates the number of the container that is on the vessel. ISO6346 format."
}
]
},
{
"name": "containerInfo",
"kind": "optional",
"type": "object",
"description": "It indicates the information required for tracking the load.",
"children": [
{
"name": "containerNumber",
"kind": "required",
"type": "string",
"description": "It indicates the number of the container that is on the vessel."
}
]
},
{
"name": "load",
"kind": "optional",
"type": "object",
"description": "It is the parent object for the load. Place the load attributes inside this object.",
"children": [
{
"name": "loadNumber",
"kind": "required",
"type": "string",
"description": "It is the unique load identifier from shipper's system. The load Number or BOL is an important piece of information used to link the load with truck information received from the Carrier's TMS."
},
{
"name": "priority",
"kind": "optional",
"type": "string",
"description": "It indicates whether a load is of normal or high priority. If priority is set as ‘hot’, the load will be marked as ‘Hot’. Valid values: ‘normal’, ‘high’ and ‘hot’. Defaults to normal. Setting the 'Priority' as 'hot' will mark the load as 'Hot' load."
},
{
"name": "operatingCarrierScac",
"kind": "optional",
"type": "string",
"description": "SCAC or code of the operating carrier if setting up managing/operating carrier"
},
{
"name": "carrier",
"kind": "required",
"type": "string",
"description": "It is the SCAC or Service Provider ID of the carrier assigned to the load. The carrier should have approved sharing of their telematics data on FourKites® for the customer."
},
{
"name": "products",
"kind": "optional",
"type": "object",
"description": "It indicates the list of temperature tracked products on a load and their temperature tracking information."
},
{
"name": "bookingNumber",
"kind": "optional",
"type": "string",
"description": "It indicates the shipping line's booking number."
},
{
"name": "billOfLading",
"kind": "optional",
"type": "string",
"description": "It indicates the bill of lading associated with the Ocean load."
},
{
"name": "referenceNumbers",
"kind": "optional",
"type": "array",
"description": "It is the list of load level reference numbers associated with a load. (CM)"
},
{
"name": "stops",
"kind": "required",
"type": "object",
"description": "It is the list of stops for the load.",
"children": [
{
"name": "stopType",
"kind": "required",
"type": "string",
"description": "It defines the function of the stop. Valid values: \"portOfLoading\", \"transshipmentPort\", etc. "
},
{
"name": "customer",
"kind": "optional",
"type": "object",
"description": "It indicates the customer information for the stop. (CM)",
"children": [
{
"name": "id",
"kind": "optional",
"type": "string",
"description": "It is the unique identifier of the shipper's customer. "
},
{
"name": "poNumbers",
"kind": "optional",
"type": "array",
"description": "It indicates the list of Customer PO Numbers associated with the load's stop. (CM)"
}
]
},
{
"name": "addressLine1",
"kind": "required",
"type": "string",
"description": "It indicates the first line of the stop's address."
},
{
"name": "city",
"kind": "required",
"type": "string",
"description": "It indicates the name of the city."
},
{
"name": "state",
"kind": "required",
"type": "string",
"description": "It indicates the 2 character state code for US & Canada and 3 Character state code for Mexico. "
},
{
"name": "country",
"kind": "optional",
"type": "string",
"description": "It indicates the valid country code. It is the 2 digit country code."
},
{
"name": "postalCode",
"kind": "optional",
"type": "string",
"description": "It indicates the valid postal code for the stop."
},
{
"name": "latitude",
"kind": "optional",
"type": "string",
"description": "It indicates the latitude of the stop's location."
},
{
"name": "longitude",
"kind": "optional",
"type": "string",
"description": "It indicates the longitude of the stop's location."
},
{
"name": "geofencePoints",
"kind": "optional",
"type": "array",
"description": "It indicates the list of lat/long coordinates of the corners of the polygon geofence around the stop to be used for detecting arrival."
},
{
"name": "externalAddressId",
"kind": "optional",
"type": "string",
"description": "It is the unique identifier of the address in FourKites. This ID is sent in place of address information. UNLOCODE is preferred for port stop creation in the FK platform."
},
{
"name": "appointmentTime",
"kind": "required",
"type": "string",
"description": "It indicates the scheduled appointment time at the stop in the stop's local time zone in ISO 8601 format. ISO 8601 format Appointment times cannot be more than 4 days in the past from the current time."
},
{
"name": "stopReferenceId",
"kind": "optional",
"type": "string",
"description": "It is the unique identifier of the stop from the customer's system. This populates the \"Reference #\" field on the stop and is used to indicate which stop an update is applied to. (CM)"
},
{
"name": "earliestAppointmentTime",
"kind": "required",
"type": "string",
"description": "It indicates the earliest scheduled arrival time at the stop in the stop's local time zone in ISO 8601 format. ISO 8601 format If earliestAppointmentTi me is sent, then latestAppointmentTime must also be sent."
},
{
"name": "latestAppointmentTime",
"kind": "required",
"type": "string",
"description": "It indicates the latest scheduled arrival time at the stop in the stop's local time zone in ISO 8601 format. ISO 8601 format If latestAppointmentTime is sent, then earliestAppointmentTi me must also be sent.vlatestAppointmentTime should be greater than or equal to earliestAppointmentTime."
},
{
"name": "wantTime",
"kind": "optional",
"type": "string",
"description": "It indicates the time by which the load must be delivered to the consignee in stop's local time zone in ISO 8601 format. (CM)"
},
{
"name": "productLineItems",
"kind": "optional",
"type": "object",
"description": "It is the list of product level details associated with a stop. Replaces the legacy pallets/parts structure going forward.",
"children": [
{
"name": "productId",
"kind": "required",
"type": "string",
"description": "Unique identifier for the product. Mandatory if productLineItems object is present"
},
{
"name": "productName",
"kind": "optional",
"type": "string",
"description": "Name of the product"
},
{
"name": "productDescription",
"kind": "optional",
"type": "string",
"description": "Detailed description of the product"
},
{
"name": "productCategory",
"kind": "optional",
"type": "string",
"description": "Category classification of the product"
},
{
"name": "quantity",
"kind": "optional",
"type": "integer",
"description": "Number of units in the shipment"
},
{
"name": "measurementUnitCode",
"kind": "optional",
"type": "string",
"description": "Unit of measurement for quantity (e.g., PCE, KG, LB)"
},
{
"name": "netWeight",
"kind": "optional",
"type": "string",
"description": "Weight of the product excluding packaging"
},
{
"name": "weightUnit",
"kind": "optional",
"type": "string",
"description": "Unit of measurement for weight (e.g., KGM, LBM)"
},
{
"name": "unitCost",
"kind": "optional",
"type": "number",
"description": "Cost per unit of the product"
},
{
"name": "currencyCode",
"kind": "optional",
"type": "string",
"description": "Currency code for cost fields"
},
{
"name": "extendedCost",
"kind": "optional",
"type": "number",
"description": "Total cost for all units (unitCost x quantity)"
},
{
"name": "freightCost",
"kind": "optional",
"type": "number",
"description": "Freight cost allocated to this line item"
},
{
"name": "bestBeforeDate",
"kind": "optional",
"type": "string",
"description": "Expiration or best before date for the product"
},
{
"name": "additionalCharges",
"kind": "optional",
"type": "number",
"description": "Any additional charges specific to this line item"
},
{
"name": "tariffCost",
"kind": "optional",
"type": "number",
"description": "Tariff cost for this specific line item"
},
{
"name": "fourKitesCalculatedTariffCost",
"kind": "optional",
"type": "number",
"description": "System-calculated tariff cost"
},
{
"name": "totalLandedCost",
"kind": "optional",
"type": "number",
"description": "Total landed cost for this line item"
},
{
"name": "countryOfOrigin",
"kind": "optional",
"type": "string",
"description": "Country of origin for this product"
},
{
"name": "harmonizedSystemCode",
"kind": "optional",
"type": "string",
"description": "International trade classification code"
},
{
"name": "commodityTypeCode",
"kind": "optional",
"type": "string",
"description": "Commodity classification code"
},
{
"name": "htsusCode",
"kind": "optional",
"type": "string",
"description": "Harmonized Tariff Schedule code for US imports"
},
{
"name": "orderNumber",
"kind": "optional",
"type": "string",
"description": "Purchase order number"
},
{
"name": "deliveryNumber",
"kind": "optional",
"type": "string",
"description": "Delivery reference number"
},
{
"name": "handlingUnitId",
"kind": "optional",
"type": "string",
"description": "Identifier for the handling unit (pallet, box, etc.)"
},
{
"name": "barcode",
"kind": "optional",
"type": "string",
"description": "Product barcode"
},
{
"name": "containerType",
"kind": "optional",
"type": "string",
"description": "Type of container (pallet, box, carton, etc.)"
},
{
"name": "gtin",
"kind": "optional",
"type": "string",
"description": "Global Trade Item Number"
},
{
"name": "customerPartNumber",
"kind": "optional",
"type": "string",
"description": "Customer's part number for the product"
},
{
"name": "supplierPartNumber",
"kind": "optional",
"type": "string",
"description": "Supplier's part number for the product"
},
{
"name": "manufacturerPartNumber",
"kind": "optional",
"type": "string",
"description": "Manufacturer's part number"
},
{
"name": "itemNumber",
"kind": "optional",
"type": "string",
"description": "Internal item number"
},
{
"name": "productUpc",
"kind": "optional",
"type": "string",
"description": "Universal Product Code"
},
{
"name": "deliveryReferences",
"kind": "optional",
"type": "string",
"description": "Array of delivery reference numbers"
},
{
"name": "orderReferences",
"kind": "optional",
"type": "string",
"description": "Array of order reference numbers"
},
{
"name": "brandName",
"kind": "optional",
"type": "string",
"description": "Brand name of the product"
},
{
"name": "minimumTemperature",
"kind": "optional",
"type": "integer",
"description": "Minimum storage/transport temperature"
},
{
"name": "maximumTemperature",
"kind": "optional",
"type": "integer",
"description": "Maximum storage/transport temperature"
},
{
"name": "temperatureUnitCode",
"kind": "optional",
"type": "string",
"description": "Temperature unit (cel, fah)"
},
{
"name": "labelIdentifier",
"kind": "optional",
"type": "string",
"description": "Label identifier for tracking"
},
{
"name": "productTrackingNumber",
"kind": "optional",
"type": "string",
"description": "Unique tracking number for the product"
},
{
"name": "deviceType",
"kind": "optional",
"type": "string",
"description": "Type of tracking device (RFID_TAG, QR_CODE, etc.)"
}
]
}
]
}
],
"schema": [
{
"name": "loadNumber",
"kind": "required",
"type": "string",
"description": "It is the unique load identifier from shipper's system. The load Number or BOL is an important piece of information used to link the load with truck information received from the Carrier's TMS."
},
{
"name": "priority",
"kind": "optional",
"type": "string",
"description": "It indicates whether a load is of normal or high priority. If priority is set as ‘hot’, the load will be marked as ‘Hot’. Valid values: ‘normal’, ‘high’ and ‘hot’. Defaults to normal. Setting the 'Priority' as 'hot' will mark the load as 'Hot' load."
},
{
"name": "operatingCarrierScac",
"kind": "optional",
"type": "string",
"description": "SCAC or code of the operating carrier if setting up managing/operating carrier"
},
{
"name": "carrier",
"kind": "required",
"type": "string",
"description": "It is the SCAC or Service Provider ID of the carrier assigned to the load. The carrier should have approved sharing of their telematics data on FourKites® for the customer."
},
{
"name": "products",
"kind": "optional",
"type": "object",
"description": "It indicates the list of temperature tracked products on a load and their temperature tracking information."
},
{
"name": "bookingNumber",
"kind": "optional",
"type": "string",
"description": "It indicates the shipping line's booking number."
},
{
"name": "billOfLading",
"kind": "optional",
"type": "string",
"description": "It indicates the bill of lading associated with the Ocean load."
},
{
"name": "referenceNumbers",
"kind": "optional",
"type": "array",
"description": "It is the list of load level reference numbers associated with a load. (CM)"
},
{
"name": "stops",
"kind": "required",
"type": "object",
"description": "It is the list of stops for the load.",
"children": [
{
"name": "stopType",
"kind": "required",
"type": "string",
"description": "It defines the function of the stop. Valid values: \"portOfLoading\", \"transshipmentPort\", etc. "
},
{
"name": "customer",
"kind": "optional",
"type": "object",
"description": "It indicates the customer information for the stop. (CM)",
"children": [
{
"name": "id",
"kind": "optional",
"type": "string",
"description": "It is the unique identifier of the shipper's customer. "
},
{
"name": "poNumbers",
"kind": "optional",
"type": "array",
"description": "It indicates the list of Customer PO Numbers associated with the load's stop. (CM)"
}
]
},
{
"name": "addressLine1",
"kind": "required",
"type": "string",
"description": "It indicates the first line of the stop's address."
},
{
"name": "city",
"kind": "required",
"type": "string",
"description": "It indicates the name of the city."
},
{
"name": "state",
"kind": "required",
"type": "string",
"description": "It indicates the 2 character state code for US & Canada and 3 Character state code for Mexico. "
},
{
"name": "country",
"kind": "optional",
"type": "string",
"description": "It indicates the valid country code. It is the 2 digit country code."
},
{
"name": "postalCode",
"kind": "optional",
"type": "string",
"description": "It indicates the valid postal code for the stop."
},
{
"name": "latitude",
"kind": "optional",
"type": "string",
"description": "It indicates the latitude of the stop's location."
},
{
"name": "longitude",
"kind": "optional",
"type": "string",
"description": "It indicates the longitude of the stop's location."
},
{
"name": "geofencePoints",
"kind": "optional",
"type": "array",
"description": "It indicates the list of lat/long coordinates of the corners of the polygon geofence around the stop to be used for detecting arrival."
},
{
"name": "externalAddressId",
"kind": "optional",
"type": "string",
"description": "It is the unique identifier of the address in FourKites. This ID is sent in place of address information. UNLOCODE is preferred for port stop creation in the FK platform."
},
{
"name": "appointmentTime",
"kind": "required",
"type": "string",
"description": "It indicates the scheduled appointment time at the stop in the stop's local time zone in ISO 8601 format. ISO 8601 format Appointment times cannot be more than 4 days in the past from the current time."
},
{
"name": "stopReferenceId",
"kind": "optional",
"type": "string",
"description": "It is the unique identifier of the stop from the customer's system. This populates the \"Reference #\" field on the stop and is used to indicate which stop an update is applied to. (CM)"
},
{
"name": "earliestAppointmentTime",
"kind": "required",
"type": "string",
"description": "It indicates the earliest scheduled arrival time at the stop in the stop's local time zone in ISO 8601 format. ISO 8601 format If earliestAppointmentTi me is sent, then latestAppointmentTime must also be sent."
},
{
"name": "latestAppointmentTime",
"kind": "required",
"type": "string",
"description": "It indicates the latest scheduled arrival time at the stop in the stop's local time zone in ISO 8601 format. ISO 8601 format If latestAppointmentTime is sent, then earliestAppointmentTi me must also be sent.vlatestAppointmentTime should be greater than or equal to earliestAppointmentTime."
},
{
"name": "wantTime",
"kind": "optional",
"type": "string",
"description": "It indicates the time by which the load must be delivered to the consignee in stop's local time zone in ISO 8601 format. (CM)"
},
{
"name": "productLineItems",
"kind": "optional",
"type": "object",
"description": "It is the list of product level details associated with a stop. Replaces the legacy pallets/parts structure going forward.",
"children": [
{
"name": "productId",
"kind": "required",
"type": "string",
"description": "Unique identifier for the product. Mandatory if productLineItems object is present"
},
{
"name": "productName",
"kind": "optional",
"type": "string",
"description": "Name of the product"
},
{
"name": "productDescription",
"kind": "optional",
"type": "string",
"description": "Detailed description of the product"
},
{
"name": "productCategory",
"kind": "optional",
"type": "string",
"description": "Category classification of the product"
},
{
"name": "quantity",
"kind": "optional",
"type": "integer",
"description": "Number of units in the shipment"
},
{
"name": "measurementUnitCode",
"kind": "optional",
"type": "string",
"description": "Unit of measurement for quantity (e.g., PCE, KG, LB)"
},
{
"name": "netWeight",
"kind": "optional",
"type": "string",
"description": "Weight of the product excluding packaging"
},
{
"name": "weightUnit",
"kind": "optional",
"type": "string",
"description": "Unit of measurement for weight (e.g., KGM, LBM)"
},
{
"name": "unitCost",
"kind": "optional",
"type": "number",
"description": "Cost per unit of the product"
},
{
"name": "currencyCode",
"kind": "optional",
"type": "string",
"description": "Currency code for cost fields"
},
{
"name": "extendedCost",
"kind": "optional",
"type": "number",
"description": "Total cost for all units (unitCost x quantity)"
},
{
"name": "freightCost",
"kind": "optional",
"type": "number",
"description": "Freight cost allocated to this line item"
},
{
"name": "bestBeforeDate",
"kind": "optional",
"type": "string",
"description": "Expiration or best before date for the product"
},
{
"name": "additionalCharges",
"kind": "optional",
"type": "number",
"description": "Any additional charges specific to this line item"
},
{
"name": "tariffCost",
"kind": "optional",
"type": "number",
"description": "Tariff cost for this specific line item"
},
{
"name": "fourKitesCalculatedTariffCost",
"kind": "optional",
"type": "number",
"description": "System-calculated tariff cost"
},
{
"name": "totalLandedCost",
"kind": "optional",
"type": "number",
"description": "Total landed cost for this line item"
},
{
"name": "countryOfOrigin",
"kind": "optional",
"type": "string",
"description": "Country of origin for this product"
},
{
"name": "harmonizedSystemCode",
"kind": "optional",
"type": "string",
"description": "International trade classification code"
},
{
"name": "commodityTypeCode",
"kind": "optional",
"type": "string",
"description": "Commodity classification code"
},
{
"name": "htsusCode",
"kind": "optional",
"type": "string",
"description": "Harmonized Tariff Schedule code for US imports"
},
{
"name": "orderNumber",
"kind": "optional",
"type": "string",
"description": "Purchase order number"
},
{
"name": "deliveryNumber",
"kind": "optional",
"type": "string",
"description": "Delivery reference number"
},
{
"name": "handlingUnitId",
"kind": "optional",
"type": "string",
"description": "Identifier for the handling unit (pallet, box, etc.)"
},
{
"name": "barcode",
"kind": "optional",
"type": "string",
"description": "Product barcode"
},
{
"name": "containerType",
"kind": "optional",
"type": "string",
"description": "Type of container (pallet, box, carton, etc.)"
},
{
"name": "gtin",
"kind": "optional",
"type": "string",
"description": "Global Trade Item Number"
},
{
"name": "customerPartNumber",
"kind": "optional",
"type": "string",
"description": "Customer's part number for the product"
},
{
"name": "supplierPartNumber",
"kind": "optional",
"type": "string",
"description": "Supplier's part number for the product"
},
{
"name": "manufacturerPartNumber",
"kind": "optional",
"type": "string",
"description": "Manufacturer's part number"
},
{
"name": "itemNumber",
"kind": "optional",
"type": "string",
"description": "Internal item number"
},
{
"name": "productUpc",
"kind": "optional",
"type": "string",
"description": "Universal Product Code"
},
{
"name": "deliveryReferences",
"kind": "optional",
"type": "string",
"description": "Array of delivery reference numbers"
},
{
"name": "orderReferences",
"kind": "optional",
"type": "string",
"description": "Array of order reference numbers"
},
{
"name": "brandName",
"kind": "optional",
"type": "string",
"description": "Brand name of the product"
},
{
"name": "minimumTemperature",
"kind": "optional",
"type": "integer",
"description": "Minimum storage/transport temperature"
},
{
"name": "maximumTemperature",
"kind": "optional",
"type": "integer",
"description": "Maximum storage/transport temperature"
},
{
"name": "temperatureUnitCode",
"kind": "optional",
"type": "string",
"description": "Temperature unit (cel, fah)"
},
{
"name": "labelIdentifier",
"kind": "optional",
"type": "string",
"description": "Label identifier for tracking"
},
{
"name": "productTrackingNumber",
"kind": "optional",
"type": "string",
"description": "Unique tracking number for the product"
},
{
"name": "deviceType",
"kind": "optional",
"type": "string",
"description": "Type of tracking device (RFID_TAG, QR_CODE, etc.)"
}
]
}
]
}
]
}
],
"formDataParameters": []
},
"currentNewParameter": {
"label": "Body Parameter",
"value": "bodyDataParameters"
},
"hasTryItOut": false,
"autoGeneratedAnchorSlug": "staging",
"legacyHash": "pjLzkq8K5BDQyzAhnPIwF"
}
```
:::
:::ApiMethodV2
```json
{
"name": "Azure - Production",
"method": "POST",
"url": "https://api.ng.fourkites.com/api/v1/tracking",
"description": "",
"tab": "examples",
"examples": {
"languages": [
{
"id": "oXTLt8IGOBlfw2e4XGI96",
"language": "curl",
"code": "curl --location --request POST 'https://api.ng.fourkites.com/api/v1/tracking' \\\n--header 'Content-Type: application/json' \\\n--header 'apikey: REPLACE_KEY_VALUE' \\\n--data-raw '{\n \"trackingInfo\": {\n \"driverPhone\": \"\",\n \"truckNumber\": \"\",\n \"vesselName\": \"\",\n \"imo\": \"\",\n \"mmsi\": \"\",\n \"containerNumber\": \"OOLU4404637\"\n },\n \"containerInfo\": {\n \"containerNumber\": \"OOLU4404637\"\n },\n \"load\": {\n \"loadNumber\": \"stop_completion_1\",\n \"priority\": \"normal\",\n \"operatingCarrierScac\": null,\n \"carrier\": \"1234\",\n \"carrierName\": \"\",\n \"carrierPermalink\": \"oceancarrier\",\n \"products\": [],\n \"bookingNumber\": \"\",\n \"trackingNumber\": \"\",\n \"billOfLading\": \"GOA230437868\",\n \"referenceNumbers\": [],\n \"stops\": [\n {\n \"stopType\": \"portOfLoading\",\n \"customer\": {\n \"id\": null,\n \"originalCustomerId\": null,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"INMAA\",\n \"appointmentTime\": null,\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": null,\n \"latestAppointmentTime\": null,\n \"estimatedDepartureTime\": \"2023-07-20T06:00:00\",\n \"wantTime\": null,\n \"productLineItems\": [\n {\n \"productId\": \"0123456\",\n \"productName\": \"Ocean Freight Item\",\n \"productDescription\": \"Port-to-port ocean shipment item\",\n \"productCategory\": \"General Freight\",\n \"quantity\": 25,\n \"measurementUnitCode\": \"PCE\",\n \"netWeight\": 44.8,\n \"weightUnit\": \"KGM\",\n \"unitCost\": 25.0,\n \"currencyCode\": \"USD\",\n \"extendedCost\": 625.00,\n \"freightCost\": 20.00,\n \"additionalCharges\": 5.00,\n \"tariffCost\": 2.50,\n \"fourKitesCalculatedTariffCost\": 2.50,\n \"totalLandedCost\": 655.00,\n \"countryOfOrigin\": \"IN\",\n \"harmonizedSystemCode\": \"8471499000\",\n \"commodityTypeCode\": \"OCEAN_FREIGHT\",\n \"htsusCode\": \"8471499000\",\n \"orderNumber\": \"GOA230437868\",\n \"deliveryNumber\": \"DN-INMAA\",\n \"handlingUnitId\": \"PAL-INMAA\",\n \"barcode\": \"PALINMAA\",\n \"containerType\": \"pallet\",\n \"gtin\": \"00012345678905\",\n \"customerPartNumber\": \"22EE\",\n \"supplierPartNumber\": \"22EE\",\n \"manufacturerPartNumber\": \"MFG-22EE\",\n \"itemNumber\": \"ITM-22EE\",\n \"productUpc\": \"012345678905\",\n \"deliveryReferences\": [\"OOLU4404637\"],\n \"orderReferences\": [\"GOA230437868\"],\n \"brandName\": \"Generic Ocean Freight Co\",\n \"minimumTemperature\": 0,\n \"maximumTemperature\": 0,\n \"temperatureUnitCode\": \"cel\",\n \"labelIdentifier\": \"LBL-22EE\",\n \"productTrackingNumber\": \"OOLU4404637-1\",\n \"deviceType\": \"RFID_TAG\"\n }\n ]\n },\n {\n \"stopType\": \"transshipmentPort\",\n \"customer\": {\n \"id\": null,\n \"originalCustomerId\": null,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"SGSIN\",\n \"appointmentTime\": null,\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": \"2023-07-21T06:00:00\",\n \"latestAppointmentTime\": \"2023-07-21T16:00:00\",\n \"wantTime\": null,\n \"productLineItems\": [\n {\n \"productId\": \"0123456\",\n \"productName\": \"Ocean Freight Item\",\n \"productDescription\": \"Port-to-port ocean shipment item\",\n \"productCategory\": \"General Freight\",\n \"quantity\": 25,\n \"measurementUnitCode\": \"PCE\",\n \"netWeight\": 44.8,\n \"weightUnit\": \"KGM\",\n \"unitCost\": 25.0,\n \"currencyCode\": \"USD\",\n \"extendedCost\": 625.00,\n \"freightCost\": 20.00,\n \"additionalCharges\": 5.00,\n \"tariffCost\": 2.50,\n \"fourKitesCalculatedTariffCost\": 2.50,\n \"totalLandedCost\": 655.00,\n \"countryOfOrigin\": \"IN\",\n \"harmonizedSystemCode\": \"8471499000\",\n \"commodityTypeCode\": \"OCEAN_FREIGHT\",\n \"htsusCode\": \"8471499000\",\n \"orderNumber\": \"GOA230437868\",\n \"deliveryNumber\": \"DN-INMAA\",\n \"handlingUnitId\": \"PAL-INMAA\",\n \"barcode\": \"PALINMAA\",\n \"containerType\": \"pallet\",\n \"gtin\": \"00012345678905\",\n \"customerPartNumber\": \"22EE\",\n \"supplierPartNumber\": \"22EE\",\n \"manufacturerPartNumber\": \"MFG-22EE\",\n \"itemNumber\": \"ITM-22EE\",\n \"productUpc\": \"012345678905\",\n \"deliveryReferences\": [\"OOLU4404637\"],\n \"orderReferences\": [\"GOA230437868\"],\n \"brandName\": \"Generic Ocean Freight Co\",\n \"minimumTemperature\": 0,\n \"maximumTemperature\": 0,\n \"temperatureUnitCode\": \"cel\",\n \"labelIdentifier\": \"LBL-22EE\",\n \"productTrackingNumber\": \"OOLU4404637-1\",\n \"deviceType\": \"RFID_TAG\"\n }\n ]\n },\n {\n \"stopType\": \"portOfDischarge\",\n \"customer\": {\n \"id\": null,\n \"originalCustomerId\": null,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"USJAX\",\n \"appointmentTime\": \"2024-03-31T16:00:00\",\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": null,\n \"latestAppointmentTime\": null,\n \"wantTime\": null,\n \"productLineItems\": [\n {\n \"productId\": \"0123456\",\n \"productName\": \"Ocean Freight Item\",\n \"productDescription\": \"Port-to-port ocean shipment item\",\n \"productCategory\": \"General Freight\",\n \"quantity\": 25,\n \"measurementUnitCode\": \"PCE\",\n \"netWeight\": 44.8,\n \"weightUnit\": \"KGM\",\n \"unitCost\": 25.0,\n \"currencyCode\": \"USD\",\n \"extendedCost\": 625.00,\n \"freightCost\": 20.00,\n \"additionalCharges\": 5.00,\n \"tariffCost\": 2.50,\n \"fourKitesCalculatedTariffCost\": 2.50,\n \"totalLandedCost\": 655.00,\n \"countryOfOrigin\": \"IN\",\n \"harmonizedSystemCode\": \"8471499000\",\n \"commodityTypeCode\": \"OCEAN_FREIGHT\",\n \"htsusCode\": \"8471499000\",\n \"orderNumber\": \"GOA230437868\",\n \"deliveryNumber\": \"DN-USJAX\",\n \"handlingUnitId\": \"PAL-USJAX\",\n \"barcode\": \"PALUSJAX\",\n \"containerType\": \"pallet\",\n \"gtin\": \"00012345678905\",\n \"customerPartNumber\": \"22EE\",\n \"supplierPartNumber\": \"22EE\",\n \"manufacturerPartNumber\": \"MFG-22EE\",\n \"itemNumber\": \"ITM-22EE\",\n \"productUpc\": \"012345678905\",\n \"deliveryReferences\": [\"OOLU4404637\"],\n \"orderReferences\": [\"GOA230437868\"],\n \"brandName\": \"Generic Ocean Freight Co\",\n \"minimumTemperature\": 0,\n \"maximumTemperature\": 0,\n \"temperatureUnitCode\": \"cel\",\n \"labelIdentifier\": \"LBL-22EE\",\n \"productTrackingNumber\": \"OOLU4404637-3\",\n \"deviceType\": \"QR_CODE\"\n }\n ]\n }\n ]\n }\n}'",
"customLabel": ""
},
{
"id": "R9fUapNeQ5A5Ft6WMmxI2",
"language": "java",
"code": "OkHttpClient client = new OkHttpClient().newBuilder()\n .build();\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\n \\\"trackingInfo\\\": {\\n \\\"driverPhone\\\": \\\"\\\",\\n \\\"truckNumber\\\": \\\"\\\",\\n \\\"vesselName\\\": \\\"\\\",\\n \\\"imo\\\": \\\"\\\",\\n \\\"mmsi\\\": \\\"\\\",\\n \\\"containerNumber\\\": \\\"OOLU4404637\\\"\\n },\\n \\\"containerInfo\\\": {\\n \\\"containerNumber\\\": \\\"OOLU4404637\\\"\\n },\\n \\\"load\\\": {\\n \\\"loadNumber\\\": \\\"stop_completion_1\\\",\\n \\\"priority\\\": \\\"normal\\\",\\n \\\"operatingCarrierScac\\\": null,\\n \\\"carrier\\\": \\\"1234\\\",\\n \\\"carrierName\\\": \\\"\\\",\\n \\\"carrierPermalink\\\": \\\"oceancarrier\\\",\\n \\\"products\\\": [],\\n \\\"bookingNumber\\\": \\\"\\\",\\n \\\"trackingNumber\\\": \\\"\\\",\\n \\\"billOfLading\\\": \\\"GOA230437868\\\",\\n \\\"referenceNumbers\\\": [],\\n \\\"stops\\\": [\\n {\\n \\\"stopType\\\": \\\"portOfLoading\\\",\\n \\\"customer\\\": {\\n \\\"id\\\": null,\\n \\\"originalCustomerId\\\": null,\\n \\\"poNumbers\\\": []\\n },\\n \\\"addressLine1\\\": \\\"\\\",\\n \\\"city\\\": \\\"\\\",\\n \\\"state\\\": \\\"\\\",\\n \\\"country\\\": \\\"\\\",\\n \\\"postalCode\\\": \\\"\\\",\\n \\\"latitude\\\": \\\"\\\",\\n \\\"longitude\\\": \\\"\\\",\\n \\\"geofencePoints\\\": [],\\n \\\"externalAddressId\\\": \\\"INMAA\\\",\\n \\\"appointmentTime\\\": null,\\n \\\"stopReferenceId\\\": \\\"\\\",\\n \\\"earliestAppointmentTime\\\": null,\\n \\\"latestAppointmentTime\\\": null,\\n \\\"estimatedDepartureTime\\\": \\\"2023-07-20T06:00:00\\\",\\n \\\"wantTime\\\": null\\n },\\n {\\n \\\"stopType\\\": \\\"transshipmentPort\\\",\\n \\\"customer\\\": {\\n \\\"id\\\": null,\\n \\\"originalCustomerId\\\": null,\\n \\\"poNumbers\\\": []\\n },\\n \\\"addressLine1\\\": \\\"\\\",\\n \\\"city\\\": \\\"\\\",\\n \\\"state\\\": \\\"\\\",\\n \\\"country\\\": \\\"\\\",\\n \\\"postalCode\\\": \\\"\\\",\\n \\\"latitude\\\": \\\"\\\",\\n \\\"longitude\\\": \\\"\\\",\\n \\\"geofencePoints\\\": [],\\n \\\"externalAddressId\\\": \\\"SGSIN\\\",\\n \\\"appointmentTime\\\": null,\\n \\\"stopReferenceId\\\": \\\"\\\",\\n \\\"earliestAppointmentTime\\\": \\\"2023-07-21T06:00:00\\\",\\n \\\"latestAppointmentTime\\\": \\\"2023-07-21T16:00:00\\\",\\n \\\"wantTime\\\": null\\n },\\n {\\n \\\"stopType\\\": \\\"portOfDischarge\\\",\\n \\\"customer\\\": {\\n \\\"id\\\": null,\\n \\\"originalCustomerId\\\": null,\\n \\\"poNumbers\\\": []\\n },\\n \\\"addressLine1\\\": \\\"\\\",\\n \\\"city\\\": \\\"\\\",\\n \\\"state\\\": \\\"\\\",\\n \\\"country\\\": \\\"\\\",\\n \\\"postalCode\\\": \\\"\\\",\\n \\\"latitude\\\": \\\"\\\",\\n \\\"longitude\\\": \\\"\\\",\\n \\\"geofencePoints\\\": [],\\n \\\"externalAddressId\\\": \\\"USJAX\\\",\\n \\\"appointmentTime\\\": \\\"2024-03-31T16:00:00\\\",\\n \\\"stopReferenceId\\\": \\\"\\\",\\n \\\"earliestAppointmentTime\\\": null,\\n \\\"latestAppointmentTime\\\": null,\\n \\\"wantTime\\\": null\\n }\\n ]\\n }\\n}\");\nRequest request = new Request.Builder()\n .url(\"https://api.ng.fourkites.com/api/v1/tracking\")\n .method(\"POST\", body)\n .addHeader(\"Content-Type\", \"application/json\")\n .addHeader(\"apikey\", \"REPLACE_KEY_VALUE\")\n .build();\nResponse response = client.newCall(request).execute();",
"customLabel": ""
},
{
"id": "qT5uNZIqgUvY8TitfBixf",
"language": "javascript",
"code": "var settings = {\n \"url\": \"https://api.ng.fourkites.com/api/v1/tracking\",\n \"method\": \"POST\",\n \"timeout\": 0,\n \"headers\": {\n \"Content-Type\": \"application/json\",\n \"apikey\": \"REPLACE_KEY_VALUE\"\n },\n \"data\": JSON.stringify({\n \"trackingInfo\": {\n \"driverPhone\": \"\",\n \"truckNumber\": \"\",\n \"vesselName\": \"\",\n \"imo\": \"\",\n \"mmsi\": \"\",\n \"containerNumber\": \"OOLU4404637\"\n },\n \"containerInfo\": {\n \"containerNumber\": \"OOLU4404637\"\n },\n \"load\": {\n \"loadNumber\": \"stop_completion_1\",\n \"priority\": \"normal\",\n \"operatingCarrierScac\": null,\n \"carrier\": \"1234\",\n \"carrierName\": \"\",\n \"carrierPermalink\": \"oceancarrier\",\n \"products\": [],\n \"bookingNumber\": \"\",\n \"trackingNumber\": \"\",\n \"billOfLading\": \"GOA230437868\",\n \"referenceNumbers\": [],\n \"stops\": [\n {\n \"stopType\": \"portOfLoading\",\n \"customer\": {\n \"id\": null,\n \"originalCustomerId\": null,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"INMAA\",\n \"appointmentTime\": null,\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": null,\n \"latestAppointmentTime\": null,\n \"estimatedDepartureTime\": \"2023-07-20T06:00:00\",\n \"wantTime\": null\n },\n {\n \"stopType\": \"transshipmentPort\",\n \"customer\": {\n \"id\": null,\n \"originalCustomerId\": null,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"SGSIN\",\n \"appointmentTime\": null,\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": \"2023-07-21T06:00:00\",\n \"latestAppointmentTime\": \"2023-07-21T16:00:00\",\n \"wantTime\": null\n },\n {\n \"stopType\": \"portOfDischarge\",\n \"customer\": {\n \"id\": null,\n \"originalCustomerId\": null,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"USJAX\",\n \"appointmentTime\": \"2024-03-31T16:00:00\",\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": null,\n \"latestAppointmentTime\": null,\n \"wantTime\": null\n }\n ]\n }\n }),\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});",
"customLabel": ""
},
{
"id": "mViRMiSR81WSzY3jgFUSE",
"language": "swift",
"code": "import Foundation\n#if canImport(FoundationNetworking)\nimport FoundationNetworking\n#endif\n\nvar semaphore = DispatchSemaphore (value: 0)\n\nlet parameters = \"{\\n \\\"trackingInfo\\\": {\\n \\\"driverPhone\\\": \\\"\\\",\\n \\\"truckNumber\\\": \\\"\\\",\\n \\\"vesselName\\\": \\\"\\\",\\n \\\"imo\\\": \\\"\\\",\\n \\\"mmsi\\\": \\\"\\\",\\n \\\"containerNumber\\\": \\\"OOLU4404637\\\"\\n },\\n \\\"containerInfo\\\": {\\n \\\"containerNumber\\\": \\\"OOLU4404637\\\"\\n },\\n \\\"load\\\": {\\n \\\"loadNumber\\\": \\\"stop_completion_1\\\",\\n \\\"priority\\\": \\\"normal\\\",\\n \\\"operatingCarrierScac\\\": null,\\n \\\"carrier\\\": \\\"1234\\\",\\n \\\"carrierName\\\": \\\"\\\",\\n \\\"carrierPermalink\\\": \\\"oceancarrier\\\",\\n \\\"products\\\": [],\\n \\\"bookingNumber\\\": \\\"\\\",\\n \\\"trackingNumber\\\": \\\"\\\",\\n \\\"billOfLading\\\": \\\"GOA230437868\\\",\\n \\\"referenceNumbers\\\": [],\\n \\\"stops\\\": [\\n {\\n \\\"stopType\\\": \\\"portOfLoading\\\",\\n \\\"customer\\\": {\\n \\\"id\\\": null,\\n \\\"originalCustomerId\\\": null,\\n \\\"poNumbers\\\": []\\n },\\n \\\"addressLine1\\\": \\\"\\\",\\n \\\"city\\\": \\\"\\\",\\n \\\"state\\\": \\\"\\\",\\n \\\"country\\\": \\\"\\\",\\n \\\"postalCode\\\": \\\"\\\",\\n \\\"latitude\\\": \\\"\\\",\\n \\\"longitude\\\": \\\"\\\",\\n \\\"geofencePoints\\\": [],\\n \\\"externalAddressId\\\": \\\"INMAA\\\",\\n \\\"appointmentTime\\\": null,\\n \\\"stopReferenceId\\\": \\\"\\\",\\n \\\"earliestAppointmentTime\\\": null,\\n \\\"latestAppointmentTime\\\": null,\\n \\\"estimatedDepartureTime\\\": \\\"2023-07-20T06:00:00\\\",\\n \\\"wantTime\\\": null\\n },\\n {\\n \\\"stopType\\\": \\\"transshipmentPort\\\",\\n \\\"customer\\\": {\\n \\\"id\\\": null,\\n \\\"originalCustomerId\\\": null,\\n \\\"poNumbers\\\": []\\n },\\n \\\"addressLine1\\\": \\\"\\\",\\n \\\"city\\\": \\\"\\\",\\n \\\"state\\\": \\\"\\\",\\n \\\"country\\\": \\\"\\\",\\n \\\"postalCode\\\": \\\"\\\",\\n \\\"latitude\\\": \\\"\\\",\\n \\\"longitude\\\": \\\"\\\",\\n \\\"geofencePoints\\\": [],\\n \\\"externalAddressId\\\": \\\"SGSIN\\\",\\n \\\"appointmentTime\\\": null,\\n \\\"stopReferenceId\\\": \\\"\\\",\\n \\\"earliestAppointmentTime\\\": \\\"2023-07-21T06:00:00\\\",\\n \\\"latestAppointmentTime\\\": \\\"2023-07-21T16:00:00\\\",\\n \\\"wantTime\\\": null\\n },\\n {\\n \\\"stopType\\\": \\\"portOfDischarge\\\",\\n \\\"customer\\\": {\\n \\\"id\\\": null,\\n \\\"originalCustomerId\\\": null,\\n \\\"poNumbers\\\": []\\n },\\n \\\"addressLine1\\\": \\\"\\\",\\n \\\"city\\\": \\\"\\\",\\n \\\"state\\\": \\\"\\\",\\n \\\"country\\\": \\\"\\\",\\n \\\"postalCode\\\": \\\"\\\",\\n \\\"latitude\\\": \\\"\\\",\\n \\\"longitude\\\": \\\"\\\",\\n \\\"geofencePoints\\\": [],\\n \\\"externalAddressId\\\": \\\"USJAX\\\",\\n \\\"appointmentTime\\\": \\\"2024-03-31T16:00:00\\\",\\n \\\"stopReferenceId\\\": \\\"\\\",\\n \\\"earliestAppointmentTime\\\": null,\\n \\\"latestAppointmentTime\\\": null,\\n \\\"wantTime\\\": null\\n }\\n ]\\n }\\n}\"\nlet postData = parameters.data(using: .utf8)\n\nvar request = URLRequest(url: URL(string: \"https://api.ng.fourkites.com/api/v1/tracking\")!,timeoutInterval: Double.infinity)\nrequest.addValue(\"application/json\", forHTTPHeaderField: \"Content-Type\")\nrequest.addValue(\"REPLACE_KEY_VALUE\", 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 semaphore.signal()\n return\n }\n print(String(data: data, encoding: .utf8)!)\n semaphore.signal()\n}\n\ntask.resume()\nsemaphore.wait()\n",
"customLabel": ""
},
{
"id": "jzpSj1-UF6Wq5Uwg3WWQY",
"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.ng.fourkites.com/api/v1/tracking\"\n method := \"POST\"\n\n payload := strings.NewReader(`{\n \"trackingInfo\": {\n \"driverPhone\": \"\",\n \"truckNumber\": \"\",\n \"vesselName\": \"\",\n \"imo\": \"\",\n \"mmsi\": \"\",\n \"containerNumber\": \"OOLU4404637\"\n },\n \"containerInfo\": {\n \"containerNumber\": \"OOLU4404637\"\n },\n \"load\": {\n \"loadNumber\": \"stop_completion_1\",\n \"priority\": \"normal\",\n \"operatingCarrierScac\": null,\n \"carrier\": \"1234\",\n \"carrierName\": \"\",\n \"carrierPermalink\": \"oceancarrier\",\n \"products\": [],\n \"bookingNumber\": \"\",\n \"trackingNumber\": \"\",\n \"billOfLading\": \"GOA230437868\",\n \"referenceNumbers\": [],\n \"stops\": [\n {\n \"stopType\": \"portOfLoading\",\n \"customer\": {\n \"id\": null,\n \"originalCustomerId\": null,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"INMAA\",\n \"appointmentTime\": null,\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": null,\n \"latestAppointmentTime\": null,\n \"estimatedDepartureTime\": \"2023-07-20T06:00:00\",\n \"wantTime\": null\n },\n {\n \"stopType\": \"transshipmentPort\",\n \"customer\": {\n \"id\": null,\n \"originalCustomerId\": null,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"SGSIN\",\n \"appointmentTime\": null,\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": \"2023-07-21T06:00:00\",\n \"latestAppointmentTime\": \"2023-07-21T16:00:00\",\n \"wantTime\": null\n },\n {\n \"stopType\": \"portOfDischarge\",\n \"customer\": {\n \"id\": null,\n \"originalCustomerId\": null,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"USJAX\",\n \"appointmentTime\": \"2024-03-31T16:00:00\",\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": null,\n \"latestAppointmentTime\": null,\n \"wantTime\": null\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\", \"REPLACE_KEY_VALUE\")\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}",
"customLabel": ""
},
{
"id": "sGD0P46h2XeSoAQyeN5-Q",
"language": "csharp",
"code": "var client = new RestClient(\"https://api.ng.fourkites.com/api/v1/tracking\");\nclient.Timeout = -1;\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddHeader(\"apikey\", \"REPLACE_KEY_VALUE\");\nvar body = @\"{\" + \"\\n\" +\n@\" \"\"trackingInfo\"\": {\" + \"\\n\" +\n@\" \"\"driverPhone\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"truckNumber\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"vesselName\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"imo\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"mmsi\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"containerNumber\"\": \"\"OOLU4404637\"\"\" + \"\\n\" +\n@\" },\" + \"\\n\" +\n@\" \"\"containerInfo\"\": {\" + \"\\n\" +\n@\" \"\"containerNumber\"\": \"\"OOLU4404637\"\"\" + \"\\n\" +\n@\" },\" + \"\\n\" +\n@\" \"\"load\"\": {\" + \"\\n\" +\n@\" \"\"loadNumber\"\": \"\"stop_completion_1\"\",\" + \"\\n\" +\n@\" \"\"priority\"\": \"\"normal\"\",\" + \"\\n\" +\n@\" \"\"operatingCarrierScac\"\": null,\" + \"\\n\" +\n@\" \"\"carrier\"\": \"\"1234\"\",\" + \"\\n\" +\n@\" \"\"carrierName\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"carrierPermalink\"\": \"\"oceancarrier\"\",\" + \"\\n\" +\n@\" \"\"products\"\": [],\" + \"\\n\" +\n@\" \"\"bookingNumber\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"trackingNumber\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"billOfLading\"\": \"\"GOA230437868\"\",\" + \"\\n\" +\n@\" \"\"referenceNumbers\"\": [],\" + \"\\n\" +\n@\" \"\"stops\"\": [\" + \"\\n\" +\n@\" {\" + \"\\n\" +\n@\" \"\"stopType\"\": \"\"portOfLoading\"\",\" + \"\\n\" +\n@\" \"\"customer\"\": {\" + \"\\n\" +\n@\" \"\"id\"\": null,\" + \"\\n\" +\n@\" \"\"originalCustomerId\"\": null,\" + \"\\n\" +\n@\" \"\"poNumbers\"\": []\" + \"\\n\" +\n@\" },\" + \"\\n\" +\n@\" \"\"addressLine1\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"city\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"state\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"country\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"postalCode\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"latitude\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"longitude\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"geofencePoints\"\": [],\" + \"\\n\" +\n@\" \"\"externalAddressId\"\": \"\"INMAA\"\",\" + \"\\n\" +\n@\" \"\"appointmentTime\"\": null,\" + \"\\n\" +\n@\" \"\"stopReferenceId\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"earliestAppointmentTime\"\": null,\" + \"\\n\" +\n@\" \"\"latestAppointmentTime\"\": null,\" + \"\\n\" +\n@\" \"\"estimatedDepartureTime\"\": \"\"2023-07-20T06:00:00\"\",\" + \"\\n\" +\n@\" \"\"wantTime\"\": null\" + \"\\n\" +\n@\" },\" + \"\\n\" +\n@\" {\" + \"\\n\" +\n@\" \"\"stopType\"\": \"\"transshipmentPort\"\",\" + \"\\n\" +\n@\" \"\"customer\"\": {\" + \"\\n\" +\n@\" \"\"id\"\": null,\" + \"\\n\" +\n@\" \"\"originalCustomerId\"\": null,\" + \"\\n\" +\n@\" \"\"poNumbers\"\": []\" + \"\\n\" +\n@\" },\" + \"\\n\" +\n@\" \"\"addressLine1\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"city\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"state\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"country\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"postalCode\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"latitude\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"longitude\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"geofencePoints\"\": [],\" + \"\\n\" +\n@\" \"\"externalAddressId\"\": \"\"SGSIN\"\",\" + \"\\n\" +\n@\" \"\"appointmentTime\"\": null,\" + \"\\n\" +\n@\" \"\"stopReferenceId\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"earliestAppointmentTime\"\": \"\"2023-07-21T06:00:00\"\",\" + \"\\n\" +\n@\" \"\"latestAppointmentTime\"\": \"\"2023-07-21T16:00:00\"\",\" + \"\\n\" +\n@\" \"\"wantTime\"\": null\" + \"\\n\" +\n@\" },\" + \"\\n\" +\n@\" {\" + \"\\n\" +\n@\" \"\"stopType\"\": \"\"portOfDischarge\"\",\" + \"\\n\" +\n@\" \"\"customer\"\": {\" + \"\\n\" +\n@\" \"\"id\"\": null,\" + \"\\n\" +\n@\" \"\"originalCustomerId\"\": null,\" + \"\\n\" +\n@\" \"\"poNumbers\"\": []\" + \"\\n\" +\n@\" },\" + \"\\n\" +\n@\" \"\"addressLine1\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"city\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"state\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"country\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"postalCode\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"latitude\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"longitude\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"geofencePoints\"\": [],\" + \"\\n\" +\n@\" \"\"externalAddressId\"\": \"\"USJAX\"\",\" + \"\\n\" +\n@\" \"\"appointmentTime\"\": \"\"2024-03-31T16:00:00\"\",\" + \"\\n\" +\n@\" \"\"stopReferenceId\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"earliestAppointmentTime\"\": null,\" + \"\\n\" +\n@\" \"\"latestAppointmentTime\"\": null,\" + \"\\n\" +\n@\" \"\"wantTime\"\": null\" + \"\\n\" +\n@\" }\" + \"\\n\" +\n@\" ]\" + \"\\n\" +\n@\" }\" + \"\\n\" +\n@\"}\";\nrequest.AddParameter(\"application/json\", body, ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);\nConsole.WriteLine(response.Content);",
"customLabel": ""
},
{
"id": "l7iv2Zqs8dxiFMECmyUzF",
"language": "ruby",
"code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.ng.fourkites.com/api/v1/tracking\")\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\"] = \"REPLACE_KEY_VALUE\"\nrequest.body = JSON.dump({\n \"trackingInfo\": {\n \"driverPhone\": \"\",\n \"truckNumber\": \"\",\n \"vesselName\": \"\",\n \"imo\": \"\",\n \"mmsi\": \"\",\n \"containerNumber\": \"OOLU4404637\"\n },\n \"containerInfo\": {\n \"containerNumber\": \"OOLU4404637\"\n },\n \"load\": {\n \"loadNumber\": \"stop_completion_1\",\n \"priority\": \"normal\",\n \"operatingCarrierScac\": nil,\n \"carrier\": \"1234\",\n \"carrierName\": \"\",\n \"carrierPermalink\": \"oceancarrier\",\n \"products\": [],\n \"bookingNumber\": \"\",\n \"trackingNumber\": \"\",\n \"billOfLading\": \"GOA230437868\",\n \"referenceNumbers\": [],\n \"stops\": [\n {\n \"stopType\": \"portOfLoading\",\n \"customer\": {\n \"id\": nil,\n \"originalCustomerId\": nil,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"INMAA\",\n \"appointmentTime\": nil,\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": nil,\n \"latestAppointmentTime\": nil,\n \"estimatedDepartureTime\": \"2023-07-20T06:00:00\",\n \"wantTime\": nil\n },\n {\n \"stopType\": \"transshipmentPort\",\n \"customer\": {\n \"id\": nil,\n \"originalCustomerId\": nil,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"SGSIN\",\n \"appointmentTime\": nil,\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": \"2023-07-21T06:00:00\",\n \"latestAppointmentTime\": \"2023-07-21T16:00:00\",\n \"wantTime\": nil\n },\n {\n \"stopType\": \"portOfDischarge\",\n \"customer\": {\n \"id\": nil,\n \"originalCustomerId\": nil,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"USJAX\",\n \"appointmentTime\": \"2024-03-31T16:00:00\",\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": nil,\n \"latestAppointmentTime\": nil,\n \"wantTime\": nil\n }\n ]\n }\n})\n\nresponse = https.request(request)\nputs response.read_body\n",
"customLabel": ""
},
{
"id": "HCOaGqoQDZrRW3y4fbQiw",
"language": "python",
"code": "import http.client\nimport json\n\nconn = http.client.HTTPSConnection(\"api.ng.fourkites.com\")\npayload = json.dumps({\n \"trackingInfo\": {\n \"driverPhone\": \"\",\n \"truckNumber\": \"\",\n \"vesselName\": \"\",\n \"imo\": \"\",\n \"mmsi\": \"\",\n \"containerNumber\": \"OOLU4404637\"\n },\n \"containerInfo\": {\n \"containerNumber\": \"OOLU4404637\"\n },\n \"load\": {\n \"loadNumber\": \"stop_completion_1\",\n \"priority\": \"normal\",\n \"operatingCarrierScac\": None,\n \"carrier\": \"1234\",\n \"carrierName\": \"\",\n \"carrierPermalink\": \"oceancarrier\",\n \"products\": [],\n \"bookingNumber\": \"\",\n \"trackingNumber\": \"\",\n \"billOfLading\": \"GOA230437868\",\n \"referenceNumbers\": [],\n \"stops\": [\n {\n \"stopType\": \"portOfLoading\",\n \"customer\": {\n \"id\": None,\n \"originalCustomerId\": None,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"INMAA\",\n \"appointmentTime\": None,\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": None,\n \"latestAppointmentTime\": None,\n \"estimatedDepartureTime\": \"2023-07-20T06:00:00\",\n \"wantTime\": None\n },\n {\n \"stopType\": \"transshipmentPort\",\n \"customer\": {\n \"id\": None,\n \"originalCustomerId\": None,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"SGSIN\",\n \"appointmentTime\": None,\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": \"2023-07-21T06:00:00\",\n \"latestAppointmentTime\": \"2023-07-21T16:00:00\",\n \"wantTime\": None\n },\n {\n \"stopType\": \"portOfDischarge\",\n \"customer\": {\n \"id\": None,\n \"originalCustomerId\": None,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"USJAX\",\n \"appointmentTime\": \"2024-03-31T16:00:00\",\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": None,\n \"latestAppointmentTime\": None,\n \"wantTime\": None\n }\n ]\n }\n})\nheaders = {\n 'Content-Type': 'application/json',\n 'apikey': 'REPLACE_KEY_VALUE'\n}\nconn.request(\"POST\", \"/api/v1/tracking\", payload, headers)\nres = conn.getresponse()\ndata = res.read()\nprint(data.decode(\"utf-8\"))",
"customLabel": ""
}
],
"selectedLanguageId": "HCOaGqoQDZrRW3y4fbQiw"
},
"results": {
"languages": [
{
"id": "Fgv8UpRlPL46aMGyQwH3T",
"language": "200",
"customLabel": "",
"code": "{\n \"statusCode\": 200,\n \"message\": \"Load creation request has been submitted successfully\",\n \"loadId\": 176366208\n}"
}
],
"selectedLanguageId": "Fgv8UpRlPL46aMGyQwH3T"
},
"request": {
"pathParameters": [],
"queryParameters": [],
"headerParameters": [],
"bodyDataParameters": [
{
"name": "trackingInfo",
"kind": "optional",
"type": "object",
"description": "It indicates the information required for tracking the load.",
"children": [
{
"name": "driverPhone",
"kind": "optional",
"type": "string",
"description": "It indicates a valid mobile number. Example: +13125555555"
},
{
"name": "truckNumber",
"kind": "optional",
"type": "string",
"description": "It indicates the tractor or asset number dispatched by the carrier for the load."
},
{
"name": "vesselName",
"kind": "optional",
"type": "string",
"description": "It indicates the name of the vessel carrying the load."
},
{
"name": "imo",
"kind": "optional",
"type": "string",
"description": "It indicates the international maritime organization number."
},
{
"name": "mmsi",
"kind": "optional",
"type": "string",
"description": "It indicates the Maritime Mobile Service Identity (MMSI) of the vessel."
},
{
"name": "containerNumber",
"kind": "required",
"type": "string",
"description": "It indicates the number of the container that is on the vessel. ISO6346 format."
}
]
},
{
"name": "containerInfo",
"kind": "optional",
"type": "object",
"description": "It indicates the information required for tracking the load.",
"children": [
{
"name": "containerNumber",
"kind": "required",
"type": "string",
"description": "It indicates the number of the container that is on the vessel."
}
]
},
{
"name": "load",
"kind": "optional",
"type": "object",
"description": "It is the parent object for the load. Place the load attributes inside this object.",
"children": [
{
"name": "loadNumber",
"kind": "required",
"type": "string",
"description": "It is the unique load identifier from shipper's system. The load Number or BOL is an important piece of information used to link the load with truck information received from the Carrier's TMS."
},
{
"name": "priority",
"kind": "optional",
"type": "string",
"description": "It indicates whether a load is of normal or high priority. If priority is set as ‘hot’, the load will be marked as ‘Hot’. Valid values: ‘normal’, ‘high’ and ‘hot’. Defaults to normal. Setting the 'Priority' as 'hot' will mark the load as 'Hot' load."
},
{
"name": "operatingCarrierScac",
"kind": "optional",
"type": "string",
"description": "SCAC or code of the operating carrier if setting up managing/operating carrier"
},
{
"name": "carrier",
"kind": "required",
"type": "string",
"description": "It is the SCAC or Service Provider ID of the carrier assigned to the load. The carrier should have approved sharing of their telematics data on FourKites® for the customer."
},
{
"name": "products",
"kind": "optional",
"type": "object",
"description": "It indicates the list of temperature tracked products on a load and their temperature tracking information."
},
{
"name": "bookingNumber",
"kind": "optional",
"type": "string",
"description": "It indicates the shipping line's booking number."
},
{
"name": "billOfLading",
"kind": "optional",
"type": "string",
"description": "It indicates the bill of lading associated with the Ocean load."
},
{
"name": "referenceNumbers",
"kind": "optional",
"type": "array",
"description": "It is the list of load level reference numbers associated with a load. (CM)"
},
{
"name": "stops",
"kind": "required",
"type": "object",
"description": "It is the list of stops for the load.",
"children": [
{
"name": "stopType",
"kind": "required",
"type": "string",
"description": "It defines the function of the stop. Valid values: \"portOfLoading\", \"transshipmentPort\", etc. "
},
{
"name": "customer",
"kind": "optional",
"type": "object",
"description": "It indicates the customer information for the stop. (CM)",
"children": [
{
"name": "id",
"kind": "optional",
"type": "string",
"description": "It is the unique identifier of the shipper's customer. "
},
{
"name": "poNumbers",
"kind": "optional",
"type": "array",
"description": "It indicates the list of Customer PO Numbers associated with the load's stop. (CM)"
}
]
},
{
"name": "addressLine1",
"kind": "required",
"type": "string",
"description": "It indicates the first line of the stop's address."
},
{
"name": "city",
"kind": "required",
"type": "string",
"description": "It indicates the name of the city."
},
{
"name": "state",
"kind": "required",
"type": "string",
"description": "It indicates the 2 character state code for US & Canada and 3 Character state code for Mexico. "
},
{
"name": "country",
"kind": "optional",
"type": "string",
"description": "It indicates the valid country code. It is the 2 digit country code."
},
{
"name": "postalCode",
"kind": "optional",
"type": "string",
"description": "It indicates the valid postal code for the stop."
},
{
"name": "latitude",
"kind": "optional",
"type": "string",
"description": "It indicates the latitude of the stop's location."
},
{
"name": "longitude",
"kind": "optional",
"type": "string",
"description": "It indicates the longitude of the stop's location."
},
{
"name": "geofencePoints",
"kind": "optional",
"type": "array",
"description": "It indicates the list of lat/long coordinates of the corners of the polygon geofence around the stop to be used for detecting arrival."
},
{
"name": "externalAddressId",
"kind": "optional",
"type": "string",
"description": "It is the unique identifier of the address in FourKites. This ID is sent in place of address information. UNLOCODE is preferred for port stop creation in the FK platform."
},
{
"name": "appointmentTime",
"kind": "required",
"type": "string",
"description": "It indicates the scheduled appointment time at the stop in the stop's local time zone in ISO 8601 format. ISO 8601 format Appointment times cannot be more than 4 days in the past from the current time."
},
{
"name": "stopReferenceId",
"kind": "optional",
"type": "string",
"description": "It is the unique identifier of the stop from the customer's system. This populates the \"Reference #\" field on the stop and is used to indicate which stop an update is applied to. (CM)"
},
{
"name": "earliestAppointmentTime",
"kind": "required",
"type": "string",
"description": "It indicates the earliest scheduled arrival time at the stop in the stop's local time zone in ISO 8601 format. ISO 8601 format If earliestAppointmentTi me is sent, then latestAppointmentTime must also be sent."
},
{
"name": "latestAppointmentTime",
"kind": "required",
"type": "string",
"description": "It indicates the latest scheduled arrival time at the stop in the stop's local time zone in ISO 8601 format. ISO 8601 format If latestAppointmentTime is sent, then earliestAppointmentTi me must also be sent.vlatestAppointmentTime should be greater than or equal to earliestAppointmentTime."
},
{
"name": "wantTime",
"kind": "optional",
"type": "string",
"description": "It indicates the time by which the load must be delivered to the consignee in stop's local time zone in ISO 8601 format. (CM)"
},
{
"name": "productLineItems",
"kind": "optional",
"type": "object",
"description": "It is the list of product level details associated with a stop. Replaces the legacy pallets/parts structure going forward.",
"children": [
{
"name": "productId",
"kind": "required",
"type": "string",
"description": "Unique identifier for the product. Mandatory if productLineItems object is present"
},
{
"name": "productName",
"kind": "optional",
"type": "string",
"description": "Name of the product"
},
{
"name": "productDescription",
"kind": "optional",
"type": "string",
"description": "Detailed description of the product"
},
{
"name": "productCategory",
"kind": "optional",
"type": "string",
"description": "Category classification of the product"
},
{
"name": "quantity",
"kind": "optional",
"type": "integer",
"description": "Number of units in the shipment"
},
{
"name": "measurementUnitCode",
"kind": "optional",
"type": "string",
"description": "Unit of measurement for quantity (e.g., PCE, KG, LB)"
},
{
"name": "netWeight",
"kind": "optional",
"type": "string",
"description": "Weight of the product excluding packaging"
},
{
"name": "weightUnit",
"kind": "optional",
"type": "string",
"description": "Unit of measurement for weight (e.g., KGM, LBM)"
},
{
"name": "unitCost",
"kind": "optional",
"type": "number",
"description": "Cost per unit of the product"
},
{
"name": "currencyCode",
"kind": "optional",
"type": "string",
"description": "Currency code for cost fields"
},
{
"name": "extendedCost",
"kind": "optional",
"type": "number",
"description": "Total cost for all units (unitCost x quantity)"
},
{
"name": "freightCost",
"kind": "optional",
"type": "number",
"description": "Freight cost allocated to this line item"
},
{
"name": "bestBeforeDate",
"kind": "optional",
"type": "string",
"description": "Expiration or best before date for the product"
},
{
"name": "additionalCharges",
"kind": "optional",
"type": "number",
"description": "Any additional charges specific to this line item"
},
{
"name": "tariffCost",
"kind": "optional",
"type": "number",
"description": "Tariff cost for this specific line item"
},
{
"name": "fourKitesCalculatedTariffCost",
"kind": "optional",
"type": "number",
"description": "System-calculated tariff cost"
},
{
"name": "totalLandedCost",
"kind": "optional",
"type": "number",
"description": "Total landed cost for this line item"
},
{
"name": "countryOfOrigin",
"kind": "optional",
"type": "string",
"description": "Country of origin for this product"
},
{
"name": "harmonizedSystemCode",
"kind": "optional",
"type": "string",
"description": "International trade classification code"
},
{
"name": "commodityTypeCode",
"kind": "optional",
"type": "string",
"description": "Commodity classification code"
},
{
"name": "htsusCode",
"kind": "optional",
"type": "string",
"description": "Harmonized Tariff Schedule code for US imports"
},
{
"name": "orderNumber",
"kind": "optional",
"type": "string",
"description": "Purchase order number"
},
{
"name": "deliveryNumber",
"kind": "optional",
"type": "string",
"description": "Delivery reference number"
},
{
"name": "handlingUnitId",
"kind": "optional",
"type": "string",
"description": "Identifier for the handling unit (pallet, box, etc.)"
},
{
"name": "barcode",
"kind": "optional",
"type": "string",
"description": "Product barcode"
},
{
"name": "containerType",
"kind": "optional",
"type": "string",
"description": "Type of container (pallet, box, carton, etc.)"
},
{
"name": "gtin",
"kind": "optional",
"type": "string",
"description": "Global Trade Item Number"
},
{
"name": "customerPartNumber",
"kind": "optional",
"type": "string",
"description": "Customer's part number for the product"
},
{
"name": "supplierPartNumber",
"kind": "optional",
"type": "string",
"description": "Supplier's part number for the product"
},
{
"name": "manufacturerPartNumber",
"kind": "optional",
"type": "string",
"description": "Manufacturer's part number"
},
{
"name": "itemNumber",
"kind": "optional",
"type": "string",
"description": "Internal item number"
},
{
"name": "productUpc",
"kind": "optional",
"type": "string",
"description": "Universal Product Code"
},
{
"name": "deliveryReferences",
"kind": "optional",
"type": "string",
"description": "Array of delivery reference numbers"
},
{
"name": "orderReferences",
"kind": "optional",
"type": "string",
"description": "Array of order reference numbers"
},
{
"name": "brandName",
"kind": "optional",
"type": "string",
"description": "Brand name of the product"
},
{
"name": "minimumTemperature",
"kind": "optional",
"type": "integer",
"description": "Minimum storage/transport temperature"
},
{
"name": "maximumTemperature",
"kind": "optional",
"type": "integer",
"description": "Maximum storage/transport temperature"
},
{
"name": "temperatureUnitCode",
"kind": "optional",
"type": "string",
"description": "Temperature unit (cel, fah)"
},
{
"name": "labelIdentifier",
"kind": "optional",
"type": "string",
"description": "Label identifier for tracking"
},
{
"name": "productTrackingNumber",
"kind": "optional",
"type": "string",
"description": "Unique tracking number for the product"
},
{
"name": "deviceType",
"kind": "optional",
"type": "string",
"description": "Type of tracking device (RFID_TAG, QR_CODE, etc.)"
}
]
}
]
}
],
"schema": [
{
"name": "loadNumber",
"kind": "required",
"type": "string",
"description": "It is the unique load identifier from shipper's system. The load Number or BOL is an important piece of information used to link the load with truck information received from the Carrier's TMS."
},
{
"name": "priority",
"kind": "optional",
"type": "string",
"description": "It indicates whether a load is of normal or high priority. If priority is set as ‘hot’, the load will be marked as ‘Hot’. Valid values: ‘normal’, ‘high’ and ‘hot’. Defaults to normal. Setting the 'Priority' as 'hot' will mark the load as 'Hot' load."
},
{
"name": "operatingCarrierScac",
"kind": "optional",
"type": "string",
"description": "SCAC or code of the operating carrier if setting up managing/operating carrier"
},
{
"name": "carrier",
"kind": "required",
"type": "string",
"description": "It is the SCAC or Service Provider ID of the carrier assigned to the load. The carrier should have approved sharing of their telematics data on FourKites® for the customer."
},
{
"name": "products",
"kind": "optional",
"type": "object",
"description": "It indicates the list of temperature tracked products on a load and their temperature tracking information."
},
{
"name": "bookingNumber",
"kind": "optional",
"type": "string",
"description": "It indicates the shipping line's booking number."
},
{
"name": "billOfLading",
"kind": "optional",
"type": "string",
"description": "It indicates the bill of lading associated with the Ocean load."
},
{
"name": "referenceNumbers",
"kind": "optional",
"type": "array",
"description": "It is the list of load level reference numbers associated with a load. (CM)"
},
{
"name": "stops",
"kind": "required",
"type": "object",
"description": "It is the list of stops for the load.",
"children": [
{
"name": "stopType",
"kind": "required",
"type": "string",
"description": "It defines the function of the stop. Valid values: \"portOfLoading\", \"transshipmentPort\", etc. "
},
{
"name": "customer",
"kind": "optional",
"type": "object",
"description": "It indicates the customer information for the stop. (CM)",
"children": [
{
"name": "id",
"kind": "optional",
"type": "string",
"description": "It is the unique identifier of the shipper's customer. "
},
{
"name": "poNumbers",
"kind": "optional",
"type": "array",
"description": "It indicates the list of Customer PO Numbers associated with the load's stop. (CM)"
}
]
},
{
"name": "addressLine1",
"kind": "required",
"type": "string",
"description": "It indicates the first line of the stop's address."
},
{
"name": "city",
"kind": "required",
"type": "string",
"description": "It indicates the name of the city."
},
{
"name": "state",
"kind": "required",
"type": "string",
"description": "It indicates the 2 character state code for US & Canada and 3 Character state code for Mexico. "
},
{
"name": "country",
"kind": "optional",
"type": "string",
"description": "It indicates the valid country code. It is the 2 digit country code."
},
{
"name": "postalCode",
"kind": "optional",
"type": "string",
"description": "It indicates the valid postal code for the stop."
},
{
"name": "latitude",
"kind": "optional",
"type": "string",
"description": "It indicates the latitude of the stop's location."
},
{
"name": "longitude",
"kind": "optional",
"type": "string",
"description": "It indicates the longitude of the stop's location."
},
{
"name": "geofencePoints",
"kind": "optional",
"type": "array",
"description": "It indicates the list of lat/long coordinates of the corners of the polygon geofence around the stop to be used for detecting arrival."
},
{
"name": "externalAddressId",
"kind": "optional",
"type": "string",
"description": "It is the unique identifier of the address in FourKites. This ID is sent in place of address information. UNLOCODE is preferred for port stop creation in the FK platform."
},
{
"name": "appointmentTime",
"kind": "required",
"type": "string",
"description": "It indicates the scheduled appointment time at the stop in the stop's local time zone in ISO 8601 format. ISO 8601 format Appointment times cannot be more than 4 days in the past from the current time."
},
{
"name": "stopReferenceId",
"kind": "optional",
"type": "string",
"description": "It is the unique identifier of the stop from the customer's system. This populates the \"Reference #\" field on the stop and is used to indicate which stop an update is applied to. (CM)"
},
{
"name": "earliestAppointmentTime",
"kind": "required",
"type": "string",
"description": "It indicates the earliest scheduled arrival time at the stop in the stop's local time zone in ISO 8601 format. ISO 8601 format If earliestAppointmentTi me is sent, then latestAppointmentTime must also be sent."
},
{
"name": "latestAppointmentTime",
"kind": "required",
"type": "string",
"description": "It indicates the latest scheduled arrival time at the stop in the stop's local time zone in ISO 8601 format. ISO 8601 format If latestAppointmentTime is sent, then earliestAppointmentTi me must also be sent.vlatestAppointmentTime should be greater than or equal to earliestAppointmentTime."
},
{
"name": "wantTime",
"kind": "optional",
"type": "string",
"description": "It indicates the time by which the load must be delivered to the consignee in stop's local time zone in ISO 8601 format. (CM)"
},
{
"name": "productLineItems",
"kind": "optional",
"type": "object",
"description": "It is the list of product level details associated with a stop. Replaces the legacy pallets/parts structure going forward.",
"children": [
{
"name": "productId",
"kind": "required",
"type": "string",
"description": "Unique identifier for the product. Mandatory if productLineItems object is present"
},
{
"name": "productName",
"kind": "optional",
"type": "string",
"description": "Name of the product"
},
{
"name": "productDescription",
"kind": "optional",
"type": "string",
"description": "Detailed description of the product"
},
{
"name": "productCategory",
"kind": "optional",
"type": "string",
"description": "Category classification of the product"
},
{
"name": "quantity",
"kind": "optional",
"type": "integer",
"description": "Number of units in the shipment"
},
{
"name": "measurementUnitCode",
"kind": "optional",
"type": "string",
"description": "Unit of measurement for quantity (e.g., PCE, KG, LB)"
},
{
"name": "netWeight",
"kind": "optional",
"type": "string",
"description": "Weight of the product excluding packaging"
},
{
"name": "weightUnit",
"kind": "optional",
"type": "string",
"description": "Unit of measurement for weight (e.g., KGM, LBM)"
},
{
"name": "unitCost",
"kind": "optional",
"type": "number",
"description": "Cost per unit of the product"
},
{
"name": "currencyCode",
"kind": "optional",
"type": "string",
"description": "Currency code for cost fields"
},
{
"name": "extendedCost",
"kind": "optional",
"type": "number",
"description": "Total cost for all units (unitCost x quantity)"
},
{
"name": "freightCost",
"kind": "optional",
"type": "number",
"description": "Freight cost allocated to this line item"
},
{
"name": "bestBeforeDate",
"kind": "optional",
"type": "string",
"description": "Expiration or best before date for the product"
},
{
"name": "additionalCharges",
"kind": "optional",
"type": "number",
"description": "Any additional charges specific to this line item"
},
{
"name": "tariffCost",
"kind": "optional",
"type": "number",
"description": "Tariff cost for this specific line item"
},
{
"name": "fourKitesCalculatedTariffCost",
"kind": "optional",
"type": "number",
"description": "System-calculated tariff cost"
},
{
"name": "totalLandedCost",
"kind": "optional",
"type": "number",
"description": "Total landed cost for this line item"
},
{
"name": "countryOfOrigin",
"kind": "optional",
"type": "string",
"description": "Country of origin for this product"
},
{
"name": "harmonizedSystemCode",
"kind": "optional",
"type": "string",
"description": "International trade classification code"
},
{
"name": "commodityTypeCode",
"kind": "optional",
"type": "string",
"description": "Commodity classification code"
},
{
"name": "htsusCode",
"kind": "optional",
"type": "string",
"description": "Harmonized Tariff Schedule code for US imports"
},
{
"name": "orderNumber",
"kind": "optional",
"type": "string",
"description": "Purchase order number"
},
{
"name": "deliveryNumber",
"kind": "optional",
"type": "string",
"description": "Delivery reference number"
},
{
"name": "handlingUnitId",
"kind": "optional",
"type": "string",
"description": "Identifier for the handling unit (pallet, box, etc.)"
},
{
"name": "barcode",
"kind": "optional",
"type": "string",
"description": "Product barcode"
},
{
"name": "containerType",
"kind": "optional",
"type": "string",
"description": "Type of container (pallet, box, carton, etc.)"
},
{
"name": "gtin",
"kind": "optional",
"type": "string",
"description": "Global Trade Item Number"
},
{
"name": "customerPartNumber",
"kind": "optional",
"type": "string",
"description": "Customer's part number for the product"
},
{
"name": "supplierPartNumber",
"kind": "optional",
"type": "string",
"description": "Supplier's part number for the product"
},
{
"name": "manufacturerPartNumber",
"kind": "optional",
"type": "string",
"description": "Manufacturer's part number"
},
{
"name": "itemNumber",
"kind": "optional",
"type": "string",
"description": "Internal item number"
},
{
"name": "productUpc",
"kind": "optional",
"type": "string",
"description": "Universal Product Code"
},
{
"name": "deliveryReferences",
"kind": "optional",
"type": "string",
"description": "Array of delivery reference numbers"
},
{
"name": "orderReferences",
"kind": "optional",
"type": "string",
"description": "Array of order reference numbers"
},
{
"name": "brandName",
"kind": "optional",
"type": "string",
"description": "Brand name of the product"
},
{
"name": "minimumTemperature",
"kind": "optional",
"type": "integer",
"description": "Minimum storage/transport temperature"
},
{
"name": "maximumTemperature",
"kind": "optional",
"type": "integer",
"description": "Maximum storage/transport temperature"
},
{
"name": "temperatureUnitCode",
"kind": "optional",
"type": "string",
"description": "Temperature unit (cel, fah)"
},
{
"name": "labelIdentifier",
"kind": "optional",
"type": "string",
"description": "Label identifier for tracking"
},
{
"name": "productTrackingNumber",
"kind": "optional",
"type": "string",
"description": "Unique tracking number for the product"
},
{
"name": "deviceType",
"kind": "optional",
"type": "string",
"description": "Type of tracking device (RFID_TAG, QR_CODE, etc.)"
}
]
}
]
}
]
}
],
"formDataParameters": []
},
"currentNewParameter": {
"label": "Body Parameter",
"value": "bodyDataParameters"
},
"hasTryItOut": false,
"autoGeneratedAnchorSlug": "azure-production",
"legacyHash": "Td_l3-jbN_E_cIa6NnVj0"
}
```
:::
:::ApiMethodV2
```json
{
"name": "Azure - Staging",
"method": "POST",
"url": "https://api-staging.ng.fourkites.com/api/v1/tracking",
"description": "",
"tab": "examples",
"examples": {
"languages": [
{
"id": "oXTLt8IGOBlfw2e4XGI96",
"language": "curl",
"code": "curl --location --request POST 'https://api-staging.ng.fourkites.com/api/v1/tracking' \\\n--header 'Content-Type: application/json' \\\n--header 'apikey: REPLACE_KEY_VALUE' \\\n--data-raw '{\n \"trackingInfo\": {\n \"driverPhone\": \"\",\n \"truckNumber\": \"\",\n \"vesselName\": \"\",\n \"imo\": \"\",\n \"mmsi\": \"\",\n \"containerNumber\": \"OOLU4404637\"\n },\n \"containerInfo\": {\n \"containerNumber\": \"OOLU4404637\"\n },\n \"load\": {\n \"loadNumber\": \"stop_completion_1\",\n \"priority\": \"normal\",\n \"operatingCarrierScac\": null,\n \"carrier\": \"1234\",\n \"carrierName\": \"\",\n \"carrierPermalink\": \"oceancarrier\",\n \"products\": [],\n \"bookingNumber\": \"\",\n \"trackingNumber\": \"\",\n \"billOfLading\": \"GOA230437868\",\n \"referenceNumbers\": [],\n \"stops\": [\n {\n \"stopType\": \"portOfLoading\",\n \"customer\": {\n \"id\": null,\n \"originalCustomerId\": null,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"INMAA\",\n \"appointmentTime\": null,\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": null,\n \"latestAppointmentTime\": null,\n \"estimatedDepartureTime\": \"2023-07-20T06:00:00\",\n \"wantTime\": null,\n \"productLineItems\": [\n {\n \"productId\": \"0123456\",\n \"productName\": \"Ocean Freight Item\",\n \"productDescription\": \"Port-to-port ocean shipment item\",\n \"productCategory\": \"General Freight\",\n \"quantity\": 25,\n \"measurementUnitCode\": \"PCE\",\n \"netWeight\": 44.8,\n \"weightUnit\": \"KGM\",\n \"unitCost\": 25.0,\n \"currencyCode\": \"USD\",\n \"extendedCost\": 625.00,\n \"freightCost\": 20.00,\n \"additionalCharges\": 5.00,\n \"tariffCost\": 2.50,\n \"fourKitesCalculatedTariffCost\": 2.50,\n \"totalLandedCost\": 655.00,\n \"countryOfOrigin\": \"IN\",\n \"harmonizedSystemCode\": \"8471499000\",\n \"commodityTypeCode\": \"OCEAN_FREIGHT\",\n \"htsusCode\": \"8471499000\",\n \"orderNumber\": \"GOA230437868\",\n \"deliveryNumber\": \"DN-INMAA\",\n \"handlingUnitId\": \"PAL-INMAA\",\n \"barcode\": \"PALINMAA\",\n \"containerType\": \"pallet\",\n \"gtin\": \"00012345678905\",\n \"customerPartNumber\": \"22EE\",\n \"supplierPartNumber\": \"22EE\",\n \"manufacturerPartNumber\": \"MFG-22EE\",\n \"itemNumber\": \"ITM-22EE\",\n \"productUpc\": \"012345678905\",\n \"deliveryReferences\": [\"OOLU4404637\"],\n \"orderReferences\": [\"GOA230437868\"],\n \"brandName\": \"Generic Ocean Freight Co\",\n \"minimumTemperature\": 0,\n \"maximumTemperature\": 0,\n \"temperatureUnitCode\": \"cel\",\n \"labelIdentifier\": \"LBL-22EE\",\n \"productTrackingNumber\": \"OOLU4404637-1\",\n \"deviceType\": \"RFID_TAG\"\n }\n ]\n },\n {\n \"stopType\": \"transshipmentPort\",\n \"customer\": {\n \"id\": null,\n \"originalCustomerId\": null,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"SGSIN\",\n \"appointmentTime\": null,\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": \"2023-07-21T06:00:00\",\n \"latestAppointmentTime\": \"2023-07-21T16:00:00\",\n \"wantTime\": null,\n \"productLineItems\": [\n {\n \"productId\": \"0123456\",\n \"productName\": \"Ocean Freight Item\",\n \"productDescription\": \"Port-to-port ocean shipment item\",\n \"productCategory\": \"General Freight\",\n \"quantity\": 25,\n \"measurementUnitCode\": \"PCE\",\n \"netWeight\": 44.8,\n \"weightUnit\": \"KGM\",\n \"unitCost\": 25.0,\n \"currencyCode\": \"USD\",\n \"extendedCost\": 625.00,\n \"freightCost\": 20.00,\n \"additionalCharges\": 5.00,\n \"tariffCost\": 2.50,\n \"fourKitesCalculatedTariffCost\": 2.50,\n \"totalLandedCost\": 655.00,\n \"countryOfOrigin\": \"IN\",\n \"harmonizedSystemCode\": \"8471499000\",\n \"commodityTypeCode\": \"OCEAN_FREIGHT\",\n \"htsusCode\": \"8471499000\",\n \"orderNumber\": \"GOA230437868\",\n \"deliveryNumber\": \"DN-INMAA\",\n \"handlingUnitId\": \"PAL-INMAA\",\n \"barcode\": \"PALINMAA\",\n \"containerType\": \"pallet\",\n \"gtin\": \"00012345678905\",\n \"customerPartNumber\": \"22EE\",\n \"supplierPartNumber\": \"22EE\",\n \"manufacturerPartNumber\": \"MFG-22EE\",\n \"itemNumber\": \"ITM-22EE\",\n \"productUpc\": \"012345678905\",\n \"deliveryReferences\": [\"OOLU4404637\"],\n \"orderReferences\": [\"GOA230437868\"],\n \"brandName\": \"Generic Ocean Freight Co\",\n \"minimumTemperature\": 0,\n \"maximumTemperature\": 0,\n \"temperatureUnitCode\": \"cel\",\n \"labelIdentifier\": \"LBL-22EE\",\n \"productTrackingNumber\": \"OOLU4404637-1\",\n \"deviceType\": \"RFID_TAG\"\n }\n ]\n },\n {\n \"stopType\": \"portOfDischarge\",\n \"customer\": {\n \"id\": null,\n \"originalCustomerId\": null,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"USJAX\",\n \"appointmentTime\": \"2024-03-31T16:00:00\",\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": null,\n \"latestAppointmentTime\": null,\n \"wantTime\": null,\n \"productLineItems\": [\n {\n \"productId\": \"0123456\",\n \"productName\": \"Ocean Freight Item\",\n \"productDescription\": \"Port-to-port ocean shipment item\",\n \"productCategory\": \"General Freight\",\n \"quantity\": 25,\n \"measurementUnitCode\": \"PCE\",\n \"netWeight\": 44.8,\n \"weightUnit\": \"KGM\",\n \"unitCost\": 25.0,\n \"currencyCode\": \"USD\",\n \"extendedCost\": 625.00,\n \"freightCost\": 20.00,\n \"additionalCharges\": 5.00,\n \"tariffCost\": 2.50,\n \"fourKitesCalculatedTariffCost\": 2.50,\n \"totalLandedCost\": 655.00,\n \"countryOfOrigin\": \"IN\",\n \"harmonizedSystemCode\": \"8471499000\",\n \"commodityTypeCode\": \"OCEAN_FREIGHT\",\n \"htsusCode\": \"8471499000\",\n \"orderNumber\": \"GOA230437868\",\n \"deliveryNumber\": \"DN-USJAX\",\n \"handlingUnitId\": \"PAL-USJAX\",\n \"barcode\": \"PALUSJAX\",\n \"containerType\": \"pallet\",\n \"gtin\": \"00012345678905\",\n \"customerPartNumber\": \"22EE\",\n \"supplierPartNumber\": \"22EE\",\n \"manufacturerPartNumber\": \"MFG-22EE\",\n \"itemNumber\": \"ITM-22EE\",\n \"productUpc\": \"012345678905\",\n \"deliveryReferences\": [\"OOLU4404637\"],\n \"orderReferences\": [\"GOA230437868\"],\n \"brandName\": \"Generic Ocean Freight Co\",\n \"minimumTemperature\": 0,\n \"maximumTemperature\": 0,\n \"temperatureUnitCode\": \"cel\",\n \"labelIdentifier\": \"LBL-22EE\",\n \"productTrackingNumber\": \"OOLU4404637-3\",\n \"deviceType\": \"QR_CODE\"\n }\n ]\n }\n ]\n }\n}'",
"customLabel": ""
},
{
"id": "R9fUapNeQ5A5Ft6WMmxI2",
"language": "java",
"code": "OkHttpClient client = new OkHttpClient().newBuilder()\n .build();\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\n \\\"trackingInfo\\\": {\\n \\\"driverPhone\\\": \\\"\\\",\\n \\\"truckNumber\\\": \\\"\\\",\\n \\\"vesselName\\\": \\\"\\\",\\n \\\"imo\\\": \\\"\\\",\\n \\\"mmsi\\\": \\\"\\\",\\n \\\"containerNumber\\\": \\\"OOLU4404637\\\"\\n },\\n \\\"containerInfo\\\": {\\n \\\"containerNumber\\\": \\\"OOLU4404637\\\"\\n },\\n \\\"load\\\": {\\n \\\"loadNumber\\\": \\\"stop_completion_1\\\",\\n \\\"priority\\\": \\\"normal\\\",\\n \\\"operatingCarrierScac\\\": null,\\n \\\"carrier\\\": \\\"1234\\\",\\n \\\"carrierName\\\": \\\"\\\",\\n \\\"carrierPermalink\\\": \\\"oceancarrier\\\",\\n \\\"products\\\": [],\\n \\\"bookingNumber\\\": \\\"\\\",\\n \\\"trackingNumber\\\": \\\"\\\",\\n \\\"billOfLading\\\": \\\"GOA230437868\\\",\\n \\\"referenceNumbers\\\": [],\\n \\\"stops\\\": [\\n {\\n \\\"stopType\\\": \\\"portOfLoading\\\",\\n \\\"customer\\\": {\\n \\\"id\\\": null,\\n \\\"originalCustomerId\\\": null,\\n \\\"poNumbers\\\": []\\n },\\n \\\"addressLine1\\\": \\\"\\\",\\n \\\"city\\\": \\\"\\\",\\n \\\"state\\\": \\\"\\\",\\n \\\"country\\\": \\\"\\\",\\n \\\"postalCode\\\": \\\"\\\",\\n \\\"latitude\\\": \\\"\\\",\\n \\\"longitude\\\": \\\"\\\",\\n \\\"geofencePoints\\\": [],\\n \\\"externalAddressId\\\": \\\"INMAA\\\",\\n \\\"appointmentTime\\\": null,\\n \\\"stopReferenceId\\\": \\\"\\\",\\n \\\"earliestAppointmentTime\\\": null,\\n \\\"latestAppointmentTime\\\": null,\\n \\\"estimatedDepartureTime\\\": \\\"2023-07-20T06:00:00\\\",\\n \\\"wantTime\\\": null\\n },\\n {\\n \\\"stopType\\\": \\\"transshipmentPort\\\",\\n \\\"customer\\\": {\\n \\\"id\\\": null,\\n \\\"originalCustomerId\\\": null,\\n \\\"poNumbers\\\": []\\n },\\n \\\"addressLine1\\\": \\\"\\\",\\n \\\"city\\\": \\\"\\\",\\n \\\"state\\\": \\\"\\\",\\n \\\"country\\\": \\\"\\\",\\n \\\"postalCode\\\": \\\"\\\",\\n \\\"latitude\\\": \\\"\\\",\\n \\\"longitude\\\": \\\"\\\",\\n \\\"geofencePoints\\\": [],\\n \\\"externalAddressId\\\": \\\"SGSIN\\\",\\n \\\"appointmentTime\\\": null,\\n \\\"stopReferenceId\\\": \\\"\\\",\\n \\\"earliestAppointmentTime\\\": \\\"2023-07-21T06:00:00\\\",\\n \\\"latestAppointmentTime\\\": \\\"2023-07-21T16:00:00\\\",\\n \\\"wantTime\\\": null\\n },\\n {\\n \\\"stopType\\\": \\\"portOfDischarge\\\",\\n \\\"customer\\\": {\\n \\\"id\\\": null,\\n \\\"originalCustomerId\\\": null,\\n \\\"poNumbers\\\": []\\n },\\n \\\"addressLine1\\\": \\\"\\\",\\n \\\"city\\\": \\\"\\\",\\n \\\"state\\\": \\\"\\\",\\n \\\"country\\\": \\\"\\\",\\n \\\"postalCode\\\": \\\"\\\",\\n \\\"latitude\\\": \\\"\\\",\\n \\\"longitude\\\": \\\"\\\",\\n \\\"geofencePoints\\\": [],\\n \\\"externalAddressId\\\": \\\"USJAX\\\",\\n \\\"appointmentTime\\\": \\\"2024-03-31T16:00:00\\\",\\n \\\"stopReferenceId\\\": \\\"\\\",\\n \\\"earliestAppointmentTime\\\": null,\\n \\\"latestAppointmentTime\\\": null,\\n \\\"wantTime\\\": null\\n }\\n ]\\n }\\n}\");\nRequest request = new Request.Builder()\n .url(\"https://api-staging.ng.fourkites.com/api/v1/tracking\")\n .method(\"POST\", body)\n .addHeader(\"Content-Type\", \"application/json\")\n .addHeader(\"apikey\", \"REPLACE_KEY_VALUE\")\n .build();\nResponse response = client.newCall(request).execute();",
"customLabel": ""
},
{
"id": "qT5uNZIqgUvY8TitfBixf",
"language": "javascript",
"code": "var settings = {\n \"url\": \"https://api-staging.ng.fourkites.com/api/v1/tracking\",\n \"method\": \"POST\",\n \"timeout\": 0,\n \"headers\": {\n \"Content-Type\": \"application/json\",\n \"apikey\": \"REPLACE_KEY_VALUE\"\n },\n \"data\": JSON.stringify({\n \"trackingInfo\": {\n \"driverPhone\": \"\",\n \"truckNumber\": \"\",\n \"vesselName\": \"\",\n \"imo\": \"\",\n \"mmsi\": \"\",\n \"containerNumber\": \"OOLU4404637\"\n },\n \"containerInfo\": {\n \"containerNumber\": \"OOLU4404637\"\n },\n \"load\": {\n \"loadNumber\": \"stop_completion_1\",\n \"priority\": \"normal\",\n \"operatingCarrierScac\": null,\n \"carrier\": \"1234\",\n \"carrierName\": \"\",\n \"carrierPermalink\": \"oceancarrier\",\n \"products\": [],\n \"bookingNumber\": \"\",\n \"trackingNumber\": \"\",\n \"billOfLading\": \"GOA230437868\",\n \"referenceNumbers\": [],\n \"stops\": [\n {\n \"stopType\": \"portOfLoading\",\n \"customer\": {\n \"id\": null,\n \"originalCustomerId\": null,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"INMAA\",\n \"appointmentTime\": null,\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": null,\n \"latestAppointmentTime\": null,\n \"estimatedDepartureTime\": \"2023-07-20T06:00:00\",\n \"wantTime\": null\n },\n {\n \"stopType\": \"transshipmentPort\",\n \"customer\": {\n \"id\": null,\n \"originalCustomerId\": null,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"SGSIN\",\n \"appointmentTime\": null,\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": \"2023-07-21T06:00:00\",\n \"latestAppointmentTime\": \"2023-07-21T16:00:00\",\n \"wantTime\": null\n },\n {\n \"stopType\": \"portOfDischarge\",\n \"customer\": {\n \"id\": null,\n \"originalCustomerId\": null,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"USJAX\",\n \"appointmentTime\": \"2024-03-31T16:00:00\",\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": null,\n \"latestAppointmentTime\": null,\n \"wantTime\": null\n }\n ]\n }\n }),\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});",
"customLabel": ""
},
{
"id": "mViRMiSR81WSzY3jgFUSE",
"language": "swift",
"code": "import Foundation\n#if canImport(FoundationNetworking)\nimport FoundationNetworking\n#endif\n\nvar semaphore = DispatchSemaphore (value: 0)\n\nlet parameters = \"{\\n \\\"trackingInfo\\\": {\\n \\\"driverPhone\\\": \\\"\\\",\\n \\\"truckNumber\\\": \\\"\\\",\\n \\\"vesselName\\\": \\\"\\\",\\n \\\"imo\\\": \\\"\\\",\\n \\\"mmsi\\\": \\\"\\\",\\n \\\"containerNumber\\\": \\\"OOLU4404637\\\"\\n },\\n \\\"containerInfo\\\": {\\n \\\"containerNumber\\\": \\\"OOLU4404637\\\"\\n },\\n \\\"load\\\": {\\n \\\"loadNumber\\\": \\\"stop_completion_1\\\",\\n \\\"priority\\\": \\\"normal\\\",\\n \\\"operatingCarrierScac\\\": null,\\n \\\"carrier\\\": \\\"1234\\\",\\n \\\"carrierName\\\": \\\"\\\",\\n \\\"carrierPermalink\\\": \\\"oceancarrier\\\",\\n \\\"products\\\": [],\\n \\\"bookingNumber\\\": \\\"\\\",\\n \\\"trackingNumber\\\": \\\"\\\",\\n \\\"billOfLading\\\": \\\"GOA230437868\\\",\\n \\\"referenceNumbers\\\": [],\\n \\\"stops\\\": [\\n {\\n \\\"stopType\\\": \\\"portOfLoading\\\",\\n \\\"customer\\\": {\\n \\\"id\\\": null,\\n \\\"originalCustomerId\\\": null,\\n \\\"poNumbers\\\": []\\n },\\n \\\"addressLine1\\\": \\\"\\\",\\n \\\"city\\\": \\\"\\\",\\n \\\"state\\\": \\\"\\\",\\n \\\"country\\\": \\\"\\\",\\n \\\"postalCode\\\": \\\"\\\",\\n \\\"latitude\\\": \\\"\\\",\\n \\\"longitude\\\": \\\"\\\",\\n \\\"geofencePoints\\\": [],\\n \\\"externalAddressId\\\": \\\"INMAA\\\",\\n \\\"appointmentTime\\\": null,\\n \\\"stopReferenceId\\\": \\\"\\\",\\n \\\"earliestAppointmentTime\\\": null,\\n \\\"latestAppointmentTime\\\": null,\\n \\\"estimatedDepartureTime\\\": \\\"2023-07-20T06:00:00\\\",\\n \\\"wantTime\\\": null\\n },\\n {\\n \\\"stopType\\\": \\\"transshipmentPort\\\",\\n \\\"customer\\\": {\\n \\\"id\\\": null,\\n \\\"originalCustomerId\\\": null,\\n \\\"poNumbers\\\": []\\n },\\n \\\"addressLine1\\\": \\\"\\\",\\n \\\"city\\\": \\\"\\\",\\n \\\"state\\\": \\\"\\\",\\n \\\"country\\\": \\\"\\\",\\n \\\"postalCode\\\": \\\"\\\",\\n \\\"latitude\\\": \\\"\\\",\\n \\\"longitude\\\": \\\"\\\",\\n \\\"geofencePoints\\\": [],\\n \\\"externalAddressId\\\": \\\"SGSIN\\\",\\n \\\"appointmentTime\\\": null,\\n \\\"stopReferenceId\\\": \\\"\\\",\\n \\\"earliestAppointmentTime\\\": \\\"2023-07-21T06:00:00\\\",\\n \\\"latestAppointmentTime\\\": \\\"2023-07-21T16:00:00\\\",\\n \\\"wantTime\\\": null\\n },\\n {\\n \\\"stopType\\\": \\\"portOfDischarge\\\",\\n \\\"customer\\\": {\\n \\\"id\\\": null,\\n \\\"originalCustomerId\\\": null,\\n \\\"poNumbers\\\": []\\n },\\n \\\"addressLine1\\\": \\\"\\\",\\n \\\"city\\\": \\\"\\\",\\n \\\"state\\\": \\\"\\\",\\n \\\"country\\\": \\\"\\\",\\n \\\"postalCode\\\": \\\"\\\",\\n \\\"latitude\\\": \\\"\\\",\\n \\\"longitude\\\": \\\"\\\",\\n \\\"geofencePoints\\\": [],\\n \\\"externalAddressId\\\": \\\"USJAX\\\",\\n \\\"appointmentTime\\\": \\\"2024-03-31T16:00:00\\\",\\n \\\"stopReferenceId\\\": \\\"\\\",\\n \\\"earliestAppointmentTime\\\": null,\\n \\\"latestAppointmentTime\\\": null,\\n \\\"wantTime\\\": null\\n }\\n ]\\n }\\n}\"\nlet postData = parameters.data(using: .utf8)\n\nvar request = URLRequest(url: URL(string: \"https://api-staging.ng.fourkites.com/api/v1/tracking\")!,timeoutInterval: Double.infinity)\nrequest.addValue(\"application/json\", forHTTPHeaderField: \"Content-Type\")\nrequest.addValue(\"REPLACE_KEY_VALUE\", 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 semaphore.signal()\n return\n }\n print(String(data: data, encoding: .utf8)!)\n semaphore.signal()\n}\n\ntask.resume()\nsemaphore.wait()\n",
"customLabel": ""
},
{
"id": "jzpSj1-UF6Wq5Uwg3WWQY",
"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.ng.fourkites.com/api/v1/tracking\"\n method := \"POST\"\n\n payload := strings.NewReader(`{\n \"trackingInfo\": {\n \"driverPhone\": \"\",\n \"truckNumber\": \"\",\n \"vesselName\": \"\",\n \"imo\": \"\",\n \"mmsi\": \"\",\n \"containerNumber\": \"OOLU4404637\"\n },\n \"containerInfo\": {\n \"containerNumber\": \"OOLU4404637\"\n },\n \"load\": {\n \"loadNumber\": \"stop_completion_1\",\n \"priority\": \"normal\",\n \"operatingCarrierScac\": null,\n \"carrier\": \"1234\",\n \"carrierName\": \"\",\n \"carrierPermalink\": \"oceancarrier\",\n \"products\": [],\n \"bookingNumber\": \"\",\n \"trackingNumber\": \"\",\n \"billOfLading\": \"GOA230437868\",\n \"referenceNumbers\": [],\n \"stops\": [\n {\n \"stopType\": \"portOfLoading\",\n \"customer\": {\n \"id\": null,\n \"originalCustomerId\": null,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"INMAA\",\n \"appointmentTime\": null,\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": null,\n \"latestAppointmentTime\": null,\n \"estimatedDepartureTime\": \"2023-07-20T06:00:00\",\n \"wantTime\": null\n },\n {\n \"stopType\": \"transshipmentPort\",\n \"customer\": {\n \"id\": null,\n \"originalCustomerId\": null,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"SGSIN\",\n \"appointmentTime\": null,\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": \"2023-07-21T06:00:00\",\n \"latestAppointmentTime\": \"2023-07-21T16:00:00\",\n \"wantTime\": null\n },\n {\n \"stopType\": \"portOfDischarge\",\n \"customer\": {\n \"id\": null,\n \"originalCustomerId\": null,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"USJAX\",\n \"appointmentTime\": \"2024-03-31T16:00:00\",\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": null,\n \"latestAppointmentTime\": null,\n \"wantTime\": null\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\", \"REPLACE_KEY_VALUE\")\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}",
"customLabel": ""
},
{
"id": "sGD0P46h2XeSoAQyeN5-Q",
"language": "csharp",
"code": "var client = new RestClient(\"https://api-staging.ng.fourkites.com/api/v1/tracking\");\nclient.Timeout = -1;\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nrequest.AddHeader(\"apikey\", \"REPLACE_KEY_VALUE\");\nvar body = @\"{\" + \"\\n\" +\n@\" \"\"trackingInfo\"\": {\" + \"\\n\" +\n@\" \"\"driverPhone\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"truckNumber\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"vesselName\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"imo\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"mmsi\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"containerNumber\"\": \"\"OOLU4404637\"\"\" + \"\\n\" +\n@\" },\" + \"\\n\" +\n@\" \"\"containerInfo\"\": {\" + \"\\n\" +\n@\" \"\"containerNumber\"\": \"\"OOLU4404637\"\"\" + \"\\n\" +\n@\" },\" + \"\\n\" +\n@\" \"\"load\"\": {\" + \"\\n\" +\n@\" \"\"loadNumber\"\": \"\"stop_completion_1\"\",\" + \"\\n\" +\n@\" \"\"priority\"\": \"\"normal\"\",\" + \"\\n\" +\n@\" \"\"operatingCarrierScac\"\": null,\" + \"\\n\" +\n@\" \"\"carrier\"\": \"\"1234\"\",\" + \"\\n\" +\n@\" \"\"carrierName\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"carrierPermalink\"\": \"\"oceancarrier\"\",\" + \"\\n\" +\n@\" \"\"products\"\": [],\" + \"\\n\" +\n@\" \"\"bookingNumber\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"trackingNumber\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"billOfLading\"\": \"\"GOA230437868\"\",\" + \"\\n\" +\n@\" \"\"referenceNumbers\"\": [],\" + \"\\n\" +\n@\" \"\"stops\"\": [\" + \"\\n\" +\n@\" {\" + \"\\n\" +\n@\" \"\"stopType\"\": \"\"portOfLoading\"\",\" + \"\\n\" +\n@\" \"\"customer\"\": {\" + \"\\n\" +\n@\" \"\"id\"\": null,\" + \"\\n\" +\n@\" \"\"originalCustomerId\"\": null,\" + \"\\n\" +\n@\" \"\"poNumbers\"\": []\" + \"\\n\" +\n@\" },\" + \"\\n\" +\n@\" \"\"addressLine1\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"city\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"state\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"country\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"postalCode\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"latitude\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"longitude\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"geofencePoints\"\": [],\" + \"\\n\" +\n@\" \"\"externalAddressId\"\": \"\"INMAA\"\",\" + \"\\n\" +\n@\" \"\"appointmentTime\"\": null,\" + \"\\n\" +\n@\" \"\"stopReferenceId\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"earliestAppointmentTime\"\": null,\" + \"\\n\" +\n@\" \"\"latestAppointmentTime\"\": null,\" + \"\\n\" +\n@\" \"\"estimatedDepartureTime\"\": \"\"2023-07-20T06:00:00\"\",\" + \"\\n\" +\n@\" \"\"wantTime\"\": null\" + \"\\n\" +\n@\" },\" + \"\\n\" +\n@\" {\" + \"\\n\" +\n@\" \"\"stopType\"\": \"\"transshipmentPort\"\",\" + \"\\n\" +\n@\" \"\"customer\"\": {\" + \"\\n\" +\n@\" \"\"id\"\": null,\" + \"\\n\" +\n@\" \"\"originalCustomerId\"\": null,\" + \"\\n\" +\n@\" \"\"poNumbers\"\": []\" + \"\\n\" +\n@\" },\" + \"\\n\" +\n@\" \"\"addressLine1\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"city\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"state\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"country\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"postalCode\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"latitude\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"longitude\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"geofencePoints\"\": [],\" + \"\\n\" +\n@\" \"\"externalAddressId\"\": \"\"SGSIN\"\",\" + \"\\n\" +\n@\" \"\"appointmentTime\"\": null,\" + \"\\n\" +\n@\" \"\"stopReferenceId\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"earliestAppointmentTime\"\": \"\"2023-07-21T06:00:00\"\",\" + \"\\n\" +\n@\" \"\"latestAppointmentTime\"\": \"\"2023-07-21T16:00:00\"\",\" + \"\\n\" +\n@\" \"\"wantTime\"\": null\" + \"\\n\" +\n@\" },\" + \"\\n\" +\n@\" {\" + \"\\n\" +\n@\" \"\"stopType\"\": \"\"portOfDischarge\"\",\" + \"\\n\" +\n@\" \"\"customer\"\": {\" + \"\\n\" +\n@\" \"\"id\"\": null,\" + \"\\n\" +\n@\" \"\"originalCustomerId\"\": null,\" + \"\\n\" +\n@\" \"\"poNumbers\"\": []\" + \"\\n\" +\n@\" },\" + \"\\n\" +\n@\" \"\"addressLine1\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"city\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"state\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"country\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"postalCode\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"latitude\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"longitude\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"geofencePoints\"\": [],\" + \"\\n\" +\n@\" \"\"externalAddressId\"\": \"\"USJAX\"\",\" + \"\\n\" +\n@\" \"\"appointmentTime\"\": \"\"2024-03-31T16:00:00\"\",\" + \"\\n\" +\n@\" \"\"stopReferenceId\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"earliestAppointmentTime\"\": null,\" + \"\\n\" +\n@\" \"\"latestAppointmentTime\"\": null,\" + \"\\n\" +\n@\" \"\"wantTime\"\": null\" + \"\\n\" +\n@\" }\" + \"\\n\" +\n@\" ]\" + \"\\n\" +\n@\" }\" + \"\\n\" +\n@\"}\";\nrequest.AddParameter(\"application/json\", body, ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);\nConsole.WriteLine(response.Content);",
"customLabel": ""
},
{
"id": "l7iv2Zqs8dxiFMECmyUzF",
"language": "ruby",
"code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api-staging.ng.fourkites.com/api/v1/tracking\")\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\"] = \"REPLACE_KEY_VALUE\"\nrequest.body = JSON.dump({\n \"trackingInfo\": {\n \"driverPhone\": \"\",\n \"truckNumber\": \"\",\n \"vesselName\": \"\",\n \"imo\": \"\",\n \"mmsi\": \"\",\n \"containerNumber\": \"OOLU4404637\"\n },\n \"containerInfo\": {\n \"containerNumber\": \"OOLU4404637\"\n },\n \"load\": {\n \"loadNumber\": \"stop_completion_1\",\n \"priority\": \"normal\",\n \"operatingCarrierScac\": nil,\n \"carrier\": \"1234\",\n \"carrierName\": \"\",\n \"carrierPermalink\": \"oceancarrier\",\n \"products\": [],\n \"bookingNumber\": \"\",\n \"trackingNumber\": \"\",\n \"billOfLading\": \"GOA230437868\",\n \"referenceNumbers\": [],\n \"stops\": [\n {\n \"stopType\": \"portOfLoading\",\n \"customer\": {\n \"id\": nil,\n \"originalCustomerId\": nil,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"INMAA\",\n \"appointmentTime\": nil,\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": nil,\n \"latestAppointmentTime\": nil,\n \"estimatedDepartureTime\": \"2023-07-20T06:00:00\",\n \"wantTime\": nil\n },\n {\n \"stopType\": \"transshipmentPort\",\n \"customer\": {\n \"id\": nil,\n \"originalCustomerId\": nil,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"SGSIN\",\n \"appointmentTime\": nil,\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": \"2023-07-21T06:00:00\",\n \"latestAppointmentTime\": \"2023-07-21T16:00:00\",\n \"wantTime\": nil\n },\n {\n \"stopType\": \"portOfDischarge\",\n \"customer\": {\n \"id\": nil,\n \"originalCustomerId\": nil,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"USJAX\",\n \"appointmentTime\": \"2024-03-31T16:00:00\",\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": nil,\n \"latestAppointmentTime\": nil,\n \"wantTime\": nil\n }\n ]\n }\n})\n\nresponse = https.request(request)\nputs response.read_body\n",
"customLabel": ""
},
{
"id": "HCOaGqoQDZrRW3y4fbQiw",
"language": "python",
"code": "import http.client\nimport json\n\nconn = http.client.HTTPSConnection(\"api-staging.ng.fourkites.com\")\npayload = json.dumps({\n \"trackingInfo\": {\n \"driverPhone\": \"\",\n \"truckNumber\": \"\",\n \"vesselName\": \"\",\n \"imo\": \"\",\n \"mmsi\": \"\",\n \"containerNumber\": \"OOLU4404637\"\n },\n \"containerInfo\": {\n \"containerNumber\": \"OOLU4404637\"\n },\n \"load\": {\n \"loadNumber\": \"stop_completion_1\",\n \"priority\": \"normal\",\n \"operatingCarrierScac\": None,\n \"carrier\": \"1234\",\n \"carrierName\": \"\",\n \"carrierPermalink\": \"oceancarrier\",\n \"products\": [],\n \"bookingNumber\": \"\",\n \"trackingNumber\": \"\",\n \"billOfLading\": \"GOA230437868\",\n \"referenceNumbers\": [],\n \"stops\": [\n {\n \"stopType\": \"portOfLoading\",\n \"customer\": {\n \"id\": None,\n \"originalCustomerId\": None,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"INMAA\",\n \"appointmentTime\": None,\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": None,\n \"latestAppointmentTime\": None,\n \"estimatedDepartureTime\": \"2023-07-20T06:00:00\",\n \"wantTime\": None\n },\n {\n \"stopType\": \"transshipmentPort\",\n \"customer\": {\n \"id\": None,\n \"originalCustomerId\": None,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"SGSIN\",\n \"appointmentTime\": None,\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": \"2023-07-21T06:00:00\",\n \"latestAppointmentTime\": \"2023-07-21T16:00:00\",\n \"wantTime\": None\n },\n {\n \"stopType\": \"portOfDischarge\",\n \"customer\": {\n \"id\": None,\n \"originalCustomerId\": None,\n \"poNumbers\": []\n },\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"geofencePoints\": [],\n \"externalAddressId\": \"USJAX\",\n \"appointmentTime\": \"2024-03-31T16:00:00\",\n \"stopReferenceId\": \"\",\n \"earliestAppointmentTime\": None,\n \"latestAppointmentTime\": None,\n \"wantTime\": None\n }\n ]\n }\n})\nheaders = {\n 'Content-Type': 'application/json',\n 'apikey': 'REPLACE_KEY_VALUE'\n}\nconn.request(\"POST\", \"/api/v1/tracking\", payload, headers)\nres = conn.getresponse()\ndata = res.read()\nprint(data.decode(\"utf-8\"))",
"customLabel": ""
}
],
"selectedLanguageId": "HCOaGqoQDZrRW3y4fbQiw"
},
"results": {
"languages": [
{
"id": "Fgv8UpRlPL46aMGyQwH3T",
"language": "200",
"customLabel": "",
"code": "{\n \"statusCode\": 200,\n \"message\": \"Load creation request has been submitted successfully\",\n \"loadId\": 176366208\n}"
}
],
"selectedLanguageId": "Fgv8UpRlPL46aMGyQwH3T"
},
"request": {
"pathParameters": [],
"queryParameters": [],
"headerParameters": [],
"bodyDataParameters": [
{
"name": "trackingInfo",
"kind": "optional",
"type": "object",
"description": "It indicates the information required for tracking the load.",
"children": [
{
"name": "driverPhone",
"kind": "optional",
"type": "string",
"description": "It indicates a valid mobile number. Example: +13125555555"
},
{
"name": "truckNumber",
"kind": "optional",
"type": "string",
"description": "It indicates the tractor or asset number dispatched by the carrier for the load."
},
{
"name": "vesselName",
"kind": "optional",
"type": "string",
"description": "It indicates the name of the vessel carrying the load."
},
{
"name": "imo",
"kind": "optional",
"type": "string",
"description": "It indicates the international maritime organization number."
},
{
"name": "mmsi",
"kind": "optional",
"type": "string",
"description": "It indicates the Maritime Mobile Service Identity (MMSI) of the vessel."
},
{
"name": "containerNumber",
"kind": "required",
"type": "string",
"description": "It indicates the number of the container that is on the vessel. ISO6346 format."
}
]
},
{
"name": "containerInfo",
"kind": "optional",
"type": "object",
"description": "It indicates the information required for tracking the load.",
"children": [
{
"name": "containerNumber",
"kind": "required",
"type": "string",
"description": "It indicates the number of the container that is on the vessel."
}
]
},
{
"name": "load",
"kind": "optional",
"type": "object",
"description": "It is the parent object for the load. Place the load attributes inside this object.",
"children": [
{
"name": "loadNumber",
"kind": "required",
"type": "string",
"description": "It is the unique load identifier from shipper's system. The load Number or BOL is an important piece of information used to link the load with truck information received from the Carrier's TMS."
},
{
"name": "priority",
"kind": "optional",
"type": "string",
"description": "It indicates whether a load is of normal or high priority. If priority is set as ‘hot’, the load will be marked as ‘Hot’. Valid values: ‘normal’, ‘high’ and ‘hot’. Defaults to normal. Setting the 'Priority' as 'hot' will mark the load as 'Hot' load."
},
{
"name": "operatingCarrierScac",
"kind": "optional",
"type": "string",
"description": "SCAC or code of the operating carrier if setting up managing/operating carrier"
},
{
"name": "carrier",
"kind": "required",
"type": "string",
"description": "It is the SCAC or Service Provider ID of the carrier assigned to the load. The carrier should have approved sharing of their telematics data on FourKites® for the customer."
},
{
"name": "products",
"kind": "optional",
"type": "object",
"description": "It indicates the list of temperature tracked products on a load and their temperature tracking information."
},
{
"name": "bookingNumber",
"kind": "optional",
"type": "string",
"description": "It indicates the shipping line's booking number."
},
{
"name": "billOfLading",
"kind": "optional",
"type": "string",
"description": "It indicates the bill of lading associated with the Ocean load."
},
{
"name": "referenceNumbers",
"kind": "optional",
"type": "array",
"description": "It is the list of load level reference numbers associated with a load. (CM)"
},
{
"name": "stops",
"kind": "required",
"type": "object",
"description": "It is the list of stops for the load.",
"children": [
{
"name": "stopType",
"kind": "required",
"type": "string",
"description": "It defines the function of the stop. Valid values: \"portOfLoading\", \"transshipmentPort\", etc. "
},
{
"name": "customer",
"kind": "optional",
"type": "object",
"description": "It indicates the customer information for the stop. (CM)",
"children": [
{
"name": "id",
"kind": "optional",
"type": "string",
"description": "It is the unique identifier of the shipper's customer. "
},
{
"name": "poNumbers",
"kind": "optional",
"type": "array",
"description": "It indicates the list of Customer PO Numbers associated with the load's stop. (CM)"
}
]
},
{
"name": "addressLine1",
"kind": "required",
"type": "string",
"description": "It indicates the first line of the stop's address."
},
{
"name": "city",
"kind": "required",
"type": "string",
"description": "It indicates the name of the city."
},
{
"name": "state",
"kind": "required",
"type": "string",
"description": "It indicates the 2 character state code for US & Canada and 3 Character state code for Mexico. "
},
{
"name": "country",
"kind": "optional",
"type": "string",
"description": "It indicates the valid country code. It is the 2 digit country code."
},
{
"name": "postalCode",
"kind": "optional",
"type": "string",
"description": "It indicates the valid postal code for the stop."
},
{
"name": "latitude",
"kind": "optional",
"type": "string",
"description": "It indicates the latitude of the stop's location."
},
{
"name": "longitude",
"kind": "optional",
"type": "string",
"description": "It indicates the longitude of the stop's location."
},
{
"name": "geofencePoints",
"kind": "optional",
"type": "array",
"description": "It indicates the list of lat/long coordinates of the corners of the polygon geofence around the stop to be used for detecting arrival."
},
{
"name": "externalAddressId",
"kind": "optional",
"type": "string",
"description": "It is the unique identifier of the address in FourKites. This ID is sent in place of address information. UNLOCODE is preferred for port stop creation in the FK platform."
},
{
"name": "appointmentTime",
"kind": "required",
"type": "string",
"description": "It indicates the scheduled appointment time at the stop in the stop's local time zone in ISO 8601 format. ISO 8601 format Appointment times cannot be more than 4 days in the past from the current time."
},
{
"name": "stopReferenceId",
"kind": "optional",
"type": "string",
"description": "It is the unique identifier of the stop from the customer's system. This populates the \"Reference #\" field on the stop and is used to indicate which stop an update is applied to. (CM)"
},
{
"name": "earliestAppointmentTime",
"kind": "required",
"type": "string",
"description": "It indicates the earliest scheduled arrival time at the stop in the stop's local time zone in ISO 8601 format. ISO 8601 format If earliestAppointmentTi me is sent, then latestAppointmentTime must also be sent."
},
{
"name": "latestAppointmentTime",
"kind": "required",
"type": "string",
"description": "It indicates the latest scheduled arrival time at the stop in the stop's local time zone in ISO 8601 format. ISO 8601 format If latestAppointmentTime is sent, then earliestAppointmentTi me must also be sent.vlatestAppointmentTime should be greater than or equal to earliestAppointmentTime."
},
{
"name": "wantTime",
"kind": "optional",
"type": "string",
"description": "It indicates the time by which the load must be delivered to the consignee in stop's local time zone in ISO 8601 format. (CM)"
},
{
"name": "productLineItems",
"kind": "optional",
"type": "object",
"description": "It is the list of product level details associated with a stop. Replaces the legacy pallets/parts structure going forward.",
"children": [
{
"name": "productId",
"kind": "required",
"type": "string",
"description": "Unique identifier for the product. Mandatory if productLineItems object is present"
},
{
"name": "productName",
"kind": "optional",
"type": "string",
"description": "Name of the product"
},
{
"name": "productDescription",
"kind": "optional",
"type": "string",
"description": "Detailed description of the product"
},
{
"name": "productCategory",
"kind": "optional",
"type": "string",
"description": "Category classification of the product"
},
{
"name": "quantity",
"kind": "optional",
"type": "integer",
"description": "Number of units in the shipment"
},
{
"name": "measurementUnitCode",
"kind": "optional",
"type": "string",
"description": "Unit of measurement for quantity (e.g., PCE, KG, LB)"
},
{
"name": "netWeight",
"kind": "optional",
"type": "string",
"description": "Weight of the product excluding packaging"
},
{
"name": "weightUnit",
"kind": "optional",
"type": "string",
"description": "Unit of measurement for weight (e.g., KGM, LBM)"
},
{
"name": "unitCost",
"kind": "optional",
"type": "number",
"description": "Cost per unit of the product"
},
{
"name": "currencyCode",
"kind": "optional",
"type": "string",
"description": "Currency code for cost fields"
},
{
"name": "extendedCost",
"kind": "optional",
"type": "number",
"description": "Total cost for all units (unitCost x quantity)"
},
{
"name": "freightCost",
"kind": "optional",
"type": "number",
"description": "Freight cost allocated to this line item"
},
{
"name": "bestBeforeDate",
"kind": "optional",
"type": "string",
"description": "Expiration or best before date for the product"
},
{
"name": "additionalCharges",
"kind": "optional",
"type": "number",
"description": "Any additional charges specific to this line item"
},
{
"name": "tariffCost",
"kind": "optional",
"type": "number",
"description": "Tariff cost for this specific line item"
},
{
"name": "fourKitesCalculatedTariffCost",
"kind": "optional",
"type": "number",
"description": "System-calculated tariff cost"
},
{
"name": "totalLandedCost",
"kind": "optional",
"type": "number",
"description": "Total landed cost for this line item"
},
{
"name": "countryOfOrigin",
"kind": "optional",
"type": "string",
"description": "Country of origin for this product"
},
{
"name": "harmonizedSystemCode",
"kind": "optional",
"type": "string",
"description": "International trade classification code"
},
{
"name": "commodityTypeCode",
"kind": "optional",
"type": "string",
"description": "Commodity classification code"
},
{
"name": "htsusCode",
"kind": "optional",
"type": "string",
"description": "Harmonized Tariff Schedule code for US imports"
},
{
"name": "orderNumber",
"kind": "optional",
"type": "string",
"description": "Purchase order number"
},
{
"name": "deliveryNumber",
"kind": "optional",
"type": "string",
"description": "Delivery reference number"
},
{
"name": "handlingUnitId",
"kind": "optional",
"type": "string",
"description": "Identifier for the handling unit (pallet, box, etc.)"
},
{
"name": "barcode",
"kind": "optional",
"type": "string",
"description": "Product barcode"
},
{
"name": "containerType",
"kind": "optional",
"type": "string",
"description": "Type of container (pallet, box, carton, etc.)"
},
{
"name": "gtin",
"kind": "optional",
"type": "string",
"description": "Global Trade Item Number"
},
{
"name": "customerPartNumber",
"kind": "optional",
"type": "string",
"description": "Customer's part number for the product"
},
{
"name": "supplierPartNumber",
"kind": "optional",
"type": "string",
"description": "Supplier's part number for the product"
},
{
"name": "manufacturerPartNumber",
"kind": "optional",
"type": "string",
"description": "Manufacturer's part number"
},
{
"name": "itemNumber",
"kind": "optional",
"type": "string",
"description": "Internal item number"
},
{
"name": "productUpc",
"kind": "optional",
"type": "string",
"description": "Universal Product Code"
},
{
"name": "deliveryReferences",
"kind": "optional",
"type": "string",
"description": "Array of delivery reference numbers"
},
{
"name": "orderReferences",
"kind": "optional",
"type": "string",
"description": "Array of order reference numbers"
},
{
"name": "brandName",
"kind": "optional",
"type": "string",
"description": "Brand name of the product"
},
{
"name": "minimumTemperature",
"kind": "optional",
"type": "integer",
"description": "Minimum storage/transport temperature"
},
{
"name": "maximumTemperature",
"kind": "optional",
"type": "integer",
"description": "Maximum storage/transport temperature"
},
{
"name": "temperatureUnitCode",
"kind": "optional",
"type": "string",
"description": "Temperature unit (cel, fah)"
},
{
"name": "labelIdentifier",
"kind": "optional",
"type": "string",
"description": "Label identifier for tracking"
},
{
"name": "productTrackingNumber",
"kind": "optional",
"type": "string",
"description": "Unique tracking number for the product"
},
{
"name": "deviceType",
"kind": "optional",
"type": "string",
"description": "Type of tracking device (RFID_TAG, QR_CODE, etc.)"
}
]
}
]
}
],
"schema": [
{
"name": "loadNumber",
"kind": "required",
"type": "string",
"description": "It is the unique load identifier from shipper's system. The load Number or BOL is an important piece of information used to link the load with truck information received from the Carrier's TMS."
},
{
"name": "priority",
"kind": "optional",
"type": "string",
"description": "It indicates whether a load is of normal or high priority. If priority is set as ‘hot’, the load will be marked as ‘Hot’. Valid values: ‘normal’, ‘high’ and ‘hot’. Defaults to normal. Setting the 'Priority' as 'hot' will mark the load as 'Hot' load."
},
{
"name": "operatingCarrierScac",
"kind": "optional",
"type": "string",
"description": "SCAC or code of the operating carrier if setting up managing/operating carrier"
},
{
"name": "carrier",
"kind": "required",
"type": "string",
"description": "It is the SCAC or Service Provider ID of the carrier assigned to the load. The carrier should have approved sharing of their telematics data on FourKites® for the customer."
},
{
"name": "products",
"kind": "optional",
"type": "object",
"description": "It indicates the list of temperature tracked products on a load and their temperature tracking information."
},
{
"name": "bookingNumber",
"kind": "optional",
"type": "string",
"description": "It indicates the shipping line's booking number."
},
{
"name": "billOfLading",
"kind": "optional",
"type": "string",
"description": "It indicates the bill of lading associated with the Ocean load."
},
{
"name": "referenceNumbers",
"kind": "optional",
"type": "array",
"description": "It is the list of load level reference numbers associated with a load. (CM)"
},
{
"name": "stops",
"kind": "required",
"type": "object",
"description": "It is the list of stops for the load.",
"children": [
{
"name": "stopType",
"kind": "required",
"type": "string",
"description": "It defines the function of the stop. Valid values: \"portOfLoading\", \"transshipmentPort\", etc. "
},
{
"name": "customer",
"kind": "optional",
"type": "object",
"description": "It indicates the customer information for the stop. (CM)",
"children": [
{
"name": "id",
"kind": "optional",
"type": "string",
"description": "It is the unique identifier of the shipper's customer. "
},
{
"name": "poNumbers",
"kind": "optional",
"type": "array",
"description": "It indicates the list of Customer PO Numbers associated with the load's stop. (CM)"
}
]
},
{
"name": "addressLine1",
"kind": "required",
"type": "string",
"description": "It indicates the first line of the stop's address."
},
{
"name": "city",
"kind": "required",
"type": "string",
"description": "It indicates the name of the city."
},
{
"name": "state",
"kind": "required",
"type": "string",
"description": "It indicates the 2 character state code for US & Canada and 3 Character state code for Mexico. "
},
{
"name": "country",
"kind": "optional",
"type": "string",
"description": "It indicates the valid country code. It is the 2 digit country code."
},
{
"name": "postalCode",
"kind": "optional",
"type": "string",
"description": "It indicates the valid postal code for the stop."
},
{
"name": "latitude",
"kind": "optional",
"type": "string",
"description": "It indicates the latitude of the stop's location."
},
{
"name": "longitude",
"kind": "optional",
"type": "string",
"description": "It indicates the longitude of the stop's location."
},
{
"name": "geofencePoints",
"kind": "optional",
"type": "array",
"description": "It indicates the list of lat/long coordinates of the corners of the polygon geofence around the stop to be used for detecting arrival."
},
{
"name": "externalAddressId",
"kind": "optional",
"type": "string",
"description": "It is the unique identifier of the address in FourKites. This ID is sent in place of address information. UNLOCODE is preferred for port stop creation in the FK platform."
},
{
"name": "appointmentTime",
"kind": "required",
"type": "string",
"description": "It indicates the scheduled appointment time at the stop in the stop's local time zone in ISO 8601 format. ISO 8601 format Appointment times cannot be more than 4 days in the past from the current time."
},
{
"name": "stopReferenceId",
"kind": "optional",
"type": "string",
"description": "It is the unique identifier of the stop from the customer's system. This populates the \"Reference #\" field on the stop and is used to indicate which stop an update is applied to. (CM)"
},
{
"name": "earliestAppointmentTime",
"kind": "required",
"type": "string",
"description": "It indicates the earliest scheduled arrival time at the stop in the stop's local time zone in ISO 8601 format. ISO 8601 format If earliestAppointmentTi me is sent, then latestAppointmentTime must also be sent."
},
{
"name": "latestAppointmentTime",
"kind": "required",
"type": "string",
"description": "It indicates the latest scheduled arrival time at the stop in the stop's local time zone in ISO 8601 format. ISO 8601 format If latestAppointmentTime is sent, then earliestAppointmentTi me must also be sent.vlatestAppointmentTime should be greater than or equal to earliestAppointmentTime."
},
{
"name": "wantTime",
"kind": "optional",
"type": "string",
"description": "It indicates the time by which the load must be delivered to the consignee in stop's local time zone in ISO 8601 format. (CM)"
},
{
"name": "productLineItems",
"kind": "optional",
"type": "object",
"description": "It is the list of product level details associated with a stop. Replaces the legacy pallets/parts structure going forward.",
"children": [
{
"name": "productId",
"kind": "required",
"type": "string",
"description": "Unique identifier for the product. Mandatory if productLineItems object is present"
},
{
"name": "productName",
"kind": "optional",
"type": "string",
"description": "Name of the product"
},
{
"name": "productDescription",
"kind": "optional",
"type": "string",
"description": "Detailed description of the product"
},
{
"name": "productCategory",
"kind": "optional",
"type": "string",
"description": "Category classification of the product"
},
{
"name": "quantity",
"kind": "optional",
"type": "integer",
"description": "Number of units in the shipment"
},
{
"name": "measurementUnitCode",
"kind": "optional",
"type": "string",
"description": "Unit of measurement for quantity (e.g., PCE, KG, LB)"
},
{
"name": "netWeight",
"kind": "optional",
"type": "string",
"description": "Weight of the product excluding packaging"
},
{
"name": "weightUnit",
"kind": "optional",
"type": "string",
"description": "Unit of measurement for weight (e.g., KGM, LBM)"
},
{
"name": "unitCost",
"kind": "optional",
"type": "number",
"description": "Cost per unit of the product"
},
{
"name": "currencyCode",
"kind": "optional",
"type": "string",
"description": "Currency code for cost fields"
},
{
"name": "extendedCost",
"kind": "optional",
"type": "number",
"description": "Total cost for all units (unitCost x quantity)"
},
{
"name": "freightCost",
"kind": "optional",
"type": "number",
"description": "Freight cost allocated to this line item"
},
{
"name": "bestBeforeDate",
"kind": "optional",
"type": "string",
"description": "Expiration or best before date for the product"
},
{
"name": "additionalCharges",
"kind": "optional",
"type": "number",
"description": "Any additional charges specific to this line item"
},
{
"name": "tariffCost",
"kind": "optional",
"type": "number",
"description": "Tariff cost for this specific line item"
},
{
"name": "fourKitesCalculatedTariffCost",
"kind": "optional",
"type": "number",
"description": "System-calculated tariff cost"
},
{
"name": "totalLandedCost",
"kind": "optional",
"type": "number",
"description": "Total landed cost for this line item"
},
{
"name": "countryOfOrigin",
"kind": "optional",
"type": "string",
"description": "Country of origin for this product"
},
{
"name": "harmonizedSystemCode",
"kind": "optional",
"type": "string",
"description": "International trade classification code"
},
{
"name": "commodityTypeCode",
"kind": "optional",
"type": "string",
"description": "Commodity classification code"
},
{
"name": "htsusCode",
"kind": "optional",
"type": "string",
"description": "Harmonized Tariff Schedule code for US imports"
},
{
"name": "orderNumber",
"kind": "optional",
"type": "string",
"description": "Purchase order number"
},
{
"name": "deliveryNumber",
"kind": "optional",
"type": "string",
"description": "Delivery reference number"
},
{
"name": "handlingUnitId",
"kind": "optional",
"type": "string",
"description": "Identifier for the handling unit (pallet, box, etc.)"
},
{
"name": "barcode",
"kind": "optional",
"type": "string",
"description": "Product barcode"
},
{
"name": "containerType",
"kind": "optional",
"type": "string",
"description": "Type of container (pallet, box, carton, etc.)"
},
{
"name": "gtin",
"kind": "optional",
"type": "string",
"description": "Global Trade Item Number"
},
{
"name": "customerPartNumber",
"kind": "optional",
"type": "string",
"description": "Customer's part number for the product"
},
{
"name": "supplierPartNumber",
"kind": "optional",
"type": "string",
"description": "Supplier's part number for the product"
},
{
"name": "manufacturerPartNumber",
"kind": "optional",
"type": "string",
"description": "Manufacturer's part number"
},
{
"name": "itemNumber",
"kind": "optional",
"type": "string",
"description": "Internal item number"
},
{
"name": "productUpc",
"kind": "optional",
"type": "string",
"description": "Universal Product Code"
},
{
"name": "deliveryReferences",
"kind": "optional",
"type": "string",
"description": "Array of delivery reference numbers"
},
{
"name": "orderReferences",
"kind": "optional",
"type": "string",
"description": "Array of order reference numbers"
},
{
"name": "brandName",
"kind": "optional",
"type": "string",
"description": "Brand name of the product"
},
{
"name": "minimumTemperature",
"kind": "optional",
"type": "integer",
"description": "Minimum storage/transport temperature"
},
{
"name": "maximumTemperature",
"kind": "optional",
"type": "integer",
"description": "Maximum storage/transport temperature"
},
{
"name": "temperatureUnitCode",
"kind": "optional",
"type": "string",
"description": "Temperature unit (cel, fah)"
},
{
"name": "labelIdentifier",
"kind": "optional",
"type": "string",
"description": "Label identifier for tracking"
},
{
"name": "productTrackingNumber",
"kind": "optional",
"type": "string",
"description": "Unique tracking number for the product"
},
{
"name": "deviceType",
"kind": "optional",
"type": "string",
"description": "Type of tracking device (RFID_TAG, QR_CODE, etc.)"
}
]
}
]
}
]
}
],
"formDataParameters": []
},
"currentNewParameter": {
"label": "Body Parameter",
"value": "bodyDataParameters"
},
"hasTryItOut": false,
"autoGeneratedAnchorSlug": "azure-staging",
"legacyHash": "bihMA4UvPn7mblqgnhkbr"
}
```
:::