Air
4 min
Allows authorized users to update an Air load. Please note that you will need to use the FourKites’ Internal Tracking ID, “loadId”, that was returned in the response from the Load Create API request. Read on to learn more.
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.
Rate Limit
1 request per second
Format Supported
JSON
Authenticated Resource
API Key
For more information on Authentication, click here.
The FourKites internal loadId that is returned during load creation should be added to the endpoint to update the load. Click on the load that you would like to update to get the FourKites Internal LoadId as shown in the image below.
Production
PATCH
https://api.fourkites.com/api/v1/tracking/420254202
curl --location --request PATCH 'https://api.fourkites.com/api/v1/tracking/420254202' \
--header 'Content-Type: application/json' \
--header 'apikey: REPLACE_KEY_VALUE' \
--data-raw '{
"simpleUpdate" : "True",
"trackingInfo": {
"mawb": "70038067644"
},
"trackingNumber": "70038067644",
"load": {
"loadNumber": "TEST_LOAD_01_Update",
"carrier": "1234",
"priority": "high",
"carrierPermalink": "aaa-bbb-ccc",
"stops": [
{
"stopType": "originAirport",
"airTotalPieces": "100",
"externalAddressId": "MAA",
"sequence": "1",
"departingFlightNumber": "GTI8033",
"earliestAppointmentTime": "2024-03-11T04:25:45.000Z",
"latestAppointmentTime": "2024-03-11T06:25:45.000Z",
"pallets": [
{
"number": "PAL-001",
"parts": [
{
"quantity": "25",
"shipperPartNumber": "22EE",
"weight": "7.998"
}
]
}
],
"productLineItems": [
{
"productId": "0123456",
"productName": "Air Freight Item",
"productDescription": "Air freight shipment item",
"productCategory": "General Freight",
"quantity": 25,
"measurementUnitCode": "PCE",
"netWeight": 44.8,
"weightUnit": "KGM",
"unitCost": 25.0,
"currencyCode": "USD",
"extendedCost": 625.00,
"freightCost": 20.00,
"additionalCharges": 5.00,
"tariffCost": 2.50,
"fourKitesCalculatedTariffCost": 2.50,
"totalLandedCost": 655.00,
"countryOfOrigin": "IN",
"harmonizedSystemCode": "8471499000",
"commodityTypeCode": "AIR_FREIGHT",
"htsusCode": "8471499000",
"orderNumber": "TEST_LOAD_01_Update",
"deliveryNumber": "DN-MAA",
"handlingUnitId": "PAL-001",
"barcode": "PAL001",
"containerType": "pallet",
"gtin": "00012345678905",
"customerPartNumber": "22EE",
"supplierPartNumber": "22EE",
"manufacturerPartNumber": "MFG-22EE",
"itemNumber": "ITM-22EE",
"productUpc": "012345678905",
"deliveryReferences": ["70038067644"],
"orderReferences": ["TEST_LOAD_01_Update"],
"brandName": "Generic Air Freight Co",
"minimumTemperature": 0,
"maximumTemperature": 0,
"temperatureUnitCode": "cel",
"labelIdentifier": "LBL-22EE",
"productTrackingNumber": "AIR-STOP-001",
"deviceType": "RFID_TAG"
}
]
},
{
"stopType": "destinationAirport",
"externalAddressId": "ANC",
"sequence": "2",
"earliestAppointmentTime": "2024-04-15T04:25:45.000Z",
"latestAppointmentTime": "2024-04-16T06:25:45.000Z",
"pallets": [
{
"number": "PAL-002",
"parts": [
{
"quantity": "25",
"shipperPartNumber": "33CC",
"weight": "7.998"
}
]
}
],
"productLineItems": [
{
"productId": "0654321",
"productName": "Air Freight Item",
"productDescription": "Air freight shipment item",
"productCategory": "General Freight",
"quantity": 25,
"measurementUnitCode": "PCE",
"netWeight": 44.8,
"weightUnit": "KGM",
"unitCost": 25.0,
"currencyCode": "USD",
"extendedCost": 625.00,
"freightCost": 20.00,
"additionalCharges": 5.00,
"tariffCost": 2.50,
"fourKitesCalculatedTariffCost": 2.50,
"totalLandedCost": 655.00,
"countryOfOrigin": "US",
"harmonizedSystemCode": "8471499000",
"commodityTypeCode": "AIR_FREIGHT",
"htsusCode": "8471499000",
"orderNumber": "TEST_LOAD_01_Update",
"deliveryNumber": "DN-ANC",
"handlingUnitId": "PAL-002",
"barcode": "PAL002",
"containerType": "pallet",
"gtin": "00012345678912",
"customerPartNumber": "33CC",
"supplierPartNumber": "33CC",
"manufacturerPartNumber": "MFG-33CC",
"itemNumber": "ITM-33CC",
"productUpc": "012345678912",
"deliveryReferences": ["70038067644"],
"orderReferences": ["TEST_LOAD_01_Update"],
"brandName": "Generic Air Freight Co",
"minimumTemperature": 0,
"maximumTemperature": 0,
"temperatureUnitCode": "cel",
"labelIdentifier": "LBL-33CC",
"productTrackingNumber": "AIR-STOP-002",
"deviceType": "QR_CODE"
}
]
}
]
}
}'Staging
PATCH
https://api-staging.fourkites.com/api/v1/tracking/420254202
curl --location --request PATCH 'https://api-staging.fourkites.com/api/v1/tracking/420254202' \
--header 'Content-Type: application/json' \
--header 'apikey: REPLACE_KEY_VALUE' \
--data-raw '{
"simpleUpdate" : "True",
"trackingInfo": {
"mawb": "70038067644"
},
"trackingNumber": "70038067644",
"load": {
"loadNumber": "TEST_LOAD_01_Update",
"carrier": "1234",
"priority": "high",
"carrierPermalink": "dsv-air-zb-test",
"stops": [
{
"stopType": "originAirport",
"airTotalPieces": "100",
"externalAddressId": "MAA",
"sequence": "1",
"departingFlightNumber": "GTI8033",
"earliestAppointmentTime": "2024-03-11T04:25:45.000Z",
"latestAppointmentTime": "2024-03-11T06:25:45.000Z",
"pallets": [
{
"number": "PAL-001",
"parts": [
{
"quantity": "25",
"shipperPartNumber": "22EE",
"weight": "7.998"
}
]
}
],
"productLineItems": [
{
"productId": "0123456",
"productName": "Air Freight Item",
"productDescription": "Air freight shipment item",
"productCategory": "General Freight",
"quantity": 25,
"measurementUnitCode": "PCE",
"netWeight": 44.8,
"weightUnit": "KGM",
"unitCost": 25.0,
"currencyCode": "USD",
"extendedCost": 625.00,
"freightCost": 20.00,
"additionalCharges": 5.00,
"tariffCost": 2.50,
"fourKitesCalculatedTariffCost": 2.50,
"totalLandedCost": 655.00,
"countryOfOrigin": "IN",
"harmonizedSystemCode": "8471499000",
"commodityTypeCode": "AIR_FREIGHT",
"htsusCode": "8471499000",
"orderNumber": "TEST_LOAD_01_Update",
"deliveryNumber": "DN-MAA",
"handlingUnitId": "PAL-001",
"barcode": "PAL001",
"containerType": "pallet",
"gtin": "00012345678905",
"customerPartNumber": "22EE",
"supplierPartNumber": "22EE",
"manufacturerPartNumber": "MFG-22EE",
"itemNumber": "ITM-22EE",
"productUpc": "012345678905",
"deliveryReferences": ["70038067644"],
"orderReferences": ["TEST_LOAD_01_Update"],
"brandName": "Generic Air Freight Co",
"minimumTemperature": 0,
"maximumTemperature": 0,
"temperatureUnitCode": "cel",
"labelIdentifier": "LBL-22EE",
"productTrackingNumber": "AIR-STOP-001",
"deviceType": "RFID_TAG"
}
]
},
{
"stopType": "destinationAirport",
"externalAddressId": "ANC",
"sequence": "2",
"earliestAppointmentTime": "2024-04-15T04:25:45.000Z",
"latestAppointmentTime": "2024-04-16T06:25:45.000Z",
"pallets": [
{
"number": "PAL-002",
"parts": [
{
"quantity": "25",
"shipperPartNumber": "33CC",
"weight": "7.998"
}
]
}
],
"productLineItems": [
{
"productId": "0654321",
"productName": "Air Freight Item",
"productDescription": "Air freight shipment item",
"productCategory": "General Freight",
"quantity": 25,
"measurementUnitCode": "PCE",
"netWeight": 44.8,
"weightUnit": "KGM",
"unitCost": 25.0,
"currencyCode": "USD",
"extendedCost": 625.00,
"freightCost": 20.00,
"additionalCharges": 5.00,
"tariffCost": 2.50,
"fourKitesCalculatedTariffCost": 2.50,
"totalLandedCost": 655.00,
"countryOfOrigin": "US",
"harmonizedSystemCode": "8471499000",
"commodityTypeCode": "AIR_FREIGHT",
"htsusCode": "8471499000",
"orderNumber": "TEST_LOAD_01_Update",
"deliveryNumber": "DN-ANC",
"handlingUnitId": "PAL-002",
"barcode": "PAL002",
"containerType": "pallet",
"gtin": "00012345678912",
"customerPartNumber": "33CC",
"supplierPartNumber": "33CC",
"manufacturerPartNumber": "MFG-33CC",
"itemNumber": "ITM-33CC",
"productUpc": "012345678912",
"deliveryReferences": ["70038067644"],
"orderReferences": ["TEST_LOAD_01_Update"],
"brandName": "Generic Air Freight Co",
"minimumTemperature": 0,
"maximumTemperature": 0,
"temperatureUnitCode": "cel",
"labelIdentifier": "LBL-33CC",
"productTrackingNumber": "AIR-STOP-002",
"deviceType": "QR_CODE"
}
]
}
]
}
}'