---
title: Easy Load Create (Air)
slug: fourkites-api-reference/easy-load-create-air
icon: {"apiMethod":"POST"}
createdAt: 2024-04-24T14:35:10.000Z
---
Air Booking/Easy Load Create API will allow users to create loads based on the reference numbers such as Booking Number, Bill of Lading, and/or container number.
:::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"}
### Rate Limit
**1 request per second**
:::
:::hint{type="info"}
### Format Supported
**JSON**
:::
:::hint{type="info"}
### Authenticated Resource
Users can make use of their application login credentials (**Username and Password**) as the means of authenticating (**Basic Auth**).
:::
For more information on Authentication, [click here](https://docs.fourkites.com/api-reference/authentication).
:::ApiMethodV2
```json
{
"name": "Production",
"method": "POST",
"url": "https://multimodal-load-api.fourkites.com/api/v1/add_loads",
"description": "",
"tab": "examples",
"examples": {
"languages": [
{
"id": "Ei4QprZLP3i5iDBFA1t16",
"language": "curl",
"code": "curl --location --request POST 'https://multimodal-load-api.fourkites.com/api/v1/add_loads' \\\n--header 'Authorization: Basic cmFqa2lyYW4ubWFub2hhcmFuQGZvdXJraXRlcy5jb206UmFqa2lyYW5tMg==' \\\n--header 'Content-Type: application/json' \\\n--data-raw '[\n {\n \"hawb\": \"200XXXXXXXX\",\n \"asn\": \"ASN_XXXXXXXXXX\",\n \"freight_forwarder\": \"XXXX\",\n \"mode\": [\n \"air\"\n ],\n \"pickup_stop\": {\n \"address_line1\": \"XXXXX T ST\",\n \"city\": \"XXYYXX\",\n \"state\": \"NE\",\n \"country\": \"US\",\n \"postal_code\": \"12345\",\n \"name\": \"D-XXXX-ZSG\",\n \"stop_reference_id\": \"AA1-D-AERWA-ZSG_8\"\n },\n \"pickup_appointment_time\": \"2023-09-01T15:02:32+00:00\",\n \"delivery_stop\": {\n \"address_line1\": \"No. 5 Changi North Way\",\n \"address_line2\": \"Level 4 Warehouse\",\n \"city\": \"Singapore\",\n \"country\": \"SG\",\n \"postal_code\": \"112233\",\n \"name\": \"SG1\",\n \"stop_reference_id\": \"BB2-SG1_8\"\n },\n \"delivery_appointment_time\": \"2023-10-29T15:02:32+00:00\",\n \"pallets\": [\n {\n \"number\": \"PAL-001\",\n \"parts\": [\n {\n \"shipperPartNumber\": \"22EE\",\n \"customerPartNumber\": \"22EE\",\n \"quantity\": \"25\",\n \"weight\": \"7.998\"\n }\n ]\n }\n ],\n \"productLineItems\": [\n {\n \"productId\": \"0123456\",\n \"productName\": \"Air Freight Item\",\n \"productDescription\": \"Air freight shipment item\",\n \"productCategory\": \"General Freight\",\n \"quantity\": 25,\n \"measurementUnitCode\": \"PCE\",\n \"netWeight\": 44.8,\n \"weightUnit\": \"KGM\",\n \"unitCost\": 25.0,\n \"currencyCode\": \"USD\",\n \"extendedCost\": 625.00,\n \"freightCost\": 20.00,\n \"additionalCharges\": 5.00,\n \"tariffCost\": 2.50,\n \"fourKitesCalculatedTariffCost\": 2.50,\n \"totalLandedCost\": 655.00,\n \"countryOfOrigin\": \"US\",\n \"harmonizedSystemCode\": \"8471499000\",\n \"commodityTypeCode\": \"AIR_FREIGHT\",\n \"htsusCode\": \"8471499000\",\n \"orderNumber\": \"ASN_XXXXXXXXXX\",\n \"deliveryNumber\": \"DN-PAL001\",\n \"handlingUnitId\": \"PAL-001\",\n \"barcode\": \"PAL001\",\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\": [\"200XXXXXXXX\"],\n \"orderReferences\": [\"ASN_XXXXXXXXXX\"],\n \"brandName\": \"Generic Air Freight Co\",\n \"minimumTemperature\": 0,\n \"maximumTemperature\": 0,\n \"temperatureUnitCode\": \"cel\",\n \"labelIdentifier\": \"LBL-22EE\",\n \"productTrackingNumber\": \"200XXXXXXXX\",\n \"deviceType\": \"RFID_TAG\"\n }\n ]\n }\n]'",
"customLabel": ""
},
{
"id": "3DB6iUzBvS5VLQAF-PkWx",
"language": "java",
"code": "OkHttpClient client = new OkHttpClient().newBuilder()\n .build();\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"[\\n {\\n \\\"hawb\\\": \\\"200XXXXXXXX\\\",\\n \\\"asn\\\": \\\"ASN_XXXXXXXXXX\\\",\\n \\\"freight_forwarder\\\": \\\"XXXX\\\",\\n \\\"mode\\\": [\\n \\\"air\\\"\\n ],\\n \\\"pickup_stop\\\": {\\n \\\"address_line1\\\": \\\"XXXXX T ST\\\",\\n \\\"city\\\": \\\"XXYYXX\\\",\\n \\\"state\\\": \\\"NE\\\",\\n \\\"country\\\": \\\"US\\\",\\n \\\"postal_code\\\": \\\"12345\\\",\\n \\\"name\\\": \\\"D-XXXX-ZSG\\\",\\n \\\"stop_reference_id\\\": \\\"AA1-D-AERWA-ZSG_8\\\"\\n },\\n \\\"pickup_appointment_time\\\": \\\"2023-09-01T15:02:32+00:00\\\",\\n \\\"delivery_stop\\\": {\\n \\\"address_line1\\\": \\\"No. 5 Changi North Way\\\",\\n \\\"address_line2\\\": \\\"Level 4 Warehouse\\\",\\n \\\"city\\\": \\\"Singapore\\\",\\n \\\"country\\\": \\\"SG\\\",\\n \\\"postal_code\\\": \\\"112233\\\",\\n \\\"name\\\": \\\"SG1\\\",\\n \\\"stop_reference_id\\\": \\\"BB2-SG1_8\\\"\\n },\\n \\\"delivery_appointment_time\\\": \\\"2023-10-29T15:02:32+00:00\\\"\\n }\\n]\");\nRequest request = new Request.Builder()\n .url(\"https://multimodal-load-api.fourkites.com/api/v1/add_loads\")\n .method(\"POST\", body)\n .addHeader(\"Authorization\", \"Basic cmFqa2lyYW4ubWFub2hhcmFuQGZvdXJraXRlcy5jb206UmFqa2lyYW5tMg==\")\n .addHeader(\"Content-Type\", \"application/json\")\n .build();\nResponse response = client.newCall(request).execute();",
"customLabel": ""
},
{
"id": "Jj06JRCdmjYV-l6I-R8Gu",
"language": "javascript",
"code": "var settings = {\n \"url\": \"https://multimodal-load-api.fourkites.com/api/v1/add_loads\",\n \"method\": \"POST\",\n \"timeout\": 0,\n \"headers\": {\n \"Authorization\": \"Basic cmFqa2lyYW4ubWFub2hhcmFuQGZvdXJraXRlcy5jb206UmFqa2lyYW5tMg==\",\n \"Content-Type\": \"application/json\"\n },\n \"data\": JSON.stringify([\n {\n \"hawb\": \"200XXXXXXXX\",\n \"asn\": \"ASN_XXXXXXXXXX\",\n \"freight_forwarder\": \"XXXX\",\n \"mode\": [\n \"air\"\n ],\n \"pickup_stop\": {\n \"address_line1\": \"XXXXX T ST\",\n \"city\": \"XXYYXX\",\n \"state\": \"NE\",\n \"country\": \"US\",\n \"postal_code\": \"12345\",\n \"name\": \"D-XXXX-ZSG\",\n \"stop_reference_id\": \"AA1-D-AERWA-ZSG_8\"\n },\n \"pickup_appointment_time\": \"2023-09-01T15:02:32+00:00\",\n \"delivery_stop\": {\n \"address_line1\": \"No. 5 Changi North Way\",\n \"address_line2\": \"Level 4 Warehouse\",\n \"city\": \"Singapore\",\n \"country\": \"SG\",\n \"postal_code\": \"112233\",\n \"name\": \"SG1\",\n \"stop_reference_id\": \"BB2-SG1_8\"\n },\n \"delivery_appointment_time\": \"2023-10-29T15:02:32+00:00\"\n }\n ]),\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});",
"customLabel": ""
},
{
"id": "yGmIb7AZAzybK390tmSu1",
"language": "swift",
"code": "import Foundation\n#if canImport(FoundationNetworking)\nimport FoundationNetworking\n#endif\n\nvar semaphore = DispatchSemaphore (value: 0)\n\nlet parameters = \"[\\n {\\n \\\"hawb\\\": \\\"200XXXXXXXX\\\",\\n \\\"asn\\\": \\\"ASN_XXXXXXXXXX\\\",\\n \\\"freight_forwarder\\\": \\\"XXXX\\\",\\n \\\"mode\\\": [\\n \\\"air\\\"\\n ],\\n \\\"pickup_stop\\\": {\\n \\\"address_line1\\\": \\\"XXXXX T ST\\\",\\n \\\"city\\\": \\\"XXYYXX\\\",\\n \\\"state\\\": \\\"NE\\\",\\n \\\"country\\\": \\\"US\\\",\\n \\\"postal_code\\\": \\\"12345\\\",\\n \\\"name\\\": \\\"D-XXXX-ZSG\\\",\\n \\\"stop_reference_id\\\": \\\"AA1-D-AERWA-ZSG_8\\\"\\n },\\n \\\"pickup_appointment_time\\\": \\\"2023-09-01T15:02:32+00:00\\\",\\n \\\"delivery_stop\\\": {\\n \\\"address_line1\\\": \\\"No. 5 Changi North Way\\\",\\n \\\"address_line2\\\": \\\"Level 4 Warehouse\\\",\\n \\\"city\\\": \\\"Singapore\\\",\\n \\\"country\\\": \\\"SG\\\",\\n \\\"postal_code\\\": \\\"112233\\\",\\n \\\"name\\\": \\\"SG1\\\",\\n \\\"stop_reference_id\\\": \\\"BB2-SG1_8\\\"\\n },\\n \\\"delivery_appointment_time\\\": \\\"2023-10-29T15:02:32+00:00\\\"\\n }\\n]\"\nlet postData = parameters.data(using: .utf8)\n\nvar request = URLRequest(url: URL(string: \"https://multimodal-load-api.fourkites.com/api/v1/add_loads\")!,timeoutInterval: Double.infinity)\nrequest.addValue(\"Basic cmFqa2lyYW4ubWFub2hhcmFuQGZvdXJraXRlcy5jb206UmFqa2lyYW5tMg==\", forHTTPHeaderField: \"Authorization\")\nrequest.addValue(\"application/json\", forHTTPHeaderField: \"Content-Type\")\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": "cuIEmjjj_sUBFK-ItaOrU",
"language": "csharp",
"code": "var client = new RestClient(\"https://multimodal-load-api.fourkites.com/api/v1/add_loads\");\nclient.Timeout = -1;\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Authorization\", \"Basic cmFqa2lyYW4ubWFub2hhcmFuQGZvdXJraXRlcy5jb206UmFqa2lyYW5tMg==\");\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nvar body = @\"[\" + \"\\n\" +\n@\" {\" + \"\\n\" +\n@\" \"\"hawb\"\": \"\"200XXXXXXXX\"\",\" + \"\\n\" +\n@\" \"\"asn\"\": \"\"ASN_XXXXXXXXXX\"\",\" + \"\\n\" +\n@\" \"\"freight_forwarder\"\": \"\"XXXX\"\",\" + \"\\n\" +\n@\" \"\"mode\"\": [\" + \"\\n\" +\n@\" \"\"air\"\"\" + \"\\n\" +\n@\" ],\" + \"\\n\" +\n@\" \"\"pickup_stop\"\": {\" + \"\\n\" +\n@\" \"\"address_line1\"\": \"\"XXXXX T ST\"\",\" + \"\\n\" +\n@\" \"\"city\"\": \"\"XXYYXX\"\",\" + \"\\n\" +\n@\" \"\"state\"\": \"\"NE\"\",\" + \"\\n\" +\n@\" \"\"country\"\": \"\"US\"\",\" + \"\\n\" +\n@\" \"\"postal_code\"\": \"\"12345\"\",\" + \"\\n\" +\n@\" \"\"name\"\": \"\"D-XXXX-ZSG\"\",\" + \"\\n\" +\n@\" \"\"stop_reference_id\"\": \"\"AA1-D-AERWA-ZSG_8\"\"\" + \"\\n\" +\n@\" },\" + \"\\n\" +\n@\" \"\"pickup_appointment_time\"\": \"\"2023-09-01T15:02:32+00:00\"\",\" + \"\\n\" +\n@\" \"\"delivery_stop\"\": {\" + \"\\n\" +\n@\" \"\"address_line1\"\": \"\"No. 5 Changi North Way\"\",\" + \"\\n\" +\n@\" \"\"address_line2\"\": \"\"Level 4 Warehouse\"\",\" + \"\\n\" +\n@\" \"\"city\"\": \"\"Singapore\"\",\" + \"\\n\" +\n@\" \"\"country\"\": \"\"SG\"\",\" + \"\\n\" +\n@\" \"\"postal_code\"\": \"\"112233\"\",\" + \"\\n\" +\n@\" \"\"name\"\": \"\"SG1\"\",\" + \"\\n\" +\n@\" \"\"stop_reference_id\"\": \"\"BB2-SG1_8\"\"\" + \"\\n\" +\n@\" },\" + \"\\n\" +\n@\" \"\"delivery_appointment_time\"\": \"\"2023-10-29T15:02:32+00:00\"\"\" + \"\\n\" +\n@\" }\" + \"\\n\" +\n@\"]\";\nrequest.AddParameter(\"application/json\", body, ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);\nConsole.WriteLine(response.Content);",
"customLabel": ""
},
{
"id": "I7bXPcz3bZl1H6oH0elzD",
"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://multimodal-load-api.fourkites.com/api/v1/add_loads\"\n method := \"POST\"\n\n payload := strings.NewReader(`[\n {\n \"hawb\": \"200XXXXXXXX\",\n \"asn\": \"ASN_XXXXXXXXXX\",\n \"freight_forwarder\": \"XXXX\",\n \"mode\": [\n \"air\"\n ],\n \"pickup_stop\": {\n \"address_line1\": \"XXXXX T ST\",\n \"city\": \"XXYYXX\",\n \"state\": \"NE\",\n \"country\": \"US\",\n \"postal_code\": \"12345\",\n \"name\": \"D-XXXX-ZSG\",\n \"stop_reference_id\": \"AA1-D-AERWA-ZSG_8\"\n },\n \"pickup_appointment_time\": \"2023-09-01T15:02:32+00:00\",\n \"delivery_stop\": {\n \"address_line1\": \"No. 5 Changi North Way\",\n \"address_line2\": \"Level 4 Warehouse\",\n \"city\": \"Singapore\",\n \"country\": \"SG\",\n \"postal_code\": \"112233\",\n \"name\": \"SG1\",\n \"stop_reference_id\": \"BB2-SG1_8\"\n },\n \"delivery_appointment_time\": \"2023-10-29T15:02:32+00:00\"\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(\"Authorization\", \"Basic cmFqa2lyYW4ubWFub2hhcmFuQGZvdXJraXRlcy5jb206UmFqa2lyYW5tMg==\")\n req.Header.Add(\"Content-Type\", \"application/json\")\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": "ih0OYGrKISlkhOAxjG9US",
"language": "ruby",
"code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://multimodal-load-api.fourkites.com/api/v1/add_loads\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"Authorization\"] = \"Basic cmFqa2lyYW4ubWFub2hhcmFuQGZvdXJraXRlcy5jb206UmFqa2lyYW5tMg==\"\nrequest[\"Content-Type\"] = \"application/json\"\nrequest.body = JSON.dump([\n {\n \"hawb\": \"200XXXXXXXX\",\n \"asn\": \"ASN_XXXXXXXXXX\",\n \"freight_forwarder\": \"XXXX\",\n \"mode\": [\n \"air\"\n ],\n \"pickup_stop\": {\n \"address_line1\": \"XXXXX T ST\",\n \"city\": \"XXYYXX\",\n \"state\": \"NE\",\n \"country\": \"US\",\n \"postal_code\": \"12345\",\n \"name\": \"D-XXXX-ZSG\",\n \"stop_reference_id\": \"AA1-D-AERWA-ZSG_8\"\n },\n \"pickup_appointment_time\": \"2023-09-01T15:02:32+00:00\",\n \"delivery_stop\": {\n \"address_line1\": \"No. 5 Changi North Way\",\n \"address_line2\": \"Level 4 Warehouse\",\n \"city\": \"Singapore\",\n \"country\": \"SG\",\n \"postal_code\": \"112233\",\n \"name\": \"SG1\",\n \"stop_reference_id\": \"BB2-SG1_8\"\n },\n \"delivery_appointment_time\": \"2023-10-29T15:02:32+00:00\"\n }\n])\n\nresponse = https.request(request)\nputs response.read_body\n",
"customLabel": ""
},
{
"id": "gDupPY4Zl089JGRSkT-_u",
"language": "python",
"code": "import http.client\nimport json\n\nconn = http.client.HTTPSConnection(\"multimodal-load-api.fourkites.com\")\npayload = json.dumps([\n {\n \"hawb\": \"200XXXXXXXX\",\n \"asn\": \"ASN_XXXXXXXXXX\",\n \"freight_forwarder\": \"XXXX\",\n \"mode\": [\n \"air\"\n ],\n \"pickup_stop\": {\n \"address_line1\": \"XXXXX T ST\",\n \"city\": \"XXYYXX\",\n \"state\": \"NE\",\n \"country\": \"US\",\n \"postal_code\": \"12345\",\n \"name\": \"D-XXXX-ZSG\",\n \"stop_reference_id\": \"AA1-D-AERWA-ZSG_8\"\n },\n \"pickup_appointment_time\": \"2023-09-01T15:02:32+00:00\",\n \"delivery_stop\": {\n \"address_line1\": \"No. 5 Changi North Way\",\n \"address_line2\": \"Level 4 Warehouse\",\n \"city\": \"Singapore\",\n \"country\": \"SG\",\n \"postal_code\": \"112233\",\n \"name\": \"SG1\",\n \"stop_reference_id\": \"BB2-SG1_8\"\n },\n \"delivery_appointment_time\": \"2023-10-29T15:02:32+00:00\"\n }\n])\nheaders = {\n 'Authorization': 'Basic cmFqa2lyYW4ubWFub2hhcmFuQGZvdXJraXRlcy5jb206UmFqa2lyYW5tMg==',\n 'Content-Type': 'application/json'\n}\nconn.request(\"POST\", \"/api/v1/add_loads\", payload, headers)\nres = conn.getresponse()\ndata = res.read()\nprint(data.decode(\"utf-8\"))",
"customLabel": ""
}
],
"selectedLanguageId": "3DB6iUzBvS5VLQAF-PkWx"
},
"results": {
"languages": [
{
"id": "SukSwLDyvXS3iCVCedBLo",
"language": "200",
"customLabel": "",
"code": "{\n \"code\": 200,\n \"data\": {\n \"totalCount\": 1,\n \"successfulCount\": 1,\n \"failedCount\": 0,\n \"failedSequences\": [],\n \"bookingId\": [\n 975187\n ]\n },\n \"request_id\": \"c85v1ul2u8op8muqee7g\"\n}"
}
],
"selectedLanguageId": "SukSwLDyvXS3iCVCedBLo"
},
"request": {
"pathParameters": [],
"queryParameters": [],
"headerParameters": [],
"bodyDataParameters": [
{
"name": "hawb",
"kind": "required",
"type": "string",
"description": "It indicates the House Airway Bill Number"
},
{
"name": "asn",
"kind": "required",
"type": "string",
"description": "It indicates Advanced Shipping Notices",
"children": []
},
{
"name": "freight_forwarder",
"kind": "required",
"type": "string",
"description": "It indicates the freight forwarder code.",
"children": []
},
{
"name": "mode",
"kind": "required",
"type": "array",
"description": "It indicates the load mode. Valid value: \"air\"",
"children": []
},
{
"name": "pickup_stop",
"kind": "optional",
"type": "object",
"description": "Pickup stop object.",
"children": [
{
"name": "address_line1",
"kind": "required",
"type": "string",
"description": "It indicates the first line of the stop's address."
},
{
"name": "city",
"kind": "required",
"type": "string",
"description": "It indicates the name of the city. Right now we have a restriction to pass state name when the stop doesn't have external AddressId and we match the port with only city & country."
},
{
"name": "state",
"kind": "required",
"type": "string",
"description": "It indicates the 2 character state code for US & Canada and 3 Character state code for Mexico. It is the 2 character State Code for US & Canada and 3 Character State Code for Mexico."
},
{
"name": "country",
"kind": "optional",
"type": "string",
"description": "It indicates the valid country code. It is the 2 digit country code. Right now, we have a restriction to pass the state name when the stop doesn't have external AddressId and we want to match the port with only city & country."
},
{
"name": "postal_code",
"kind": "optional",
"type": "string",
"description": "It indicates the valid postal code for the stop."
},
{
"name": "name",
"kind": "optional",
"type": "string",
"description": "It is the name of the stop."
},
{
"name": "stop_reference_id",
"kind": "optional",
"type": "string",
"description": "It is the unique identifier of the stop from the customer's system. This populates the \"Reference #\" field on the stop and is used to indicate which stop an update is applied to. (CM)"
}
]
},
{
"name": "pickup_appointment_time",
"kind": "required",
"type": "string",
"description": "The appointment time at the pickup stop. ISO-8601 format",
"children": []
},
{
"name": "delivery_stop",
"kind": "optional",
"type": "object",
"description": "It indicates the delivery stop type",
"children": [
{
"name": "address_line1",
"kind": "required",
"type": "string",
"description": "It indicates the first line of the stop's address."
},
{
"name": "address_line2",
"kind": "optional",
"type": "string",
"description": "It indicates the second line of the stop's address."
},
{
"name": "city",
"kind": "required",
"type": "string",
"description": "It indicates the name of the city. Right now we have a restriction to pass state name when the stop doesn't have external AddressId and we match the port with only city & country."
},
{
"name": "country",
"kind": "optional",
"type": "string",
"description": "It indicates the valid country code. It is the 2 digit country code. Right now, we have a restriction to pass the state name when the stop doesn't have external AddressId and we want to match the port with only city & country."
},
{
"name": "postal_code",
"kind": "optional",
"type": "string",
"description": "It indicates the valid postal code for the stop."
},
{
"name": "name",
"kind": "optional",
"type": "string",
"description": "It is the name of the stop."
},
{
"name": "stop_reference_id",
"kind": "optional",
"type": "string",
"description": "It is the unique identifier of the stop from the customer's system. This populates the \"Reference #\" field on the stop and is used to indicate which stop an update is applied to. (CM)"
}
]
},
{
"name": "delivery_appointment_time",
"kind": "required",
"type": "string",
"description": "The appointment time at the delivery stop. ISO-8601 format",
"children": []
},
{
"name": "pallets",
"kind": "optional",
"type": "object",
"description": "It indicates the list of pallets associated with the load. Each pallet has a pallet number and list of parts.",
"children": [
{
"name": "number",
"kind": "optional",
"type": "string",
"description": "It indicates the pallet number."
},
{
"name": "parts",
"kind": "optional",
"type": "object",
"description": "It indicates the list of parts in the pallet.",
"children": [
{
"name": "shipperPartNumber",
"kind": "optional",
"type": "string",
"description": "It indicates the shipper/manufacturer’s part number."
},
{
"name": "customerPartNumber",
"kind": "optional",
"type": "string",
"description": "It indicates the customer's part number."
},
{
"name": "quantity",
"kind": "optional",
"type": "string",
"description": "It indicates the quantity of the part."
},
{
"name": "weight",
"kind": "optional",
"type": "string",
"description": "It indicates the weight of the part."
}
]
}
]
},
{
"name": "productLineItems",
"kind": "optional",
"type": "object",
"description": "It is the list of product level details associated with the load. 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": "lrsSVst8d9SNmcoV98bLK"
}
```
:::
:::ApiMethodV2
```json
{
"name": "Staging",
"method": "POST",
"url": "http://fk-booking-service-staging.fourkites.com/api/v1/add_loads",
"description": "",
"tab": "examples",
"examples": {
"languages": [
{
"id": "Ei4QprZLP3i5iDBFA1t16",
"language": "curl",
"code": "curl --location --request POST 'https://multimodal-load-api.fourkites.com/api/v1/add_loads' \\\n--header 'Authorization: Basic cmFqa2lyYW4ubWFub2hhcmFuQGZvdXJraXRlcy5jb206UmFqa2lyYW5tMg==' \\\n--header 'Content-Type: application/json' \\\n--data-raw '[\n {\n \"hawb\": \"200XXXXXXXX\",\n \"asn\": \"ASN_XXXXXXXXXX\",\n \"freight_forwarder\": \"XXXX\",\n \"mode\": [\n \"air\"\n ],\n \"pickup_stop\": {\n \"address_line1\": \"XXXXX T ST\",\n \"city\": \"XXYYXX\",\n \"state\": \"NE\",\n \"country\": \"US\",\n \"postal_code\": \"12345\",\n \"name\": \"D-XXXX-ZSG\",\n \"stop_reference_id\": \"AA1-D-AERWA-ZSG_8\"\n },\n \"pickup_appointment_time\": \"2023-09-01T15:02:32+00:00\",\n \"delivery_stop\": {\n \"address_line1\": \"No. 5 Changi North Way\",\n \"address_line2\": \"Level 4 Warehouse\",\n \"city\": \"Singapore\",\n \"country\": \"SG\",\n \"postal_code\": \"112233\",\n \"name\": \"SG1\",\n \"stop_reference_id\": \"BB2-SG1_8\"\n },\n \"delivery_appointment_time\": \"2023-10-29T15:02:32+00:00\",\n \"pallets\": [\n {\n \"number\": \"PAL-001\",\n \"parts\": [\n {\n \"shipperPartNumber\": \"22EE\",\n \"customerPartNumber\": \"22EE\",\n \"quantity\": \"25\",\n \"weight\": \"7.998\"\n }\n ]\n }\n ],\n \"productLineItems\": [\n {\n \"productId\": \"0123456\",\n \"productName\": \"Air Freight Item\",\n \"productDescription\": \"Air freight shipment item\",\n \"productCategory\": \"General Freight\",\n \"quantity\": 25,\n \"measurementUnitCode\": \"PCE\",\n \"netWeight\": 44.8,\n \"weightUnit\": \"KGM\",\n \"unitCost\": 25.0,\n \"currencyCode\": \"USD\",\n \"extendedCost\": 625.00,\n \"freightCost\": 20.00,\n \"additionalCharges\": 5.00,\n \"tariffCost\": 2.50,\n \"fourKitesCalculatedTariffCost\": 2.50,\n \"totalLandedCost\": 655.00,\n \"countryOfOrigin\": \"US\",\n \"harmonizedSystemCode\": \"8471499000\",\n \"commodityTypeCode\": \"AIR_FREIGHT\",\n \"htsusCode\": \"8471499000\",\n \"orderNumber\": \"ASN_XXXXXXXXXX\",\n \"deliveryNumber\": \"DN-PAL001\",\n \"handlingUnitId\": \"PAL-001\",\n \"barcode\": \"PAL001\",\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\": [\"200XXXXXXXX\"],\n \"orderReferences\": [\"ASN_XXXXXXXXXX\"],\n \"brandName\": \"Generic Air Freight Co\",\n \"minimumTemperature\": 0,\n \"maximumTemperature\": 0,\n \"temperatureUnitCode\": \"cel\",\n \"labelIdentifier\": \"LBL-22EE\",\n \"productTrackingNumber\": \"200XXXXXXXX\",\n \"deviceType\": \"RFID_TAG\"\n }\n ]\n }\n]'",
"customLabel": ""
},
{
"id": "3DB6iUzBvS5VLQAF-PkWx",
"language": "java",
"code": "OkHttpClient client = new OkHttpClient().newBuilder()\n .build();\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"[\\n {\\n \\\"hawb\\\": \\\"200XXXXXXXX\\\",\\n \\\"asn\\\": \\\"ASN_XXXXXXXXXX\\\",\\n \\\"freight_forwarder\\\": \\\"XXXX\\\",\\n \\\"mode\\\": [\\n \\\"air\\\"\\n ],\\n \\\"pickup_stop\\\": {\\n \\\"address_line1\\\": \\\"XXXXX T ST\\\",\\n \\\"city\\\": \\\"XXYYXX\\\",\\n \\\"state\\\": \\\"NE\\\",\\n \\\"country\\\": \\\"US\\\",\\n \\\"postal_code\\\": \\\"12345\\\",\\n \\\"name\\\": \\\"D-XXXX-ZSG\\\",\\n \\\"stop_reference_id\\\": \\\"AA1-D-AERWA-ZSG_8\\\"\\n },\\n \\\"pickup_appointment_time\\\": \\\"2023-09-01T15:02:32+00:00\\\",\\n \\\"delivery_stop\\\": {\\n \\\"address_line1\\\": \\\"No. 5 Changi North Way\\\",\\n \\\"address_line2\\\": \\\"Level 4 Warehouse\\\",\\n \\\"city\\\": \\\"Singapore\\\",\\n \\\"country\\\": \\\"SG\\\",\\n \\\"postal_code\\\": \\\"112233\\\",\\n \\\"name\\\": \\\"SG1\\\",\\n \\\"stop_reference_id\\\": \\\"BB2-SG1_8\\\"\\n },\\n \\\"delivery_appointment_time\\\": \\\"2023-10-29T15:02:32+00:00\\\"\\n }\\n]\");\nRequest request = new Request.Builder()\n .url(\"https://multimodal-load-api.fourkites.com/api/v1/add_loads\")\n .method(\"POST\", body)\n .addHeader(\"Authorization\", \"Basic cmFqa2lyYW4ubWFub2hhcmFuQGZvdXJraXRlcy5jb206UmFqa2lyYW5tMg==\")\n .addHeader(\"Content-Type\", \"application/json\")\n .build();\nResponse response = client.newCall(request).execute();",
"customLabel": ""
},
{
"id": "Jj06JRCdmjYV-l6I-R8Gu",
"language": "javascript",
"code": "var settings = {\n \"url\": \"https://multimodal-load-api.fourkites.com/api/v1/add_loads\",\n \"method\": \"POST\",\n \"timeout\": 0,\n \"headers\": {\n \"Authorization\": \"Basic cmFqa2lyYW4ubWFub2hhcmFuQGZvdXJraXRlcy5jb206UmFqa2lyYW5tMg==\",\n \"Content-Type\": \"application/json\"\n },\n \"data\": JSON.stringify([\n {\n \"hawb\": \"200XXXXXXXX\",\n \"asn\": \"ASN_XXXXXXXXXX\",\n \"freight_forwarder\": \"XXXX\",\n \"mode\": [\n \"air\"\n ],\n \"pickup_stop\": {\n \"address_line1\": \"XXXXX T ST\",\n \"city\": \"XXYYXX\",\n \"state\": \"NE\",\n \"country\": \"US\",\n \"postal_code\": \"12345\",\n \"name\": \"D-XXXX-ZSG\",\n \"stop_reference_id\": \"AA1-D-AERWA-ZSG_8\"\n },\n \"pickup_appointment_time\": \"2023-09-01T15:02:32+00:00\",\n \"delivery_stop\": {\n \"address_line1\": \"No. 5 Changi North Way\",\n \"address_line2\": \"Level 4 Warehouse\",\n \"city\": \"Singapore\",\n \"country\": \"SG\",\n \"postal_code\": \"112233\",\n \"name\": \"SG1\",\n \"stop_reference_id\": \"BB2-SG1_8\"\n },\n \"delivery_appointment_time\": \"2023-10-29T15:02:32+00:00\"\n }\n ]),\n};\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});",
"customLabel": ""
},
{
"id": "yGmIb7AZAzybK390tmSu1",
"language": "swift",
"code": "import Foundation\n#if canImport(FoundationNetworking)\nimport FoundationNetworking\n#endif\n\nvar semaphore = DispatchSemaphore (value: 0)\n\nlet parameters = \"[\\n {\\n \\\"hawb\\\": \\\"200XXXXXXXX\\\",\\n \\\"asn\\\": \\\"ASN_XXXXXXXXXX\\\",\\n \\\"freight_forwarder\\\": \\\"XXXX\\\",\\n \\\"mode\\\": [\\n \\\"air\\\"\\n ],\\n \\\"pickup_stop\\\": {\\n \\\"address_line1\\\": \\\"XXXXX T ST\\\",\\n \\\"city\\\": \\\"XXYYXX\\\",\\n \\\"state\\\": \\\"NE\\\",\\n \\\"country\\\": \\\"US\\\",\\n \\\"postal_code\\\": \\\"12345\\\",\\n \\\"name\\\": \\\"D-XXXX-ZSG\\\",\\n \\\"stop_reference_id\\\": \\\"AA1-D-AERWA-ZSG_8\\\"\\n },\\n \\\"pickup_appointment_time\\\": \\\"2023-09-01T15:02:32+00:00\\\",\\n \\\"delivery_stop\\\": {\\n \\\"address_line1\\\": \\\"No. 5 Changi North Way\\\",\\n \\\"address_line2\\\": \\\"Level 4 Warehouse\\\",\\n \\\"city\\\": \\\"Singapore\\\",\\n \\\"country\\\": \\\"SG\\\",\\n \\\"postal_code\\\": \\\"112233\\\",\\n \\\"name\\\": \\\"SG1\\\",\\n \\\"stop_reference_id\\\": \\\"BB2-SG1_8\\\"\\n },\\n \\\"delivery_appointment_time\\\": \\\"2023-10-29T15:02:32+00:00\\\"\\n }\\n]\"\nlet postData = parameters.data(using: .utf8)\n\nvar request = URLRequest(url: URL(string: \"https://multimodal-load-api.fourkites.com/api/v1/add_loads\")!,timeoutInterval: Double.infinity)\nrequest.addValue(\"Basic cmFqa2lyYW4ubWFub2hhcmFuQGZvdXJraXRlcy5jb206UmFqa2lyYW5tMg==\", forHTTPHeaderField: \"Authorization\")\nrequest.addValue(\"application/json\", forHTTPHeaderField: \"Content-Type\")\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": "cuIEmjjj_sUBFK-ItaOrU",
"language": "csharp",
"code": "var client = new RestClient(\"https://multimodal-load-api.fourkites.com/api/v1/add_loads\");\nclient.Timeout = -1;\nvar request = new RestRequest(Method.POST);\nrequest.AddHeader(\"Authorization\", \"Basic cmFqa2lyYW4ubWFub2hhcmFuQGZvdXJraXRlcy5jb206UmFqa2lyYW5tMg==\");\nrequest.AddHeader(\"Content-Type\", \"application/json\");\nvar body = @\"[\" + \"\\n\" +\n@\" {\" + \"\\n\" +\n@\" \"\"hawb\"\": \"\"200XXXXXXXX\"\",\" + \"\\n\" +\n@\" \"\"asn\"\": \"\"ASN_XXXXXXXXXX\"\",\" + \"\\n\" +\n@\" \"\"freight_forwarder\"\": \"\"XXXX\"\",\" + \"\\n\" +\n@\" \"\"mode\"\": [\" + \"\\n\" +\n@\" \"\"air\"\"\" + \"\\n\" +\n@\" ],\" + \"\\n\" +\n@\" \"\"pickup_stop\"\": {\" + \"\\n\" +\n@\" \"\"address_line1\"\": \"\"XXXXX T ST\"\",\" + \"\\n\" +\n@\" \"\"city\"\": \"\"XXYYXX\"\",\" + \"\\n\" +\n@\" \"\"state\"\": \"\"NE\"\",\" + \"\\n\" +\n@\" \"\"country\"\": \"\"US\"\",\" + \"\\n\" +\n@\" \"\"postal_code\"\": \"\"12345\"\",\" + \"\\n\" +\n@\" \"\"name\"\": \"\"D-XXXX-ZSG\"\",\" + \"\\n\" +\n@\" \"\"stop_reference_id\"\": \"\"AA1-D-AERWA-ZSG_8\"\"\" + \"\\n\" +\n@\" },\" + \"\\n\" +\n@\" \"\"pickup_appointment_time\"\": \"\"2023-09-01T15:02:32+00:00\"\",\" + \"\\n\" +\n@\" \"\"delivery_stop\"\": {\" + \"\\n\" +\n@\" \"\"address_line1\"\": \"\"No. 5 Changi North Way\"\",\" + \"\\n\" +\n@\" \"\"address_line2\"\": \"\"Level 4 Warehouse\"\",\" + \"\\n\" +\n@\" \"\"city\"\": \"\"Singapore\"\",\" + \"\\n\" +\n@\" \"\"country\"\": \"\"SG\"\",\" + \"\\n\" +\n@\" \"\"postal_code\"\": \"\"112233\"\",\" + \"\\n\" +\n@\" \"\"name\"\": \"\"SG1\"\",\" + \"\\n\" +\n@\" \"\"stop_reference_id\"\": \"\"BB2-SG1_8\"\"\" + \"\\n\" +\n@\" },\" + \"\\n\" +\n@\" \"\"delivery_appointment_time\"\": \"\"2023-10-29T15:02:32+00:00\"\"\" + \"\\n\" +\n@\" }\" + \"\\n\" +\n@\"]\";\nrequest.AddParameter(\"application/json\", body, ParameterType.RequestBody);\nIRestResponse response = client.Execute(request);\nConsole.WriteLine(response.Content);",
"customLabel": ""
},
{
"id": "I7bXPcz3bZl1H6oH0elzD",
"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://multimodal-load-api.fourkites.com/api/v1/add_loads\"\n method := \"POST\"\n\n payload := strings.NewReader(`[\n {\n \"hawb\": \"200XXXXXXXX\",\n \"asn\": \"ASN_XXXXXXXXXX\",\n \"freight_forwarder\": \"XXXX\",\n \"mode\": [\n \"air\"\n ],\n \"pickup_stop\": {\n \"address_line1\": \"XXXXX T ST\",\n \"city\": \"XXYYXX\",\n \"state\": \"NE\",\n \"country\": \"US\",\n \"postal_code\": \"12345\",\n \"name\": \"D-XXXX-ZSG\",\n \"stop_reference_id\": \"AA1-D-AERWA-ZSG_8\"\n },\n \"pickup_appointment_time\": \"2023-09-01T15:02:32+00:00\",\n \"delivery_stop\": {\n \"address_line1\": \"No. 5 Changi North Way\",\n \"address_line2\": \"Level 4 Warehouse\",\n \"city\": \"Singapore\",\n \"country\": \"SG\",\n \"postal_code\": \"112233\",\n \"name\": \"SG1\",\n \"stop_reference_id\": \"BB2-SG1_8\"\n },\n \"delivery_appointment_time\": \"2023-10-29T15:02:32+00:00\"\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(\"Authorization\", \"Basic cmFqa2lyYW4ubWFub2hhcmFuQGZvdXJraXRlcy5jb206UmFqa2lyYW5tMg==\")\n req.Header.Add(\"Content-Type\", \"application/json\")\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": "ih0OYGrKISlkhOAxjG9US",
"language": "ruby",
"code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://multimodal-load-api.fourkites.com/api/v1/add_loads\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"Authorization\"] = \"Basic cmFqa2lyYW4ubWFub2hhcmFuQGZvdXJraXRlcy5jb206UmFqa2lyYW5tMg==\"\nrequest[\"Content-Type\"] = \"application/json\"\nrequest.body = JSON.dump([\n {\n \"hawb\": \"200XXXXXXXX\",\n \"asn\": \"ASN_XXXXXXXXXX\",\n \"freight_forwarder\": \"XXXX\",\n \"mode\": [\n \"air\"\n ],\n \"pickup_stop\": {\n \"address_line1\": \"XXXXX T ST\",\n \"city\": \"XXYYXX\",\n \"state\": \"NE\",\n \"country\": \"US\",\n \"postal_code\": \"12345\",\n \"name\": \"D-XXXX-ZSG\",\n \"stop_reference_id\": \"AA1-D-AERWA-ZSG_8\"\n },\n \"pickup_appointment_time\": \"2023-09-01T15:02:32+00:00\",\n \"delivery_stop\": {\n \"address_line1\": \"No. 5 Changi North Way\",\n \"address_line2\": \"Level 4 Warehouse\",\n \"city\": \"Singapore\",\n \"country\": \"SG\",\n \"postal_code\": \"112233\",\n \"name\": \"SG1\",\n \"stop_reference_id\": \"BB2-SG1_8\"\n },\n \"delivery_appointment_time\": \"2023-10-29T15:02:32+00:00\"\n }\n])\n\nresponse = https.request(request)\nputs response.read_body\n",
"customLabel": ""
},
{
"id": "gDupPY4Zl089JGRSkT-_u",
"language": "python",
"code": "import http.client\nimport json\n\nconn = http.client.HTTPSConnection(\"multimodal-load-api.fourkites.com\")\npayload = json.dumps([\n {\n \"hawb\": \"200XXXXXXXX\",\n \"asn\": \"ASN_XXXXXXXXXX\",\n \"freight_forwarder\": \"XXXX\",\n \"mode\": [\n \"air\"\n ],\n \"pickup_stop\": {\n \"address_line1\": \"XXXXX T ST\",\n \"city\": \"XXYYXX\",\n \"state\": \"NE\",\n \"country\": \"US\",\n \"postal_code\": \"12345\",\n \"name\": \"D-XXXX-ZSG\",\n \"stop_reference_id\": \"AA1-D-AERWA-ZSG_8\"\n },\n \"pickup_appointment_time\": \"2023-09-01T15:02:32+00:00\",\n \"delivery_stop\": {\n \"address_line1\": \"No. 5 Changi North Way\",\n \"address_line2\": \"Level 4 Warehouse\",\n \"city\": \"Singapore\",\n \"country\": \"SG\",\n \"postal_code\": \"112233\",\n \"name\": \"SG1\",\n \"stop_reference_id\": \"BB2-SG1_8\"\n },\n \"delivery_appointment_time\": \"2023-10-29T15:02:32+00:00\"\n }\n])\nheaders = {\n 'Authorization': 'Basic cmFqa2lyYW4ubWFub2hhcmFuQGZvdXJraXRlcy5jb206UmFqa2lyYW5tMg==',\n 'Content-Type': 'application/json'\n}\nconn.request(\"POST\", \"/api/v1/add_loads\", payload, headers)\nres = conn.getresponse()\ndata = res.read()\nprint(data.decode(\"utf-8\"))",
"customLabel": ""
}
],
"selectedLanguageId": "gDupPY4Zl089JGRSkT-_u"
},
"results": {
"languages": [
{
"id": "SukSwLDyvXS3iCVCedBLo",
"language": "200",
"customLabel": "",
"code": "{\n \"code\": 200,\n \"data\": {\n \"totalCount\": 1,\n \"successfulCount\": 1,\n \"failedCount\": 0,\n \"failedSequences\": [],\n \"bookingId\": [\n 975187\n ]\n },\n \"request_id\": \"c85v1ul2u8op8muqee7g\"\n}"
}
],
"selectedLanguageId": "SukSwLDyvXS3iCVCedBLo"
},
"request": {
"pathParameters": [],
"queryParameters": [],
"headerParameters": [],
"bodyDataParameters": [
{
"name": "hawb",
"kind": "required",
"type": "string",
"description": "It indicates the House Airway Bill Number"
},
{
"name": "asn",
"kind": "required",
"type": "string",
"description": "It indicates Advanced Shipping Notices",
"children": []
},
{
"name": "freight_forwarder",
"kind": "required",
"type": "string",
"description": "It indicates the freight forwarder code.",
"children": []
},
{
"name": "mode",
"kind": "required",
"type": "array",
"description": "It indicates the load mode. Valid value: \"air\"",
"children": []
},
{
"name": "pickup_stop",
"kind": "optional",
"type": "object",
"description": "Pickup stop object.",
"children": [
{
"name": "address_line1",
"kind": "required",
"type": "string",
"description": "It indicates the first line of the stop's address."
},
{
"name": "city",
"kind": "required",
"type": "string",
"description": "It indicates the name of the city. Right now we have a restriction to pass state name when the stop doesn't have external AddressId and we match the port with only city & country."
},
{
"name": "state",
"kind": "required",
"type": "string",
"description": "It indicates the 2 character state code for US & Canada and 3 Character state code for Mexico. It is the 2 character State Code for US & Canada and 3 Character State Code for Mexico."
},
{
"name": "country",
"kind": "optional",
"type": "string",
"description": "It indicates the valid country code. It is the 2 digit country code. Right now, we have a restriction to pass the state name when the stop doesn't have external AddressId and we want to match the port with only city & country."
},
{
"name": "postal_code",
"kind": "optional",
"type": "string",
"description": "It indicates the valid postal code for the stop."
},
{
"name": "name",
"kind": "optional",
"type": "string",
"description": "It is the name of the stop."
},
{
"name": "stop_reference_id",
"kind": "optional",
"type": "string",
"description": "It is the unique identifier of the stop from the customer's system. This populates the \"Reference #\" field on the stop and is used to indicate which stop an update is applied to. (CM)"
}
]
},
{
"name": "pickup_appointment_time",
"kind": "required",
"type": "string",
"description": "The appointment time at the pickup stop. ISO-8601 format",
"children": []
},
{
"name": "delivery_stop",
"kind": "optional",
"type": "object",
"description": "It indicates the delivery stop type",
"children": [
{
"name": "address_line1",
"kind": "required",
"type": "string",
"description": "It indicates the first line of the stop's address."
},
{
"name": "address_line2",
"kind": "optional",
"type": "string",
"description": "It indicates the second line of the stop's address."
},
{
"name": "city",
"kind": "required",
"type": "string",
"description": "It indicates the name of the city. Right now we have a restriction to pass state name when the stop doesn't have external AddressId and we match the port with only city & country."
},
{
"name": "country",
"kind": "optional",
"type": "string",
"description": "It indicates the valid country code. It is the 2 digit country code. Right now, we have a restriction to pass the state name when the stop doesn't have external AddressId and we want to match the port with only city & country."
},
{
"name": "postal_code",
"kind": "optional",
"type": "string",
"description": "It indicates the valid postal code for the stop."
},
{
"name": "name",
"kind": "optional",
"type": "string",
"description": "It is the name of the stop."
},
{
"name": "stop_reference_id",
"kind": "optional",
"type": "string",
"description": "It is the unique identifier of the stop from the customer's system. This populates the \"Reference #\" field on the stop and is used to indicate which stop an update is applied to. (CM)"
}
]
},
{
"name": "delivery_appointment_time",
"kind": "required",
"type": "string",
"description": "The appointment time at the delivery stop. ISO-8601 format",
"children": []
},
{
"name": "pallets",
"kind": "optional",
"type": "object",
"description": "It indicates the list of pallets associated with the load. Each pallet has a pallet number and list of parts.",
"children": [
{
"name": "number",
"kind": "optional",
"type": "string",
"description": "It indicates the pallet number."
},
{
"name": "parts",
"kind": "optional",
"type": "object",
"description": "It indicates the list of parts in the pallet.",
"children": [
{
"name": "shipperPartNumber",
"kind": "optional",
"type": "string",
"description": "It indicates the shipper/manufacturer’s part number."
},
{
"name": "customerPartNumber",
"kind": "optional",
"type": "string",
"description": "It indicates the customer's part number."
},
{
"name": "quantity",
"kind": "optional",
"type": "string",
"description": "It indicates the quantity of the part."
},
{
"name": "weight",
"kind": "optional",
"type": "string",
"description": "It indicates the weight of the part."
}
]
}
]
},
{
"name": "productLineItems",
"kind": "optional",
"type": "object",
"description": "It is the list of product level details associated with the load. 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": "vhWQOxBYELzV8f5TWtZTl"
}
```
:::