---
title: Airport-to-Airport
slug: fourkites-api-reference/airport-to-airport
description: Learn about the Create Load API in this document, which outlines how authorized users can seamlessly create new loads for tracking within the FourKites system. Discover how customers can efficiently handle multiple loads with the same load number or PRO n
icon: {"apiMethod":"POST"}
createdAt: 2023-08-04T12:21:56.000Z
---
Create Airport-to-Airport load with Origin and Destination airport stop types.
:::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).
:::ApiMethodV2
```json
{
"name": "Production",
"method": "POST",
"url": "https://api.fourkites.com/api/v1/tracking",
"description": "",
"tab": "examples",
"examples": {
"languages": [
{
"id": "n-DZmOHtEuWKXy0FjZ59S",
"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 \"mawb\": \"70038067644\"\n },\n \"trackingNumber\": \"70038067644\",\n \"load\": {\n \"loadNumber\": \"TEST_LOAD_01\",\n \"carrier\": \"1234\",\n \"priority\": \"high\",\n \"carrierPermalink\": \"aaa-bbb-ccc\",\n \"stops\": [\n {\n \"stopType\": \"originAirport\",\n \"airTotalPieces\": \"100\",\n \"externalAddressId\": \"MAA\",\n \"sequence\": \"1\",\n \"departingFlightNumber\": \"GTI8030\",\n \"earliestAppointmentTime\": \"2024-03-11T04:25:45.000Z\",\n \"latestAppointmentTime\": \"2024-03-11T06:25:45.000Z\",\n \"productLineItems\": [\n {\n \"productId\": \"0123456\",\n \"productName\": \"Air Freight Item\",\n \"productDescription\": \"Airport-to-airport air shipment item\",\n \"productCategory\": \"General Freight\",\n \"quantity\": 100,\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\": \"US\",\n \"harmonizedSystemCode\": \"8471499000\",\n \"commodityTypeCode\": \"AIR_FREIGHT\",\n \"htsusCode\": \"8471499000\",\n \"orderNumber\": \"TEST_LOAD_01\",\n \"deliveryNumber\": \"DN-MAA\",\n \"handlingUnitId\": \"PAL-MAA\",\n \"barcode\": \"PALMAA\",\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\": [\"70038067644\"],\n \"orderReferences\": [\"TEST_LOAD_01\"],\n \"brandName\": \"Generic Air Freight Co\",\n \"minimumTemperature\": 0,\n \"maximumTemperature\": 0,\n \"temperatureUnitCode\": \"cel\",\n \"labelIdentifier\": \"LBL-22EE\",\n \"productTrackingNumber\": \"70038067644-1\",\n \"deviceType\": \"RFID_TAG\"\n }\n ]\n },\n {\n \"stopType\": \"destinationAirport\",\n \"externalAddressId\": \"ANC\",\n \"sequence\": \"2\",\n \"earliestAppointmentTime\": \"2024-04-15T04:25:45.000Z\",\n \"latestAppointmentTime\": \"2024-04-16T06:25:45.000Z\",\n \"productLineItems\": [\n {\n \"productId\": \"0123456\",\n \"productName\": \"Air Freight Item\",\n \"productDescription\": \"Airport-to-airport air shipment item\",\n \"productCategory\": \"General Freight\",\n \"quantity\": 100,\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\": \"US\",\n \"harmonizedSystemCode\": \"8471499000\",\n \"commodityTypeCode\": \"AIR_FREIGHT\",\n \"htsusCode\": \"8471499000\",\n \"orderNumber\": \"TEST_LOAD_01\",\n \"deliveryNumber\": \"DN-ANC\",\n \"handlingUnitId\": \"PAL-ANC\",\n \"barcode\": \"PALANC\",\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\": [\"70038067644\"],\n \"orderReferences\": [\"TEST_LOAD_01\"],\n \"brandName\": \"Generic Air Freight Co\",\n \"minimumTemperature\": 0,\n \"maximumTemperature\": 0,\n \"temperatureUnitCode\": \"cel\",\n \"labelIdentifier\": \"LBL-22EE\",\n \"productTrackingNumber\": \"70038067644-2\",\n \"deviceType\": \"QR_CODE\"\n }\n ]\n }\n ]\n }\n}'",
"customLabel": ""
},
{
"id": "GbTGdRS4PwNqceJgtsfiu",
"language": "java",
"code": "OkHttpClient client = new OkHttpClient().newBuilder()\n .build();\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\n \\\"trackingInfo\\\": {\\n \\\"mawb\\\": \\\"70038067644\\\"\\n },\\n \\\"trackingNumber\\\": \\\"70038067644\\\",\\n \\\"load\\\": {\\n \\\"loadNumber\\\": \\\"TEST_LOAD_01\\\",\\n \\\"carrier\\\": \\\"1234\\\",\\n \\\"priority\\\": \\\"high\\\",\\n \\\"carrierPermalink\\\": \\\"aaa-bbb-ccc\\\",\\n \\\"stops\\\": [\\n {\\n \\\"stopType\\\": \\\"originAirport\\\",\\n \\\"airTotalPieces\\\": \\\"100\\\",\\n \\\"externalAddressId\\\": \\\"MAA\\\",\\n \\\"sequence\\\": \\\"1\\\",\\n \\\"departingFlightNumber\\\": \\\"GTI8030\\\",\\n \\\"earliestAppointmentTime\\\": \\\"2024-03-11T04:25:45.000Z\\\",\\n \\\"latestAppointmentTime\\\": \\\"2024-03-11T06:25:45.000Z\\\"\\n },\\n {\\n \\\"stopType\\\": \\\"destinationAirport\\\",\\n \\\"externalAddressId\\\": \\\"ANC\\\",\\n \\\"sequence\\\": \\\"2\\\",\\n \\\"earliestAppointmentTime\\\": \\\"2024-04-15T04:25:45.000Z\\\",\\n \\\"latestAppointmentTime\\\": \\\"2024-04-16T06:25:45.000Z\\\"\\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": "eNVWAy0OjYYCeDnN1Kwpa",
"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 \"mawb\": \"70038067644\"\n },\n \"trackingNumber\": \"70038067644\",\n \"load\": {\n \"loadNumber\": \"TEST_LOAD_01\",\n \"carrier\": \"1234\",\n \"priority\": \"high\",\n \"carrierPermalink\": \"aaa-bbb-ccc\",\n \"stops\": [\n {\n \"stopType\": \"originAirport\",\n \"airTotalPieces\": \"100\",\n \"externalAddressId\": \"MAA\",\n \"sequence\": \"1\",\n \"departingFlightNumber\": \"GTI8030\",\n \"earliestAppointmentTime\": \"2024-03-11T04:25:45.000Z\",\n \"latestAppointmentTime\": \"2024-03-11T06:25:45.000Z\"\n },\n {\n \"stopType\": \"destinationAirport\",\n \"externalAddressId\": \"ANC\",\n \"sequence\": \"2\",\n \"earliestAppointmentTime\": \"2024-04-15T04:25:45.000Z\",\n \"latestAppointmentTime\": \"2024-04-16T06:25:45.000Z\"\n }\n ]\n }\n }),\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});",
"customLabel": ""
},
{
"id": "VT7nWTtyBQ2rton8YCGSg",
"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 \\\"mawb\\\": \\\"70038067644\\\"\\n },\\n \\\"trackingNumber\\\": \\\"70038067644\\\",\\n \\\"load\\\": {\\n \\\"loadNumber\\\": \\\"TEST_LOAD_01\\\",\\n \\\"carrier\\\": \\\"1234\\\",\\n \\\"priority\\\": \\\"high\\\",\\n \\\"carrierPermalink\\\": \\\"aaa-bbb-ccc\\\",\\n \\\"stops\\\": [\\n {\\n \\\"stopType\\\": \\\"originAirport\\\",\\n \\\"airTotalPieces\\\": \\\"100\\\",\\n \\\"externalAddressId\\\": \\\"MAA\\\",\\n \\\"sequence\\\": \\\"1\\\",\\n \\\"departingFlightNumber\\\": \\\"GTI8030\\\",\\n \\\"earliestAppointmentTime\\\": \\\"2024-03-11T04:25:45.000Z\\\",\\n \\\"latestAppointmentTime\\\": \\\"2024-03-11T06:25:45.000Z\\\"\\n },\\n {\\n \\\"stopType\\\": \\\"destinationAirport\\\",\\n \\\"externalAddressId\\\": \\\"ANC\\\",\\n \\\"sequence\\\": \\\"2\\\",\\n \\\"earliestAppointmentTime\\\": \\\"2024-04-15T04:25:45.000Z\\\",\\n \\\"latestAppointmentTime\\\": \\\"2024-04-16T06:25:45.000Z\\\"\\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": "gbJ97PQJeBVqywkyOmLUo",
"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@\" \"\"mawb\"\": \"\"70038067644\"\"\" + \"\\n\" +\n@\" },\" + \"\\n\" +\n@\" \"\"trackingNumber\"\": \"\"70038067644\"\",\" + \"\\n\" +\n@\" \"\"load\"\": {\" + \"\\n\" +\n@\" \"\"loadNumber\"\": \"\"TEST_LOAD_01\"\",\" + \"\\n\" +\n@\" \"\"carrier\"\": \"\"1234\"\",\" + \"\\n\" +\n@\" \"\"priority\"\": \"\"high\"\",\" + \"\\n\" +\n@\" \"\"carrierPermalink\"\": \"\"aaa-bbb-ccc\"\",\" + \"\\n\" +\n@\" \"\"stops\"\": [\" + \"\\n\" +\n@\" {\" + \"\\n\" +\n@\" \"\"stopType\"\": \"\"originAirport\"\",\" + \"\\n\" +\n@\" \"\"airTotalPieces\"\": \"\"100\"\",\" + \"\\n\" +\n@\" \"\"externalAddressId\"\": \"\"MAA\"\",\" + \"\\n\" +\n@\" \"\"sequence\"\": \"\"1\"\",\" + \"\\n\" +\n@\" \"\"departingFlightNumber\"\": \"\"GTI8030\"\",\" + \"\\n\" +\n@\" \"\"earliestAppointmentTime\"\": \"\"2024-03-11T04:25:45.000Z\"\",\" + \"\\n\" +\n@\" \"\"latestAppointmentTime\"\": \"\"2024-03-11T06:25:45.000Z\"\"\" + \"\\n\" +\n@\" },\" + \"\\n\" +\n@\" {\" + \"\\n\" +\n@\" \"\"stopType\"\": \"\"destinationAirport\"\",\" + \"\\n\" +\n@\" \"\"externalAddressId\"\": \"\"ANC\"\",\" + \"\\n\" +\n@\" \"\"sequence\"\": \"\"2\"\",\" + \"\\n\" +\n@\" \"\"earliestAppointmentTime\"\": \"\"2024-04-15T04:25:45.000Z\"\",\" + \"\\n\" +\n@\" \"\"latestAppointmentTime\"\": \"\"2024-04-16T06:25:45.000Z\"\"\" + \"\\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": "33RbXtxBRsvGgb-Z8cidu",
"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 \"mawb\": \"70038067644\"\n },\n \"trackingNumber\": \"70038067644\",\n \"load\": {\n \"loadNumber\": \"TEST_LOAD_01\",\n \"carrier\": \"1234\",\n \"priority\": \"high\",\n \"carrierPermalink\": \"aaa-bbb-ccc\",\n \"stops\": [\n {\n \"stopType\": \"originAirport\",\n \"airTotalPieces\": \"100\",\n \"externalAddressId\": \"MAA\",\n \"sequence\": \"1\",\n \"departingFlightNumber\": \"GTI8030\",\n \"earliestAppointmentTime\": \"2024-03-11T04:25:45.000Z\",\n \"latestAppointmentTime\": \"2024-03-11T06:25:45.000Z\"\n },\n {\n \"stopType\": \"destinationAirport\",\n \"externalAddressId\": \"ANC\",\n \"sequence\": \"2\",\n \"earliestAppointmentTime\": \"2024-04-15T04:25:45.000Z\",\n \"latestAppointmentTime\": \"2024-04-16T06:25:45.000Z\"\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": "c7fZtgJLFrypW0vz2ZvBS",
"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 \"mawb\": \"70038067644\"\n },\n \"trackingNumber\": \"70038067644\",\n \"load\": {\n \"loadNumber\": \"TEST_LOAD_01\",\n \"carrier\": \"1234\",\n \"priority\": \"high\",\n \"carrierPermalink\": \"aaa-bbb-ccc\",\n \"stops\": [\n {\n \"stopType\": \"originAirport\",\n \"airTotalPieces\": \"100\",\n \"externalAddressId\": \"MAA\",\n \"sequence\": \"1\",\n \"departingFlightNumber\": \"GTI8030\",\n \"earliestAppointmentTime\": \"2024-03-11T04:25:45.000Z\",\n \"latestAppointmentTime\": \"2024-03-11T06:25:45.000Z\"\n },\n {\n \"stopType\": \"destinationAirport\",\n \"externalAddressId\": \"ANC\",\n \"sequence\": \"2\",\n \"earliestAppointmentTime\": \"2024-04-15T04:25:45.000Z\",\n \"latestAppointmentTime\": \"2024-04-16T06:25:45.000Z\"\n }\n ]\n }\n})\n\nresponse = https.request(request)\nputs response.read_body\n",
"customLabel": ""
},
{
"id": "6IlX1t2mXcZFwZc21tu03",
"language": "python",
"code": "import http.client\nimport json\n\nconn = http.client.HTTPSConnection(\"api.fourkites.com\")\npayload = json.dumps({\n \"trackingInfo\": {\n \"mawb\": \"70038067644\"\n },\n \"trackingNumber\": \"70038067644\",\n \"load\": {\n \"loadNumber\": \"TEST_LOAD_01\",\n \"carrier\": \"1234\",\n \"priority\": \"high\",\n \"carrierPermalink\": \"aaa-bbb-ccc\",\n \"stops\": [\n {\n \"stopType\": \"originAirport\",\n \"airTotalPieces\": \"100\",\n \"externalAddressId\": \"MAA\",\n \"sequence\": \"1\",\n \"departingFlightNumber\": \"GTI8030\",\n \"earliestAppointmentTime\": \"2024-03-11T04:25:45.000Z\",\n \"latestAppointmentTime\": \"2024-03-11T06:25:45.000Z\"\n },\n {\n \"stopType\": \"destinationAirport\",\n \"externalAddressId\": \"ANC\",\n \"sequence\": \"2\",\n \"earliestAppointmentTime\": \"2024-04-15T04:25:45.000Z\",\n \"latestAppointmentTime\": \"2024-04-16T06:25:45.000Z\"\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": "n-DZmOHtEuWKXy0FjZ59S"
},
"results": {
"languages": [
{
"id": "QKAYpPpY8aJMfbm0uWtgN",
"language": "200",
"customLabel": "",
"code": "{\n \"statusCode\": 200,\n \"message\": \"Load creation request has been submitted successfully\",\n \"loadId\": 176366846\n}"
}
],
"selectedLanguageId": "QKAYpPpY8aJMfbm0uWtgN"
},
"request": {
"pathParameters": [],
"queryParameters": [],
"headerParameters": [],
"bodyDataParameters": [
{
"name": "trackingInfo",
"kind": "optional",
"type": "object",
"description": "It indicates the information required for tracking the load.",
"children": [
{
"name": "mawb",
"kind": "optional",
"type": "string",
"description": "The carrier’s air waybill issued to cover a consolidated shipment tendered by a forwarder or consolidator."
}
]
},
{
"name": "trackingNumber",
"kind": "optional",
"type": "string",
"description": "Any tracking number provided by the carrier or other entities.",
"children": []
},
{
"name": "load",
"kind": "required",
"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": "carrier",
"kind": "optional",
"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": "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": "carrierPermalink",
"kind": "required",
"type": "string",
"description": "It is the unique identifier for the carrier in the FK platform."
},
{
"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: \"originAirport\", \"destinationAirport\", etc. There should be at least one pickup and delivery stop or one transfer (terminal) and one delivery."
},
{
"name": "airTotalPieces",
"kind": "optional",
"type": "string",
"description": ""
},
{
"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": "sequence",
"kind": "optional",
"type": "string",
"description": "It indicates the stop's sequence on a load. The lower value indicates earliest scheduled stop completion. If the stop sequence is present for one stop on a load, it must be present on all stops. It is recommended to start at 1 and increment by 1 for each additional stop. (CM)"
},
{
"name": "departingFlightNumber",
"kind": "optional",
"type": "string",
"description": "It indicates the flight number of the departing flight from the airport stop."
},
{
"name": "earliestAppointmentTime",
"kind": "optional",
"type": "string",
"description": "It indicates the earliest scheduled arrival time at the stop in the stop's local timezone in ISO 8601 format. ISO 8601 format. If the earliestAppointmentTime is sent, then the latestAppointmentTime must also be sent."
},
{
"name": "latestAppointmentTime",
"kind": "optional",
"type": "string",
"description": "It indicates the latest scheduled arrival time at the stop in the stop's local timezone in ISO 8601 format. ISO 8601 format. If the latestAppointmentTime is sent, then the earliestAppointmentTime must also be sent. latestAppointmentTime should be greater than or equal to earliestAppointmentTime."
},
{
"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": "EDJiiuguGepp0JKcG4AOT"
}
```
:::
:::ApiMethodV2
```json
{
"name": "Staging",
"method": "POST",
"url": "https://api-staging.fourkites.com/api/v1/tracking",
"description": "",
"tab": "examples",
"examples": {
"languages": [
{
"id": "n-DZmOHtEuWKXy0FjZ59S",
"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 \"mawb\": \"70038067644\"\n },\n \"trackingNumber\": \"70038067644\",\n \"load\": {\n \"loadNumber\": \"TEST_LOAD_01\",\n \"carrier\": \"1234\",\n \"priority\": \"high\",\n \"carrierPermalink\": \"aaa-bbb-ccc\",\n \"stops\": [\n {\n \"stopType\": \"originAirport\",\n \"airTotalPieces\": \"100\",\n \"externalAddressId\": \"MAA\",\n \"sequence\": \"1\",\n \"departingFlightNumber\": \"GTI8030\",\n \"earliestAppointmentTime\": \"2024-03-11T04:25:45.000Z\",\n \"latestAppointmentTime\": \"2024-03-11T06:25:45.000Z\",\n \"productLineItems\": [\n {\n \"productId\": \"0123456\",\n \"productName\": \"Air Freight Item\",\n \"productDescription\": \"Airport-to-airport air shipment item\",\n \"productCategory\": \"General Freight\",\n \"quantity\": 100,\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\": \"US\",\n \"harmonizedSystemCode\": \"8471499000\",\n \"commodityTypeCode\": \"AIR_FREIGHT\",\n \"htsusCode\": \"8471499000\",\n \"orderNumber\": \"TEST_LOAD_01\",\n \"deliveryNumber\": \"DN-MAA\",\n \"handlingUnitId\": \"PAL-MAA\",\n \"barcode\": \"PALMAA\",\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\": [\"70038067644\"],\n \"orderReferences\": [\"TEST_LOAD_01\"],\n \"brandName\": \"Generic Air Freight Co\",\n \"minimumTemperature\": 0,\n \"maximumTemperature\": 0,\n \"temperatureUnitCode\": \"cel\",\n \"labelIdentifier\": \"LBL-22EE\",\n \"productTrackingNumber\": \"70038067644-1\",\n \"deviceType\": \"RFID_TAG\"\n }\n ]\n },\n {\n \"stopType\": \"destinationAirport\",\n \"externalAddressId\": \"ANC\",\n \"sequence\": \"2\",\n \"earliestAppointmentTime\": \"2024-04-15T04:25:45.000Z\",\n \"latestAppointmentTime\": \"2024-04-16T06:25:45.000Z\",\n \"productLineItems\": [\n {\n \"productId\": \"0123456\",\n \"productName\": \"Air Freight Item\",\n \"productDescription\": \"Airport-to-airport air shipment item\",\n \"productCategory\": \"General Freight\",\n \"quantity\": 100,\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\": \"US\",\n \"harmonizedSystemCode\": \"8471499000\",\n \"commodityTypeCode\": \"AIR_FREIGHT\",\n \"htsusCode\": \"8471499000\",\n \"orderNumber\": \"TEST_LOAD_01\",\n \"deliveryNumber\": \"DN-ANC\",\n \"handlingUnitId\": \"PAL-ANC\",\n \"barcode\": \"PALANC\",\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\": [\"70038067644\"],\n \"orderReferences\": [\"TEST_LOAD_01\"],\n \"brandName\": \"Generic Air Freight Co\",\n \"minimumTemperature\": 0,\n \"maximumTemperature\": 0,\n \"temperatureUnitCode\": \"cel\",\n \"labelIdentifier\": \"LBL-22EE\",\n \"productTrackingNumber\": \"70038067644-2\",\n \"deviceType\": \"QR_CODE\"\n }\n ]\n }\n ]\n }\n}'",
"customLabel": ""
},
{
"id": "GbTGdRS4PwNqceJgtsfiu",
"language": "java",
"code": "OkHttpClient client = new OkHttpClient().newBuilder()\n .build();\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\n \\\"trackingInfo\\\": {\\n \\\"mawb\\\": \\\"70038067644\\\"\\n },\\n \\\"trackingNumber\\\": \\\"70038067644\\\",\\n \\\"load\\\": {\\n \\\"loadNumber\\\": \\\"TEST_LOAD_01\\\",\\n \\\"carrier\\\": \\\"1234\\\",\\n \\\"priority\\\": \\\"high\\\",\\n \\\"carrierPermalink\\\": \\\"aaa-bbb-ccc\\\",\\n \\\"stops\\\": [\\n {\\n \\\"stopType\\\": \\\"originAirport\\\",\\n \\\"airTotalPieces\\\": \\\"100\\\",\\n \\\"externalAddressId\\\": \\\"MAA\\\",\\n \\\"sequence\\\": \\\"1\\\",\\n \\\"departingFlightNumber\\\": \\\"GTI8030\\\",\\n \\\"earliestAppointmentTime\\\": \\\"2024-03-11T04:25:45.000Z\\\",\\n \\\"latestAppointmentTime\\\": \\\"2024-03-11T06:25:45.000Z\\\"\\n },\\n {\\n \\\"stopType\\\": \\\"destinationAirport\\\",\\n \\\"externalAddressId\\\": \\\"ANC\\\",\\n \\\"sequence\\\": \\\"2\\\",\\n \\\"earliestAppointmentTime\\\": \\\"2024-04-15T04:25:45.000Z\\\",\\n \\\"latestAppointmentTime\\\": \\\"2024-04-16T06:25:45.000Z\\\"\\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": "eNVWAy0OjYYCeDnN1Kwpa",
"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 \"mawb\": \"70038067644\"\n },\n \"trackingNumber\": \"70038067644\",\n \"load\": {\n \"loadNumber\": \"TEST_LOAD_01\",\n \"carrier\": \"1234\",\n \"priority\": \"high\",\n \"carrierPermalink\": \"aaa-bbb-ccc\",\n \"stops\": [\n {\n \"stopType\": \"originAirport\",\n \"airTotalPieces\": \"100\",\n \"externalAddressId\": \"MAA\",\n \"sequence\": \"1\",\n \"departingFlightNumber\": \"GTI8030\",\n \"earliestAppointmentTime\": \"2024-03-11T04:25:45.000Z\",\n \"latestAppointmentTime\": \"2024-03-11T06:25:45.000Z\"\n },\n {\n \"stopType\": \"destinationAirport\",\n \"externalAddressId\": \"ANC\",\n \"sequence\": \"2\",\n \"earliestAppointmentTime\": \"2024-04-15T04:25:45.000Z\",\n \"latestAppointmentTime\": \"2024-04-16T06:25:45.000Z\"\n }\n ]\n }\n }),\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});",
"customLabel": ""
},
{
"id": "VT7nWTtyBQ2rton8YCGSg",
"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 \\\"mawb\\\": \\\"70038067644\\\"\\n },\\n \\\"trackingNumber\\\": \\\"70038067644\\\",\\n \\\"load\\\": {\\n \\\"loadNumber\\\": \\\"TEST_LOAD_01\\\",\\n \\\"carrier\\\": \\\"1234\\\",\\n \\\"priority\\\": \\\"high\\\",\\n \\\"carrierPermalink\\\": \\\"aaa-bbb-ccc\\\",\\n \\\"stops\\\": [\\n {\\n \\\"stopType\\\": \\\"originAirport\\\",\\n \\\"airTotalPieces\\\": \\\"100\\\",\\n \\\"externalAddressId\\\": \\\"MAA\\\",\\n \\\"sequence\\\": \\\"1\\\",\\n \\\"departingFlightNumber\\\": \\\"GTI8030\\\",\\n \\\"earliestAppointmentTime\\\": \\\"2024-03-11T04:25:45.000Z\\\",\\n \\\"latestAppointmentTime\\\": \\\"2024-03-11T06:25:45.000Z\\\"\\n },\\n {\\n \\\"stopType\\\": \\\"destinationAirport\\\",\\n \\\"externalAddressId\\\": \\\"ANC\\\",\\n \\\"sequence\\\": \\\"2\\\",\\n \\\"earliestAppointmentTime\\\": \\\"2024-04-15T04:25:45.000Z\\\",\\n \\\"latestAppointmentTime\\\": \\\"2024-04-16T06:25:45.000Z\\\"\\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": "gbJ97PQJeBVqywkyOmLUo",
"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@\" \"\"mawb\"\": \"\"70038067644\"\"\" + \"\\n\" +\n@\" },\" + \"\\n\" +\n@\" \"\"trackingNumber\"\": \"\"70038067644\"\",\" + \"\\n\" +\n@\" \"\"load\"\": {\" + \"\\n\" +\n@\" \"\"loadNumber\"\": \"\"TEST_LOAD_01\"\",\" + \"\\n\" +\n@\" \"\"carrier\"\": \"\"1234\"\",\" + \"\\n\" +\n@\" \"\"priority\"\": \"\"high\"\",\" + \"\\n\" +\n@\" \"\"carrierPermalink\"\": \"\"aaa-bbb-ccc\"\",\" + \"\\n\" +\n@\" \"\"stops\"\": [\" + \"\\n\" +\n@\" {\" + \"\\n\" +\n@\" \"\"stopType\"\": \"\"originAirport\"\",\" + \"\\n\" +\n@\" \"\"airTotalPieces\"\": \"\"100\"\",\" + \"\\n\" +\n@\" \"\"externalAddressId\"\": \"\"MAA\"\",\" + \"\\n\" +\n@\" \"\"sequence\"\": \"\"1\"\",\" + \"\\n\" +\n@\" \"\"departingFlightNumber\"\": \"\"GTI8030\"\",\" + \"\\n\" +\n@\" \"\"earliestAppointmentTime\"\": \"\"2024-03-11T04:25:45.000Z\"\",\" + \"\\n\" +\n@\" \"\"latestAppointmentTime\"\": \"\"2024-03-11T06:25:45.000Z\"\"\" + \"\\n\" +\n@\" },\" + \"\\n\" +\n@\" {\" + \"\\n\" +\n@\" \"\"stopType\"\": \"\"destinationAirport\"\",\" + \"\\n\" +\n@\" \"\"externalAddressId\"\": \"\"ANC\"\",\" + \"\\n\" +\n@\" \"\"sequence\"\": \"\"2\"\",\" + \"\\n\" +\n@\" \"\"earliestAppointmentTime\"\": \"\"2024-04-15T04:25:45.000Z\"\",\" + \"\\n\" +\n@\" \"\"latestAppointmentTime\"\": \"\"2024-04-16T06:25:45.000Z\"\"\" + \"\\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": "33RbXtxBRsvGgb-Z8cidu",
"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 \"mawb\": \"70038067644\"\n },\n \"trackingNumber\": \"70038067644\",\n \"load\": {\n \"loadNumber\": \"TEST_LOAD_01\",\n \"carrier\": \"1234\",\n \"priority\": \"high\",\n \"carrierPermalink\": \"aaa-bbb-ccc\",\n \"stops\": [\n {\n \"stopType\": \"originAirport\",\n \"airTotalPieces\": \"100\",\n \"externalAddressId\": \"MAA\",\n \"sequence\": \"1\",\n \"departingFlightNumber\": \"GTI8030\",\n \"earliestAppointmentTime\": \"2024-03-11T04:25:45.000Z\",\n \"latestAppointmentTime\": \"2024-03-11T06:25:45.000Z\"\n },\n {\n \"stopType\": \"destinationAirport\",\n \"externalAddressId\": \"ANC\",\n \"sequence\": \"2\",\n \"earliestAppointmentTime\": \"2024-04-15T04:25:45.000Z\",\n \"latestAppointmentTime\": \"2024-04-16T06:25:45.000Z\"\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": "c7fZtgJLFrypW0vz2ZvBS",
"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 \"mawb\": \"70038067644\"\n },\n \"trackingNumber\": \"70038067644\",\n \"load\": {\n \"loadNumber\": \"TEST_LOAD_01\",\n \"carrier\": \"1234\",\n \"priority\": \"high\",\n \"carrierPermalink\": \"aaa-bbb-ccc\",\n \"stops\": [\n {\n \"stopType\": \"originAirport\",\n \"airTotalPieces\": \"100\",\n \"externalAddressId\": \"MAA\",\n \"sequence\": \"1\",\n \"departingFlightNumber\": \"GTI8030\",\n \"earliestAppointmentTime\": \"2024-03-11T04:25:45.000Z\",\n \"latestAppointmentTime\": \"2024-03-11T06:25:45.000Z\"\n },\n {\n \"stopType\": \"destinationAirport\",\n \"externalAddressId\": \"ANC\",\n \"sequence\": \"2\",\n \"earliestAppointmentTime\": \"2024-04-15T04:25:45.000Z\",\n \"latestAppointmentTime\": \"2024-04-16T06:25:45.000Z\"\n }\n ]\n }\n})\n\nresponse = https.request(request)\nputs response.read_body\n",
"customLabel": ""
},
{
"id": "njlpP6vTYD4QDEku7rCsu",
"language": "python",
"code": "import http.client\nimport json\n\nconn = http.client.HTTPSConnection(\"api-staging.fourkites.com\")\npayload = json.dumps({\n \"trackingInfo\": {\n \"mawb\": \"70038067644\"\n },\n \"trackingNumber\": \"70038067644\",\n \"load\": {\n \"loadNumber\": \"TEST_LOAD_01\",\n \"carrier\": \"1234\",\n \"priority\": \"high\",\n \"carrierPermalink\": \"aaa-bbb-ccc\",\n \"stops\": [\n {\n \"stopType\": \"originAirport\",\n \"airTotalPieces\": \"100\",\n \"externalAddressId\": \"MAA\",\n \"sequence\": \"1\",\n \"departingFlightNumber\": \"GTI8030\",\n \"earliestAppointmentTime\": \"2024-03-11T04:25:45.000Z\",\n \"latestAppointmentTime\": \"2024-03-11T06:25:45.000Z\"\n },\n {\n \"stopType\": \"destinationAirport\",\n \"externalAddressId\": \"ANC\",\n \"sequence\": \"2\",\n \"earliestAppointmentTime\": \"2024-04-15T04:25:45.000Z\",\n \"latestAppointmentTime\": \"2024-04-16T06:25:45.000Z\"\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": "n-DZmOHtEuWKXy0FjZ59S"
},
"results": {
"languages": [
{
"id": "QKAYpPpY8aJMfbm0uWtgN",
"language": "200",
"customLabel": "",
"code": "{\n \"statusCode\": 200,\n \"message\": \"Load creation request has been submitted successfully\",\n \"loadId\": 176366846\n}"
}
],
"selectedLanguageId": "QKAYpPpY8aJMfbm0uWtgN"
},
"request": {
"pathParameters": [],
"queryParameters": [],
"headerParameters": [],
"bodyDataParameters": [
{
"name": "trackingInfo",
"kind": "optional",
"type": "object",
"description": "It indicates the information required for tracking the load.",
"children": [
{
"name": "mawb",
"kind": "optional",
"type": "string",
"description": "The carrier’s air waybill issued to cover a consolidated shipment tendered by a forwarder or consolidator."
}
]
},
{
"name": "trackingNumber",
"kind": "optional",
"type": "string",
"description": "Any tracking number provided by the carrier or other entities.",
"children": []
},
{
"name": "load",
"kind": "required",
"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": "carrier",
"kind": "optional",
"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": "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": "carrierPermalink",
"kind": "required",
"type": "string",
"description": "It is the unique identifier for the carrier in the FK platform."
},
{
"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: \"originAirport\", \"destinationAirport\", etc. There should be at least one pickup and delivery stop or one transfer (terminal) and one delivery."
},
{
"name": "airTotalPieces",
"kind": "optional",
"type": "string",
"description": ""
},
{
"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": "sequence",
"kind": "optional",
"type": "string",
"description": "It indicates the stop's sequence on a load. The lower value indicates earliest scheduled stop completion. If the stop sequence is present for one stop on a load, it must be present on all stops. It is recommended to start at 1 and increment by 1 for each additional stop. (CM)"
},
{
"name": "departingFlightNumber",
"kind": "optional",
"type": "string",
"description": "It indicates the flight number of the departing flight from the airport stop."
},
{
"name": "earliestAppointmentTime",
"kind": "optional",
"type": "string",
"description": "It indicates the earliest scheduled arrival time at the stop in the stop's local timezone in ISO 8601 format. ISO 8601 format. If the earliestAppointmentTime is sent, then the latestAppointmentTime must also be sent."
},
{
"name": "latestAppointmentTime",
"kind": "optional",
"type": "string",
"description": "It indicates the latest scheduled arrival time at the stop in the stop's local timezone in ISO 8601 format. ISO 8601 format. If the latestAppointmentTime is sent, then the earliestAppointmentTime must also be sent. latestAppointmentTime should be greater than or equal to earliestAppointmentTime."
},
{
"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": "YAMB7MAplSnNnNkZf16xN"
}
```
:::
:::ApiMethodV2
```json
{
"name": "Azure - Production",
"method": "POST",
"url": "https://api.ng.fourkites.com/api/v1/tracking",
"description": "",
"tab": "examples",
"examples": {
"languages": [
{
"id": "n-DZmOHtEuWKXy0FjZ59S",
"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 \"mawb\": \"70038067644\"\n },\n \"trackingNumber\": \"70038067644\",\n \"load\": {\n \"loadNumber\": \"TEST_LOAD_01\",\n \"carrier\": \"1234\",\n \"priority\": \"high\",\n \"carrierPermalink\": \"aaa-bbb-ccc\",\n \"stops\": [\n {\n \"stopType\": \"originAirport\",\n \"airTotalPieces\": \"100\",\n \"externalAddressId\": \"MAA\",\n \"sequence\": \"1\",\n \"departingFlightNumber\": \"GTI8030\",\n \"earliestAppointmentTime\": \"2024-03-11T04:25:45.000Z\",\n \"latestAppointmentTime\": \"2024-03-11T06:25:45.000Z\",\n \"productLineItems\": [\n {\n \"productId\": \"0123456\",\n \"productName\": \"Air Freight Item\",\n \"productDescription\": \"Airport-to-airport air shipment item\",\n \"productCategory\": \"General Freight\",\n \"quantity\": 100,\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\": \"US\",\n \"harmonizedSystemCode\": \"8471499000\",\n \"commodityTypeCode\": \"AIR_FREIGHT\",\n \"htsusCode\": \"8471499000\",\n \"orderNumber\": \"TEST_LOAD_01\",\n \"deliveryNumber\": \"DN-MAA\",\n \"handlingUnitId\": \"PAL-MAA\",\n \"barcode\": \"PALMAA\",\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\": [\"70038067644\"],\n \"orderReferences\": [\"TEST_LOAD_01\"],\n \"brandName\": \"Generic Air Freight Co\",\n \"minimumTemperature\": 0,\n \"maximumTemperature\": 0,\n \"temperatureUnitCode\": \"cel\",\n \"labelIdentifier\": \"LBL-22EE\",\n \"productTrackingNumber\": \"70038067644-1\",\n \"deviceType\": \"RFID_TAG\"\n }\n ]\n },\n {\n \"stopType\": \"destinationAirport\",\n \"externalAddressId\": \"ANC\",\n \"sequence\": \"2\",\n \"earliestAppointmentTime\": \"2024-04-15T04:25:45.000Z\",\n \"latestAppointmentTime\": \"2024-04-16T06:25:45.000Z\",\n \"productLineItems\": [\n {\n \"productId\": \"0123456\",\n \"productName\": \"Air Freight Item\",\n \"productDescription\": \"Airport-to-airport air shipment item\",\n \"productCategory\": \"General Freight\",\n \"quantity\": 100,\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\": \"US\",\n \"harmonizedSystemCode\": \"8471499000\",\n \"commodityTypeCode\": \"AIR_FREIGHT\",\n \"htsusCode\": \"8471499000\",\n \"orderNumber\": \"TEST_LOAD_01\",\n \"deliveryNumber\": \"DN-ANC\",\n \"handlingUnitId\": \"PAL-ANC\",\n \"barcode\": \"PALANC\",\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\": [\"70038067644\"],\n \"orderReferences\": [\"TEST_LOAD_01\"],\n \"brandName\": \"Generic Air Freight Co\",\n \"minimumTemperature\": 0,\n \"maximumTemperature\": 0,\n \"temperatureUnitCode\": \"cel\",\n \"labelIdentifier\": \"LBL-22EE\",\n \"productTrackingNumber\": \"70038067644-2\",\n \"deviceType\": \"QR_CODE\"\n }\n ]\n }\n ]\n }\n}'",
"customLabel": ""
},
{
"id": "GbTGdRS4PwNqceJgtsfiu",
"language": "java",
"code": "OkHttpClient client = new OkHttpClient().newBuilder()\n .build();\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\n \\\"trackingInfo\\\": {\\n \\\"mawb\\\": \\\"70038067644\\\"\\n },\\n \\\"trackingNumber\\\": \\\"70038067644\\\",\\n \\\"load\\\": {\\n \\\"loadNumber\\\": \\\"TEST_LOAD_01\\\",\\n \\\"carrier\\\": \\\"1234\\\",\\n \\\"priority\\\": \\\"high\\\",\\n \\\"carrierPermalink\\\": \\\"aaa-bbb-ccc\\\",\\n \\\"stops\\\": [\\n {\\n \\\"stopType\\\": \\\"originAirport\\\",\\n \\\"airTotalPieces\\\": \\\"100\\\",\\n \\\"externalAddressId\\\": \\\"MAA\\\",\\n \\\"sequence\\\": \\\"1\\\",\\n \\\"departingFlightNumber\\\": \\\"GTI8030\\\",\\n \\\"earliestAppointmentTime\\\": \\\"2024-03-11T04:25:45.000Z\\\",\\n \\\"latestAppointmentTime\\\": \\\"2024-03-11T06:25:45.000Z\\\"\\n },\\n {\\n \\\"stopType\\\": \\\"destinationAirport\\\",\\n \\\"externalAddressId\\\": \\\"ANC\\\",\\n \\\"sequence\\\": \\\"2\\\",\\n \\\"earliestAppointmentTime\\\": \\\"2024-04-15T04:25:45.000Z\\\",\\n \\\"latestAppointmentTime\\\": \\\"2024-04-16T06:25:45.000Z\\\"\\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": "eNVWAy0OjYYCeDnN1Kwpa",
"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 \"mawb\": \"70038067644\"\n },\n \"trackingNumber\": \"70038067644\",\n \"load\": {\n \"loadNumber\": \"TEST_LOAD_01\",\n \"carrier\": \"1234\",\n \"priority\": \"high\",\n \"carrierPermalink\": \"aaa-bbb-ccc\",\n \"stops\": [\n {\n \"stopType\": \"originAirport\",\n \"airTotalPieces\": \"100\",\n \"externalAddressId\": \"MAA\",\n \"sequence\": \"1\",\n \"departingFlightNumber\": \"GTI8030\",\n \"earliestAppointmentTime\": \"2024-03-11T04:25:45.000Z\",\n \"latestAppointmentTime\": \"2024-03-11T06:25:45.000Z\"\n },\n {\n \"stopType\": \"destinationAirport\",\n \"externalAddressId\": \"ANC\",\n \"sequence\": \"2\",\n \"earliestAppointmentTime\": \"2024-04-15T04:25:45.000Z\",\n \"latestAppointmentTime\": \"2024-04-16T06:25:45.000Z\"\n }\n ]\n }\n }),\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});",
"customLabel": ""
},
{
"id": "VT7nWTtyBQ2rton8YCGSg",
"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 \\\"mawb\\\": \\\"70038067644\\\"\\n },\\n \\\"trackingNumber\\\": \\\"70038067644\\\",\\n \\\"load\\\": {\\n \\\"loadNumber\\\": \\\"TEST_LOAD_01\\\",\\n \\\"carrier\\\": \\\"1234\\\",\\n \\\"priority\\\": \\\"high\\\",\\n \\\"carrierPermalink\\\": \\\"aaa-bbb-ccc\\\",\\n \\\"stops\\\": [\\n {\\n \\\"stopType\\\": \\\"originAirport\\\",\\n \\\"airTotalPieces\\\": \\\"100\\\",\\n \\\"externalAddressId\\\": \\\"MAA\\\",\\n \\\"sequence\\\": \\\"1\\\",\\n \\\"departingFlightNumber\\\": \\\"GTI8030\\\",\\n \\\"earliestAppointmentTime\\\": \\\"2024-03-11T04:25:45.000Z\\\",\\n \\\"latestAppointmentTime\\\": \\\"2024-03-11T06:25:45.000Z\\\"\\n },\\n {\\n \\\"stopType\\\": \\\"destinationAirport\\\",\\n \\\"externalAddressId\\\": \\\"ANC\\\",\\n \\\"sequence\\\": \\\"2\\\",\\n \\\"earliestAppointmentTime\\\": \\\"2024-04-15T04:25:45.000Z\\\",\\n \\\"latestAppointmentTime\\\": \\\"2024-04-16T06:25:45.000Z\\\"\\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": "gbJ97PQJeBVqywkyOmLUo",
"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@\" \"\"mawb\"\": \"\"70038067644\"\"\" + \"\\n\" +\n@\" },\" + \"\\n\" +\n@\" \"\"trackingNumber\"\": \"\"70038067644\"\",\" + \"\\n\" +\n@\" \"\"load\"\": {\" + \"\\n\" +\n@\" \"\"loadNumber\"\": \"\"TEST_LOAD_01\"\",\" + \"\\n\" +\n@\" \"\"carrier\"\": \"\"1234\"\",\" + \"\\n\" +\n@\" \"\"priority\"\": \"\"high\"\",\" + \"\\n\" +\n@\" \"\"carrierPermalink\"\": \"\"aaa-bbb-ccc\"\",\" + \"\\n\" +\n@\" \"\"stops\"\": [\" + \"\\n\" +\n@\" {\" + \"\\n\" +\n@\" \"\"stopType\"\": \"\"originAirport\"\",\" + \"\\n\" +\n@\" \"\"airTotalPieces\"\": \"\"100\"\",\" + \"\\n\" +\n@\" \"\"externalAddressId\"\": \"\"MAA\"\",\" + \"\\n\" +\n@\" \"\"sequence\"\": \"\"1\"\",\" + \"\\n\" +\n@\" \"\"departingFlightNumber\"\": \"\"GTI8030\"\",\" + \"\\n\" +\n@\" \"\"earliestAppointmentTime\"\": \"\"2024-03-11T04:25:45.000Z\"\",\" + \"\\n\" +\n@\" \"\"latestAppointmentTime\"\": \"\"2024-03-11T06:25:45.000Z\"\"\" + \"\\n\" +\n@\" },\" + \"\\n\" +\n@\" {\" + \"\\n\" +\n@\" \"\"stopType\"\": \"\"destinationAirport\"\",\" + \"\\n\" +\n@\" \"\"externalAddressId\"\": \"\"ANC\"\",\" + \"\\n\" +\n@\" \"\"sequence\"\": \"\"2\"\",\" + \"\\n\" +\n@\" \"\"earliestAppointmentTime\"\": \"\"2024-04-15T04:25:45.000Z\"\",\" + \"\\n\" +\n@\" \"\"latestAppointmentTime\"\": \"\"2024-04-16T06:25:45.000Z\"\"\" + \"\\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": "33RbXtxBRsvGgb-Z8cidu",
"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 \"mawb\": \"70038067644\"\n },\n \"trackingNumber\": \"70038067644\",\n \"load\": {\n \"loadNumber\": \"TEST_LOAD_01\",\n \"carrier\": \"1234\",\n \"priority\": \"high\",\n \"carrierPermalink\": \"aaa-bbb-ccc\",\n \"stops\": [\n {\n \"stopType\": \"originAirport\",\n \"airTotalPieces\": \"100\",\n \"externalAddressId\": \"MAA\",\n \"sequence\": \"1\",\n \"departingFlightNumber\": \"GTI8030\",\n \"earliestAppointmentTime\": \"2024-03-11T04:25:45.000Z\",\n \"latestAppointmentTime\": \"2024-03-11T06:25:45.000Z\"\n },\n {\n \"stopType\": \"destinationAirport\",\n \"externalAddressId\": \"ANC\",\n \"sequence\": \"2\",\n \"earliestAppointmentTime\": \"2024-04-15T04:25:45.000Z\",\n \"latestAppointmentTime\": \"2024-04-16T06:25:45.000Z\"\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": "c7fZtgJLFrypW0vz2ZvBS",
"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 \"mawb\": \"70038067644\"\n },\n \"trackingNumber\": \"70038067644\",\n \"load\": {\n \"loadNumber\": \"TEST_LOAD_01\",\n \"carrier\": \"1234\",\n \"priority\": \"high\",\n \"carrierPermalink\": \"aaa-bbb-ccc\",\n \"stops\": [\n {\n \"stopType\": \"originAirport\",\n \"airTotalPieces\": \"100\",\n \"externalAddressId\": \"MAA\",\n \"sequence\": \"1\",\n \"departingFlightNumber\": \"GTI8030\",\n \"earliestAppointmentTime\": \"2024-03-11T04:25:45.000Z\",\n \"latestAppointmentTime\": \"2024-03-11T06:25:45.000Z\"\n },\n {\n \"stopType\": \"destinationAirport\",\n \"externalAddressId\": \"ANC\",\n \"sequence\": \"2\",\n \"earliestAppointmentTime\": \"2024-04-15T04:25:45.000Z\",\n \"latestAppointmentTime\": \"2024-04-16T06:25:45.000Z\"\n }\n ]\n }\n})\n\nresponse = https.request(request)\nputs response.read_body\n",
"customLabel": ""
},
{
"id": "njlpP6vTYD4QDEku7rCsu",
"language": "python",
"code": "import http.client\nimport json\n\nconn = http.client.HTTPSConnection(\"api.ng.fourkites.com\")\npayload = json.dumps({\n \"trackingInfo\": {\n \"mawb\": \"70038067644\"\n },\n \"trackingNumber\": \"70038067644\",\n \"load\": {\n \"loadNumber\": \"TEST_LOAD_01\",\n \"carrier\": \"1234\",\n \"priority\": \"high\",\n \"carrierPermalink\": \"aaa-bbb-ccc\",\n \"stops\": [\n {\n \"stopType\": \"originAirport\",\n \"airTotalPieces\": \"100\",\n \"externalAddressId\": \"MAA\",\n \"sequence\": \"1\",\n \"departingFlightNumber\": \"GTI8030\",\n \"earliestAppointmentTime\": \"2024-03-11T04:25:45.000Z\",\n \"latestAppointmentTime\": \"2024-03-11T06:25:45.000Z\"\n },\n {\n \"stopType\": \"destinationAirport\",\n \"externalAddressId\": \"ANC\",\n \"sequence\": \"2\",\n \"earliestAppointmentTime\": \"2024-04-15T04:25:45.000Z\",\n \"latestAppointmentTime\": \"2024-04-16T06:25:45.000Z\"\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": "njlpP6vTYD4QDEku7rCsu"
},
"results": {
"languages": [
{
"id": "QKAYpPpY8aJMfbm0uWtgN",
"language": "200",
"customLabel": "",
"code": "{\n \"statusCode\": 200,\n \"message\": \"Load creation request has been submitted successfully\",\n \"loadId\": 176366846\n}"
}
],
"selectedLanguageId": "QKAYpPpY8aJMfbm0uWtgN"
},
"request": {
"pathParameters": [],
"queryParameters": [],
"headerParameters": [],
"bodyDataParameters": [
{
"name": "trackingInfo",
"kind": "optional",
"type": "object",
"description": "It indicates the information required for tracking the load.",
"children": [
{
"name": "mawb",
"kind": "optional",
"type": "string",
"description": "The carrier’s air waybill issued to cover a consolidated shipment tendered by a forwarder or consolidator."
}
]
},
{
"name": "trackingNumber",
"kind": "optional",
"type": "string",
"description": "Any tracking number provided by the carrier or other entities.",
"children": []
},
{
"name": "load",
"kind": "required",
"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": "carrier",
"kind": "optional",
"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": "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": "carrierPermalink",
"kind": "required",
"type": "string",
"description": "It is the unique identifier for the carrier in the FK platform."
},
{
"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: \"originAirport\", \"destinationAirport\", etc. There should be at least one pickup and delivery stop or one transfer (terminal) and one delivery."
},
{
"name": "airTotalPieces",
"kind": "optional",
"type": "string",
"description": ""
},
{
"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": "sequence",
"kind": "optional",
"type": "string",
"description": "It indicates the stop's sequence on a load. The lower value indicates earliest scheduled stop completion. If the stop sequence is present for one stop on a load, it must be present on all stops. It is recommended to start at 1 and increment by 1 for each additional stop. (CM)"
},
{
"name": "departingFlightNumber",
"kind": "optional",
"type": "string",
"description": "It indicates the flight number of the departing flight from the airport stop."
},
{
"name": "earliestAppointmentTime",
"kind": "optional",
"type": "string",
"description": "It indicates the earliest scheduled arrival time at the stop in the stop's local timezone in ISO 8601 format. ISO 8601 format. If the earliestAppointmentTime is sent, then the latestAppointmentTime must also be sent."
},
{
"name": "latestAppointmentTime",
"kind": "optional",
"type": "string",
"description": "It indicates the latest scheduled arrival time at the stop in the stop's local timezone in ISO 8601 format. ISO 8601 format. If the latestAppointmentTime is sent, then the earliestAppointmentTime must also be sent. latestAppointmentTime should be greater than or equal to earliestAppointmentTime."
},
{
"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": "6q_nxnioJMLbg7zuaOjqZ"
}
```
:::
:::ApiMethodV2
```json
{
"name": "Azure - Staging",
"method": "POST",
"url": "https://api-staging.ng.fourkites.com/api/v1/tracking",
"description": "",
"tab": "examples",
"examples": {
"languages": [
{
"id": "n-DZmOHtEuWKXy0FjZ59S",
"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 \"mawb\": \"70038067644\"\n },\n \"trackingNumber\": \"70038067644\",\n \"load\": {\n \"loadNumber\": \"TEST_LOAD_01\",\n \"carrier\": \"1234\",\n \"priority\": \"high\",\n \"carrierPermalink\": \"aaa-bbb-ccc\",\n \"stops\": [\n {\n \"stopType\": \"originAirport\",\n \"airTotalPieces\": \"100\",\n \"externalAddressId\": \"MAA\",\n \"sequence\": \"1\",\n \"departingFlightNumber\": \"GTI8030\",\n \"earliestAppointmentTime\": \"2024-03-11T04:25:45.000Z\",\n \"latestAppointmentTime\": \"2024-03-11T06:25:45.000Z\",\n \"productLineItems\": [\n {\n \"productId\": \"0123456\",\n \"productName\": \"Air Freight Item\",\n \"productDescription\": \"Airport-to-airport air shipment item\",\n \"productCategory\": \"General Freight\",\n \"quantity\": 100,\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\": \"US\",\n \"harmonizedSystemCode\": \"8471499000\",\n \"commodityTypeCode\": \"AIR_FREIGHT\",\n \"htsusCode\": \"8471499000\",\n \"orderNumber\": \"TEST_LOAD_01\",\n \"deliveryNumber\": \"DN-MAA\",\n \"handlingUnitId\": \"PAL-MAA\",\n \"barcode\": \"PALMAA\",\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\": [\"70038067644\"],\n \"orderReferences\": [\"TEST_LOAD_01\"],\n \"brandName\": \"Generic Air Freight Co\",\n \"minimumTemperature\": 0,\n \"maximumTemperature\": 0,\n \"temperatureUnitCode\": \"cel\",\n \"labelIdentifier\": \"LBL-22EE\",\n \"productTrackingNumber\": \"70038067644-1\",\n \"deviceType\": \"RFID_TAG\"\n }\n ]\n },\n {\n \"stopType\": \"destinationAirport\",\n \"externalAddressId\": \"ANC\",\n \"sequence\": \"2\",\n \"earliestAppointmentTime\": \"2024-04-15T04:25:45.000Z\",\n \"latestAppointmentTime\": \"2024-04-16T06:25:45.000Z\",\n \"productLineItems\": [\n {\n \"productId\": \"0123456\",\n \"productName\": \"Air Freight Item\",\n \"productDescription\": \"Airport-to-airport air shipment item\",\n \"productCategory\": \"General Freight\",\n \"quantity\": 100,\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\": \"US\",\n \"harmonizedSystemCode\": \"8471499000\",\n \"commodityTypeCode\": \"AIR_FREIGHT\",\n \"htsusCode\": \"8471499000\",\n \"orderNumber\": \"TEST_LOAD_01\",\n \"deliveryNumber\": \"DN-ANC\",\n \"handlingUnitId\": \"PAL-ANC\",\n \"barcode\": \"PALANC\",\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\": [\"70038067644\"],\n \"orderReferences\": [\"TEST_LOAD_01\"],\n \"brandName\": \"Generic Air Freight Co\",\n \"minimumTemperature\": 0,\n \"maximumTemperature\": 0,\n \"temperatureUnitCode\": \"cel\",\n \"labelIdentifier\": \"LBL-22EE\",\n \"productTrackingNumber\": \"70038067644-2\",\n \"deviceType\": \"QR_CODE\"\n }\n ]\n }\n ]\n }\n}'",
"customLabel": ""
},
{
"id": "GbTGdRS4PwNqceJgtsfiu",
"language": "java",
"code": "OkHttpClient client = new OkHttpClient().newBuilder()\n .build();\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\n \\\"trackingInfo\\\": {\\n \\\"mawb\\\": \\\"70038067644\\\"\\n },\\n \\\"trackingNumber\\\": \\\"70038067644\\\",\\n \\\"load\\\": {\\n \\\"loadNumber\\\": \\\"TEST_LOAD_01\\\",\\n \\\"carrier\\\": \\\"1234\\\",\\n \\\"priority\\\": \\\"high\\\",\\n \\\"carrierPermalink\\\": \\\"aaa-bbb-ccc\\\",\\n \\\"stops\\\": [\\n {\\n \\\"stopType\\\": \\\"originAirport\\\",\\n \\\"airTotalPieces\\\": \\\"100\\\",\\n \\\"externalAddressId\\\": \\\"MAA\\\",\\n \\\"sequence\\\": \\\"1\\\",\\n \\\"departingFlightNumber\\\": \\\"GTI8030\\\",\\n \\\"earliestAppointmentTime\\\": \\\"2024-03-11T04:25:45.000Z\\\",\\n \\\"latestAppointmentTime\\\": \\\"2024-03-11T06:25:45.000Z\\\"\\n },\\n {\\n \\\"stopType\\\": \\\"destinationAirport\\\",\\n \\\"externalAddressId\\\": \\\"ANC\\\",\\n \\\"sequence\\\": \\\"2\\\",\\n \\\"earliestAppointmentTime\\\": \\\"2024-04-15T04:25:45.000Z\\\",\\n \\\"latestAppointmentTime\\\": \\\"2024-04-16T06:25:45.000Z\\\"\\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": "eNVWAy0OjYYCeDnN1Kwpa",
"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 \"mawb\": \"70038067644\"\n },\n \"trackingNumber\": \"70038067644\",\n \"load\": {\n \"loadNumber\": \"TEST_LOAD_01\",\n \"carrier\": \"1234\",\n \"priority\": \"high\",\n \"carrierPermalink\": \"aaa-bbb-ccc\",\n \"stops\": [\n {\n \"stopType\": \"originAirport\",\n \"airTotalPieces\": \"100\",\n \"externalAddressId\": \"MAA\",\n \"sequence\": \"1\",\n \"departingFlightNumber\": \"GTI8030\",\n \"earliestAppointmentTime\": \"2024-03-11T04:25:45.000Z\",\n \"latestAppointmentTime\": \"2024-03-11T06:25:45.000Z\"\n },\n {\n \"stopType\": \"destinationAirport\",\n \"externalAddressId\": \"ANC\",\n \"sequence\": \"2\",\n \"earliestAppointmentTime\": \"2024-04-15T04:25:45.000Z\",\n \"latestAppointmentTime\": \"2024-04-16T06:25:45.000Z\"\n }\n ]\n }\n }),\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});",
"customLabel": ""
},
{
"id": "VT7nWTtyBQ2rton8YCGSg",
"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 \\\"mawb\\\": \\\"70038067644\\\"\\n },\\n \\\"trackingNumber\\\": \\\"70038067644\\\",\\n \\\"load\\\": {\\n \\\"loadNumber\\\": \\\"TEST_LOAD_01\\\",\\n \\\"carrier\\\": \\\"1234\\\",\\n \\\"priority\\\": \\\"high\\\",\\n \\\"carrierPermalink\\\": \\\"aaa-bbb-ccc\\\",\\n \\\"stops\\\": [\\n {\\n \\\"stopType\\\": \\\"originAirport\\\",\\n \\\"airTotalPieces\\\": \\\"100\\\",\\n \\\"externalAddressId\\\": \\\"MAA\\\",\\n \\\"sequence\\\": \\\"1\\\",\\n \\\"departingFlightNumber\\\": \\\"GTI8030\\\",\\n \\\"earliestAppointmentTime\\\": \\\"2024-03-11T04:25:45.000Z\\\",\\n \\\"latestAppointmentTime\\\": \\\"2024-03-11T06:25:45.000Z\\\"\\n },\\n {\\n \\\"stopType\\\": \\\"destinationAirport\\\",\\n \\\"externalAddressId\\\": \\\"ANC\\\",\\n \\\"sequence\\\": \\\"2\\\",\\n \\\"earliestAppointmentTime\\\": \\\"2024-04-15T04:25:45.000Z\\\",\\n \\\"latestAppointmentTime\\\": \\\"2024-04-16T06:25:45.000Z\\\"\\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": "gbJ97PQJeBVqywkyOmLUo",
"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@\" \"\"mawb\"\": \"\"70038067644\"\"\" + \"\\n\" +\n@\" },\" + \"\\n\" +\n@\" \"\"trackingNumber\"\": \"\"70038067644\"\",\" + \"\\n\" +\n@\" \"\"load\"\": {\" + \"\\n\" +\n@\" \"\"loadNumber\"\": \"\"TEST_LOAD_01\"\",\" + \"\\n\" +\n@\" \"\"carrier\"\": \"\"1234\"\",\" + \"\\n\" +\n@\" \"\"priority\"\": \"\"high\"\",\" + \"\\n\" +\n@\" \"\"carrierPermalink\"\": \"\"aaa-bbb-ccc\"\",\" + \"\\n\" +\n@\" \"\"stops\"\": [\" + \"\\n\" +\n@\" {\" + \"\\n\" +\n@\" \"\"stopType\"\": \"\"originAirport\"\",\" + \"\\n\" +\n@\" \"\"airTotalPieces\"\": \"\"100\"\",\" + \"\\n\" +\n@\" \"\"externalAddressId\"\": \"\"MAA\"\",\" + \"\\n\" +\n@\" \"\"sequence\"\": \"\"1\"\",\" + \"\\n\" +\n@\" \"\"departingFlightNumber\"\": \"\"GTI8030\"\",\" + \"\\n\" +\n@\" \"\"earliestAppointmentTime\"\": \"\"2024-03-11T04:25:45.000Z\"\",\" + \"\\n\" +\n@\" \"\"latestAppointmentTime\"\": \"\"2024-03-11T06:25:45.000Z\"\"\" + \"\\n\" +\n@\" },\" + \"\\n\" +\n@\" {\" + \"\\n\" +\n@\" \"\"stopType\"\": \"\"destinationAirport\"\",\" + \"\\n\" +\n@\" \"\"externalAddressId\"\": \"\"ANC\"\",\" + \"\\n\" +\n@\" \"\"sequence\"\": \"\"2\"\",\" + \"\\n\" +\n@\" \"\"earliestAppointmentTime\"\": \"\"2024-04-15T04:25:45.000Z\"\",\" + \"\\n\" +\n@\" \"\"latestAppointmentTime\"\": \"\"2024-04-16T06:25:45.000Z\"\"\" + \"\\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": "33RbXtxBRsvGgb-Z8cidu",
"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 \"mawb\": \"70038067644\"\n },\n \"trackingNumber\": \"70038067644\",\n \"load\": {\n \"loadNumber\": \"TEST_LOAD_01\",\n \"carrier\": \"1234\",\n \"priority\": \"high\",\n \"carrierPermalink\": \"aaa-bbb-ccc\",\n \"stops\": [\n {\n \"stopType\": \"originAirport\",\n \"airTotalPieces\": \"100\",\n \"externalAddressId\": \"MAA\",\n \"sequence\": \"1\",\n \"departingFlightNumber\": \"GTI8030\",\n \"earliestAppointmentTime\": \"2024-03-11T04:25:45.000Z\",\n \"latestAppointmentTime\": \"2024-03-11T06:25:45.000Z\"\n },\n {\n \"stopType\": \"destinationAirport\",\n \"externalAddressId\": \"ANC\",\n \"sequence\": \"2\",\n \"earliestAppointmentTime\": \"2024-04-15T04:25:45.000Z\",\n \"latestAppointmentTime\": \"2024-04-16T06:25:45.000Z\"\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": "c7fZtgJLFrypW0vz2ZvBS",
"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 \"mawb\": \"70038067644\"\n },\n \"trackingNumber\": \"70038067644\",\n \"load\": {\n \"loadNumber\": \"TEST_LOAD_01\",\n \"carrier\": \"1234\",\n \"priority\": \"high\",\n \"carrierPermalink\": \"aaa-bbb-ccc\",\n \"stops\": [\n {\n \"stopType\": \"originAirport\",\n \"airTotalPieces\": \"100\",\n \"externalAddressId\": \"MAA\",\n \"sequence\": \"1\",\n \"departingFlightNumber\": \"GTI8030\",\n \"earliestAppointmentTime\": \"2024-03-11T04:25:45.000Z\",\n \"latestAppointmentTime\": \"2024-03-11T06:25:45.000Z\"\n },\n {\n \"stopType\": \"destinationAirport\",\n \"externalAddressId\": \"ANC\",\n \"sequence\": \"2\",\n \"earliestAppointmentTime\": \"2024-04-15T04:25:45.000Z\",\n \"latestAppointmentTime\": \"2024-04-16T06:25:45.000Z\"\n }\n ]\n }\n})\n\nresponse = https.request(request)\nputs response.read_body\n",
"customLabel": ""
},
{
"id": "njlpP6vTYD4QDEku7rCsu",
"language": "python",
"code": "import http.client\nimport json\n\nconn = http.client.HTTPSConnection(\"api-staging.ng.fourkites.com\")\npayload = json.dumps({\n \"trackingInfo\": {\n \"mawb\": \"70038067644\"\n },\n \"trackingNumber\": \"70038067644\",\n \"load\": {\n \"loadNumber\": \"TEST_LOAD_01\",\n \"carrier\": \"1234\",\n \"priority\": \"high\",\n \"carrierPermalink\": \"aaa-bbb-ccc\",\n \"stops\": [\n {\n \"stopType\": \"originAirport\",\n \"airTotalPieces\": \"100\",\n \"externalAddressId\": \"MAA\",\n \"sequence\": \"1\",\n \"departingFlightNumber\": \"GTI8030\",\n \"earliestAppointmentTime\": \"2024-03-11T04:25:45.000Z\",\n \"latestAppointmentTime\": \"2024-03-11T06:25:45.000Z\"\n },\n {\n \"stopType\": \"destinationAirport\",\n \"externalAddressId\": \"ANC\",\n \"sequence\": \"2\",\n \"earliestAppointmentTime\": \"2024-04-15T04:25:45.000Z\",\n \"latestAppointmentTime\": \"2024-04-16T06:25:45.000Z\"\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": "njlpP6vTYD4QDEku7rCsu"
},
"results": {
"languages": [
{
"id": "QKAYpPpY8aJMfbm0uWtgN",
"language": "200",
"customLabel": "",
"code": "{\n \"statusCode\": 200,\n \"message\": \"Load creation request has been submitted successfully\",\n \"loadId\": 176366846\n}"
}
],
"selectedLanguageId": "QKAYpPpY8aJMfbm0uWtgN"
},
"request": {
"pathParameters": [],
"queryParameters": [],
"headerParameters": [],
"bodyDataParameters": [
{
"name": "trackingInfo",
"kind": "optional",
"type": "object",
"description": "It indicates the information required for tracking the load.",
"children": [
{
"name": "mawb",
"kind": "optional",
"type": "string",
"description": "The carrier’s air waybill issued to cover a consolidated shipment tendered by a forwarder or consolidator."
}
]
},
{
"name": "trackingNumber",
"kind": "optional",
"type": "string",
"description": "Any tracking number provided by the carrier or other entities.",
"children": []
},
{
"name": "load",
"kind": "required",
"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": "carrier",
"kind": "optional",
"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": "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": "carrierPermalink",
"kind": "required",
"type": "string",
"description": "It is the unique identifier for the carrier in the FK platform."
},
{
"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: \"originAirport\", \"destinationAirport\", etc. There should be at least one pickup and delivery stop or one transfer (terminal) and one delivery."
},
{
"name": "airTotalPieces",
"kind": "optional",
"type": "string",
"description": ""
},
{
"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": "sequence",
"kind": "optional",
"type": "string",
"description": "It indicates the stop's sequence on a load. The lower value indicates earliest scheduled stop completion. If the stop sequence is present for one stop on a load, it must be present on all stops. It is recommended to start at 1 and increment by 1 for each additional stop. (CM)"
},
{
"name": "departingFlightNumber",
"kind": "optional",
"type": "string",
"description": "It indicates the flight number of the departing flight from the airport stop."
},
{
"name": "earliestAppointmentTime",
"kind": "optional",
"type": "string",
"description": "It indicates the earliest scheduled arrival time at the stop in the stop's local timezone in ISO 8601 format. ISO 8601 format. If the earliestAppointmentTime is sent, then the latestAppointmentTime must also be sent."
},
{
"name": "latestAppointmentTime",
"kind": "optional",
"type": "string",
"description": "It indicates the latest scheduled arrival time at the stop in the stop's local timezone in ISO 8601 format. ISO 8601 format. If the latestAppointmentTime is sent, then the earliestAppointmentTime must also be sent. latestAppointmentTime should be greater than or equal to earliestAppointmentTime."
},
{
"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": "JJPl-5TwpNdDvooJpNFLS"
}
```
:::