Easy Load Create (Air)
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.
⚠️ Important Update:
The Pallets structure is being deprecated. Please transition to for product details. Learn more
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 / Update Shipment documentation.
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.
Rate Limit
1 request per second
Format Supported
JSON
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.
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody 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]");
Request request = new Request.Builder()
.url("https://multimodal-load-api.fourkites.com/api/v1/add_loads")
.method("POST", body)
.addHeader("Authorization", "Basic cmFqa2lyYW4ubWFub2hhcmFuQGZvdXJraXRlcy5jb206UmFqa2lyYW5tMg==")
.addHeader("Content-Type", "application/json")
.build();
Response response = client.newCall(request).execute();import http.client
import json
conn = http.client.HTTPSConnection("multimodal-load-api.fourkites.com")
payload = json.dumps([
{
"hawb": "200XXXXXXXX",
"asn": "ASN_XXXXXXXXXX",
"freight_forwarder": "XXXX",
"mode": [
"air"
],
"pickup_stop": {
"address_line1": "XXXXX T ST",
"city": "XXYYXX",
"state": "NE",
"country": "US",
"postal_code": "12345",
"name": "D-XXXX-ZSG",
"stop_reference_id": "AA1-D-AERWA-ZSG_8"
},
"pickup_appointment_time": "2023-09-01T15:02:32+00:00",
"delivery_stop": {
"address_line1": "No. 5 Changi North Way",
"address_line2": "Level 4 Warehouse",
"city": "Singapore",
"country": "SG",
"postal_code": "112233",
"name": "SG1",
"stop_reference_id": "BB2-SG1_8"
},
"delivery_appointment_time": "2023-10-29T15:02:32+00:00"
}
])
headers = {
'Authorization': 'Basic cmFqa2lyYW4ubWFub2hhcmFuQGZvdXJraXRlcy5jb206UmFqa2lyYW5tMg==',
'Content-Type': 'application/json'
}
conn.request("POST", "/api/v1/add_loads", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))