Update Shipment
10 min
Update Load/Shipment API allows authorized users to update a load. Please note, you will need to use the FourKites’ Internal Tracking ID, “loadId”, that was returned in the response from the Load Create API request.
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.
Name | Validation | Description |
|---|---|---|
trackingId | Required to update the load. | The FourKites internal loadId that is returned during load creation. |
simpleUpdate | Valid values: true or false. Default to false. | Indicates whether the load object in the request payload is the complete snapshot of the load to be updated. Default to false. |
Refer here for the field descriptions of Product Line Items & Shipment Cost Schema.
Production
PATCH
https://api.fourkites.com/api/v1/tracking/420645495
curl --location --request PATCH 'https://api.fourkites.com/api/v1/tracking/420645495' \
--header 'Content-Type: application/json' \
--header 'apikey: REPLACE_KEY_VALUE' \
--data-raw '{
"simpleUpdate": "True",
"trackingInfo": {
"driverPhone": "",
"truckNumber": "",
"trailerNumber": ""
},
"additionalData": {
"modeDetails": {
"shipperModes": "TL",
"carrierModes": ""
}
},
"load": {
"carrierPermalink": "support-carrier-production",
"carrierName": "Support Carrier (Production)",
"carrier": "cc79",
"shipperAccountNumber": "tXXXXX234",
"haulType": [
"inbound_load"
],
"loadNumber": "TestUpdate",
"displayLoadNumber": "TestUpdate2",
"billOfLading": "billOfLading",
"bookingNumber": "bookingNumber",
"priority": "high",
"masterSequenceNumber": "1",
"masterReferenceNumber": "7328623",
"simultaneousTrackingSequenceNumber": 1,
"proNumber": "991",
"cost": {
"productCost": 410.00,
"extendedCost": 1200.00,
"freightCost": 45.50,
"additionalCost": 23.20,
"tariffCost": 85.00,
"landedCost": 1353.70,
"countryOfOrigin": "CN",
"currency": "USD",
"fourkitesCalculatedTariffCost": null
},
"products": [
{
"lowerTemperatureThreshold": "20",
"name": "Produce",
"productId": "0123456",
"setTemperature": "28",
"timeToleranceInMinutes": "30",
"upperTemperatureThreshold": "34"
}
],
"referenceNumbers": [
"ref1",
"ref2"
],
"deliveryNumbers": "DEL004, DEL005",
"masterTrackingNumber": "MASTER01",
"relayLoad": false,
"stops": [
{
"addressLine1": "500 West Madison Street",
"addressLine2": "Floor 33",
"city": "Chicago",
"country": "US",
"customer": {
"id": "789789",
"poNumbers": [
"00210123OF-203503"
],
"pointOfContact": {
"alert": false,
"email": "[email protected]",
"name": "John Doe",
"phone": "+19999999999"
}
},
"earliestAppointmentTime": "2024-10-11T01:00:00",
"earliestWantTime": "2024-10-11T01:00:00",
"externalAddressId": "100",
"latestAppointmentTime": "2024-10-11T02:00:00",
"latestWantTime": "2024-10-12T02:00:00",
"name": "FourKites HQ",
"loadingType": "drop",
"productLineItems": [
{
"productId": "rohit-123/78^*",
"productName": "Premium Auto Parts Kit",
"productDescription": "Complete automotive parts assembly kit including filters, belts, and gaskets",
"productCategory": "Automotive Parts",
"quantity": 100,
"measurementUnitCode": "PCE",
"netWeight": 250.5,
"weightUnit": "KGM",
"unitCost": 85.50,
"currencyCode": "USD",
"extendedCost": 8550.00,
"freightCost": 125.00,
"bestBeforeDate": "2025-07-15T08:10:00Z",
"additionalCharges": 500.00,
"tariffCost": 200.00,
"fourKitesCalculatedTariffCost": 1951.75,
"totalLandedCost": 8925.00,
"countryOfOrigin": "US",
"harmonizedSystemCode": "8708293000",
"commodityTypeCode": "AUTO_PARTS",
"htsusCode": "8708293000",
"orderNumber": "PO-2025-4567",
"deliveryNumber": "DN-789012",
"handlingUnitId": "PLT-001234",
"barcode": "123456789012",
"containerType": "pallet",
"gtin": "01234567890123",
"customerPartNumber": "CUST-AP-001",
"supplierPartNumber": "SUPP-KIT-789",
"manufacturerPartNumber": "MFG-APK-456",
"itemNumber": "ITM-001234",
"productUpc": "123456789012",
"deliveryReferences": ["DEL-REF-001", "DEL-REF-002"],
"orderReferences": ["ORD-REF-001"],
"brandName": "AutoPro",
"minimumTemperature": -10,
"maximumTemperature": 60,
"temperatureUnitCode": "cel",
"labelIdentifier": "LBL-AP-001234",
"productTrackingNumber": "TRK-789456123",
"deviceType": "RFID_TAG"
}
],
"pallets": [
{
"billOfLading": "BOL123",
"number": "123444444",
"parts": [
{
"customerPartNumber": "123-FCOSS",
"orderNumber": "123",
"quantity": "1",
"shipperPartNumber": "1259924",
"weight": "41.92 LB",
"description": "Material description 1"
},
{
"customerPartNumber": "65-2333SS",
"orderNumber": "123",
"quantity": "21",
"shipperPartNumber": "59924",
"weight": "880.32 LB",
"description": "Material description 2"
},
{
"customerPartNumber": "65-24DGOSS",
"orderNumber": "123",
"quantity": "22",
"shipperPartNumber": "1924",
"weight": "922.24 LB",
"description": "Material description 3"
},
{
"customerPartNumber": "65-24S",
"orderNumber": "123",
"quantity": "15",
"shipperPartNumber": "1255524",
"weight": "628.8 LB",
"description": "Material description 4"
}
]
}
],
"postalCode": "60611",
"referenceNumbers": [
"1234567",
"2412422222",
"PalletNumber:54831396"
],
"sequence": 1,
"shipTo": "1234",
"state": "IL",
"stopReferenceId": "123",
"stopType": "pickup",
"trackingNumber": "123456789",
"unloadTimeInMinutes": 120
},
{
"addressLine1": "1001 E 17th Street",
"addressLine2": "",
"city": "Bloomington",
"country": "US",
"customer": {
"id": "789789",
"poNumbers": [
"00210123OF-203503"
],
"customerPoFields": [
{
"delivery": "123232",
"deliveryReference": "ABC123",
"orderReference": "QWERTTY"
}
],
"pointOfContact": {
"alert": false,
"email": "[email protected]",
"name": "John Doe",
"phone": "+19999999999"
}
},
"earliestAppointmentTime": "2024-10-11T05:00:00",
"externalAddressId": "200",
"latestAppointmentTime": "2024-10-11T06:00:00",
"name": "Assembly Hall",
"productLineItems": [
{
"productId": "PROD-1234512",
"productName": "Premium Auto Parts Kit",
"productDescription": "Complete automotive parts assembly kit including filters, belts, and gaskets",
"productCategory": "Automotive Parts",
"quantity": 100,
"measurementUnitCode": "PCE",
"netWeight": 250.5,
"weightUnit": "KGM",
"unitCost": 85.50,
"currencyCode": "USD",
"extendedCost": 8550.00,
"freightCost": 125.00,
"additionalCharges": 50.00,
"tariffCost": 200.00,
"fourKitesCalculatedTariffCost": 195.75,
"totalLandedCost": 8925.00,
"countryOfOrigin": "US",
"harmonizedSystemCode": "8708293000",
"commodityTypeCode": "AUTO_PARTS",
"htsusCode": "8708293000",
"orderNumber": "PO-2025-4567",
"deliveryNumber": "DN-789012",
"handlingUnitId": "PLT-001234",
"barcode": "123456789012",
"containerType": "pallet",
"gtin": "01234567890123",
"customerPartNumber": "CUST-AP-001",
"supplierPartNumber": "SUPP-KIT-789",
"manufacturerPartNumber": "MFG-APK-456",
"itemNumber": "ITM-001234",
"productUpc": "123456789012",
"deliveryReferences": ["DEL-REF-001", "DEL-REF-002"],
"orderReferences": ["ORD-REF-001"],
"brandName": "AutoPro",
"minimumTemperature": -10,
"maximumTemperature": 60,
"temperatureUnitCode": "cel",
"labelIdentifier": "LBL-AP-001234",
"productTrackingNumber": "TRK-789456123",
"deviceType": "RFID_TAG"
},
{
"productId": "PROD-56789",
"productName": "Electronic Control Module",
"productDescription": "Advanced electronic control unit for automotive applications",
"productCategory": "Electronics",
"quantity": 25,
"measurementUnitCode": "PCE",
"netWeight": 12.5,
"weightUnit": "KGM",
"unitCost": 450.00,
"currencyCode": "USD",
"extendedCost": 11250.00,
"freightCost": 75.00,
"totalLandedCost": 11325.00,
"countryOfOrigin": "CN",
"harmonizedSystemCode": "8537109900",
"orderNumber": "PO-2025-5678",
"deliveryNumber": "DN-345678",
"handlingUnitId": "BOX-002345",
"barcode": "234567890123",
"containerType": "box",
"gtin": "09876543210987",
"customerPartNumber": "CUST-ECM-002",
"supplierPartNumber": "SUPP-ECM-890",
"brandName": "TechControl",
"labelIdentifier": "LBL-ECM-002345",
"productTrackingNumber": "TRK-890123456",
"deviceType": "QR_CODE"
}
],
"pallets": [
{
"billOfLading": "BOL123",
"number": "123444444",
"parts": [
{
"customerPartNumber": "123-FCOSS",
"orderNumber": "123",
"quantity": "1",
"shipperPartNumber": "1259924",
"weight": "41.92 LB",
"description": "Material description 1"
},
{
"customerPartNumber": "65-2333SS",
"orderNumber": "123",
"quantity": "21",
"shipperPartNumber": "59924",
"weight": "880.32 LB",
"description": "Material description 2"
},
{
"customerPartNumber": "65-24DGOSS",
"orderNumber": "123",
"quantity": "22",
"shipperPartNumber": "1924",
"weight": "922.24 LB",
"description": "Material description 3"
},
{
"customerPartNumber": "65-24S",
"orderNumber": "123",
"quantity": "15",
"shipperPartNumber": "1255524",
"weight": "628.8 LB",
"description": "Material description 4"
}
]
}
],
"postalCode": "47408",
"referenceNumbers": [
"1234567",
"2412422222",
"PalletNumber:54831396"
],
"sequence": 2,
"state": "IN",
"stopReferenceId": "9876",
"stopType": "delivery",
"trackingNumber": "123456789",
"unloadTimeInMinutes": 150,
"wantTime": "2024-10-12T13:00:00Z"
}
],
"tags": [
"Tag1",
"Tag2",
"Tag3"
],
"trackingInfo": {
"deviceId": "12356",
"driverId": "999",
"driverPhone": "+19999999999",
"mawb": "17233144555",
"trailerNumber": "123",
"truckNumber": "456"
},
"trackingNumber": "123456789",
"truckRoutingParams": {
"height": "4.145",
"length": "14.63",
"limitedWeight": "996",
"shippedHazardousGoods": "flammable",
"trailersCount": 0,
"truckType": "truck",
"tunnelCategory": "C",
"weightPerAxle": "498",
"width": "2.438"
},
"seal": "XYZ123",
"sealStatus": "XYZ123"
}
}'Staging
PATCH
https://api-staging.fourkites.com/api/v1/tracking/420645495
curl --location --request PATCH 'https://api-staging.fourkites.com/api/v1/tracking/420645495' \
--header 'Content-Type: application/json' \
--header 'apikey: REPLACE_KEY_VALUE' \
--data-raw '{
"simpleUpdate": "True",
"trackingInfo": {
"driverPhone": "",
"truckNumber": "",
"trailerNumber": ""
},
"additionalData": {
"modeDetails": {
"shipperModes": "TL",
"carrierModes": ""
}
},
"load": {
"carrierPermalink": "support-carrier-production",
"carrierName": "Support Carrier (Production)",
"carrier": "cc79",
"shipperAccountNumber": "tXXXXX234",
"haulType": [
"inbound_load"
],
"loadNumber": "TestUpdate",
"displayLoadNumber": "TestUpdate2",
"billOfLading": "billOfLading",
"bookingNumber": "bookingNumber",
"priority": "high",
"masterSequenceNumber": "1",
"masterReferenceNumber": "7328623",
"simultaneousTrackingSequenceNumber": 1,
"proNumber": "991",
"cost": {
"productCost": 410.00,
"extendedCost": 1200.00,
"freightCost": 45.50,
"additionalCost": 23.20,
"tariffCost": 85.00,
"landedCost": 1353.70,
"countryOfOrigin": "CN",
"currency": "USD",
"fourkitesCalculatedTariffCost": null
},
"products": [
{
"lowerTemperatureThreshold": "20",
"name": "Produce",
"productId": "0123456",
"setTemperature": "28",
"timeToleranceInMinutes": "30",
"upperTemperatureThreshold": "34"
}
],
"referenceNumbers": [
"ref1",
"ref2"
],
"deliveryNumbers": "DEL004, DEL005",
"masterTrackingNumber": "MASTER01",
"relayLoad": false,
"stops": [
{
"addressLine1": "500 West Madison Street",
"addressLine2": "Floor 33",
"city": "Chicago",
"country": "US",
"customer": {
"id": "789789",
"poNumbers": [
"00210123OF-203503"
],
"pointOfContact": {
"alert": false,
"email": "[email protected]",
"name": "John Doe",
"phone": "+19999999999"
}
},
"earliestAppointmentTime": "2024-10-11T01:00:00",
"earliestWantTime": "2024-10-11T01:00:00",
"externalAddressId": "100",
"latestAppointmentTime": "2024-10-11T02:00:00",
"latestWantTime": "2024-10-12T02:00:00",
"name": "FourKites HQ",
"loadingType": "drop",
"productLineItems": [
{
"productId": "rohit-123/78^*",
"productName": "Premium Auto Parts Kit",
"productDescription": "Complete automotive parts assembly kit including filters, belts, and gaskets",
"productCategory": "Automotive Parts",
"quantity": 100,
"measurementUnitCode": "PCE",
"netWeight": 250.5,
"weightUnit": "KGM",
"unitCost": 85.50,
"currencyCode": "USD",
"extendedCost": 8550.00,
"freightCost": 125.00,
"bestBeforeDate": "2025-07-15T08:10:00Z",
"additionalCharges": 500.00,
"tariffCost": 200.00,
"fourKitesCalculatedTariffCost": 1951.75,
"totalLandedCost": 8925.00,
"countryOfOrigin": "US",
"harmonizedSystemCode": "8708293000",
"commodityTypeCode": "AUTO_PARTS",
"htsusCode": "8708293000",
"orderNumber": "PO-2025-4567",
"deliveryNumber": "DN-789012",
"handlingUnitId": "PLT-001234",
"barcode": "123456789012",
"containerType": "pallet",
"gtin": "01234567890123",
"customerPartNumber": "CUST-AP-001",
"supplierPartNumber": "SUPP-KIT-789",
"manufacturerPartNumber": "MFG-APK-456",
"itemNumber": "ITM-001234",
"productUpc": "123456789012",
"deliveryReferences": ["DEL-REF-001", "DEL-REF-002"],
"orderReferences": ["ORD-REF-001"],
"brandName": "AutoPro",
"minimumTemperature": -10,
"maximumTemperature": 60,
"temperatureUnitCode": "cel",
"labelIdentifier": "LBL-AP-001234",
"productTrackingNumber": "TRK-789456123",
"deviceType": "RFID_TAG"
}
],
"pallets": [
{
"billOfLading": "BOL123",
"number": "123444444",
"parts": [
{
"customerPartNumber": "123-FCOSS",
"orderNumber": "123",
"quantity": "1",
"shipperPartNumber": "1259924",
"weight": "41.92 LB",
"description": "Material description 1"
},
{
"customerPartNumber": "65-2333SS",
"orderNumber": "123",
"quantity": "21",
"shipperPartNumber": "59924",
"weight": "880.32 LB",
"description": "Material description 2"
},
{
"customerPartNumber": "65-24DGOSS",
"orderNumber": "123",
"quantity": "22",
"shipperPartNumber": "1924",
"weight": "922.24 LB",
"description": "Material description 3"
},
{
"customerPartNumber": "65-24S",
"orderNumber": "123",
"quantity": "15",
"shipperPartNumber": "1255524",
"weight": "628.8 LB",
"description": "Material description 4"
}
]
}
],
"postalCode": "60611",
"referenceNumbers": [
"1234567",
"2412422222",
"PalletNumber:54831396"
],
"sequence": 1,
"shipTo": "1234",
"state": "IL",
"stopReferenceId": "123",
"stopType": "pickup",
"trackingNumber": "123456789",
"unloadTimeInMinutes": 120
},
{
"addressLine1": "1001 E 17th Street",
"addressLine2": "",
"city": "Bloomington",
"country": "US",
"customer": {
"id": "789789",
"poNumbers": [
"00210123OF-203503"
],
"customerPoFields": [
{
"delivery": "123232",
"deliveryReference": "ABC123",
"orderReference": "QWERTTY"
}
],
"pointOfContact": {
"alert": false,
"email": "[email protected]",
"name": "John Doe",
"phone": "+19999999999"
}
},
"earliestAppointmentTime": "2024-10-11T05:00:00",
"externalAddressId": "200",
"latestAppointmentTime": "2024-10-11T06:00:00",
"name": "Assembly Hall",
"productLineItems": [
{
"productId": "PROD-1234512",
"productName": "Premium Auto Parts Kit",
"productDescription": "Complete automotive parts assembly kit including filters, belts, and gaskets",
"productCategory": "Automotive Parts",
"quantity": 100,
"measurementUnitCode": "PCE",
"netWeight": 250.5,
"weightUnit": "KGM",
"unitCost": 85.50,
"currencyCode": "USD",
"extendedCost": 8550.00,
"freightCost": 125.00,
"additionalCharges": 50.00,
"tariffCost": 200.00,
"fourKitesCalculatedTariffCost": 195.75,
"totalLandedCost": 8925.00,
"countryOfOrigin": "US",
"harmonizedSystemCode": "8708293000",
"commodityTypeCode": "AUTO_PARTS",
"htsusCode": "8708293000",
"orderNumber": "PO-2025-4567",
"deliveryNumber": "DN-789012",
"handlingUnitId": "PLT-001234",
"barcode": "123456789012",
"containerType": "pallet",
"gtin": "01234567890123",
"customerPartNumber": "CUST-AP-001",
"supplierPartNumber": "SUPP-KIT-789",
"manufacturerPartNumber": "MFG-APK-456",
"itemNumber": "ITM-001234",
"productUpc": "123456789012",
"deliveryReferences": ["DEL-REF-001", "DEL-REF-002"],
"orderReferences": ["ORD-REF-001"],
"brandName": "AutoPro",
"minimumTemperature": -10,
"maximumTemperature": 60,
"temperatureUnitCode": "cel",
"labelIdentifier": "LBL-AP-001234",
"productTrackingNumber": "TRK-789456123",
"deviceType": "RFID_TAG"
},
{
"productId": "PROD-56789",
"productName": "Electronic Control Module",
"productDescription": "Advanced electronic control unit for automotive applications",
"productCategory": "Electronics",
"quantity": 25,
"measurementUnitCode": "PCE",
"netWeight": 12.5,
"weightUnit": "KGM",
"unitCost": 450.00,
"currencyCode": "USD",
"extendedCost": 11250.00,
"freightCost": 75.00,
"totalLandedCost": 11325.00,
"countryOfOrigin": "CN",
"harmonizedSystemCode": "8537109900",
"orderNumber": "PO-2025-5678",
"deliveryNumber": "DN-345678",
"handlingUnitId": "BOX-002345",
"barcode": "234567890123",
"containerType": "box",
"gtin": "09876543210987",
"customerPartNumber": "CUST-ECM-002",
"supplierPartNumber": "SUPP-ECM-890",
"brandName": "TechControl",
"labelIdentifier": "LBL-ECM-002345",
"productTrackingNumber": "TRK-890123456",
"deviceType": "QR_CODE"
}
],
"pallets": [
{
"billOfLading": "BOL123",
"number": "123444444",
"parts": [
{
"customerPartNumber": "123-FCOSS",
"orderNumber": "123",
"quantity": "1",
"shipperPartNumber": "1259924",
"weight": "41.92 LB",
"description": "Material description 1"
},
{
"customerPartNumber": "65-2333SS",
"orderNumber": "123",
"quantity": "21",
"shipperPartNumber": "59924",
"weight": "880.32 LB",
"description": "Material description 2"
},
{
"customerPartNumber": "65-24DGOSS",
"orderNumber": "123",
"quantity": "22",
"shipperPartNumber": "1924",
"weight": "922.24 LB",
"description": "Material description 3"
},
{
"customerPartNumber": "65-24S",
"orderNumber": "123",
"quantity": "15",
"shipperPartNumber": "1255524",
"weight": "628.8 LB",
"description": "Material description 4"
}
]
}
],
"postalCode": "47408",
"referenceNumbers": [
"1234567",
"2412422222",
"PalletNumber:54831396"
],
"sequence": 2,
"state": "IN",
"stopReferenceId": "9876",
"stopType": "delivery",
"trackingNumber": "123456789",
"unloadTimeInMinutes": 150,
"wantTime": "2024-10-12T13:00:00Z"
}
],
"tags": [
"Tag1",
"Tag2",
"Tag3"
],
"trackingInfo": {
"deviceId": "12356",
"driverId": "999",
"driverPhone": "+19999999999",
"mawb": "17233144555",
"trailerNumber": "123",
"truckNumber": "456"
},
"trackingNumber": "123456789",
"truckRoutingParams": {
"height": "4.145",
"length": "14.63",
"limitedWeight": "996",
"shippedHazardousGoods": "flammable",
"trailersCount": 0,
"truckType": "truck",
"tunnelCategory": "C",
"weightPerAxle": "498",
"width": "2.438"
},
"seal": "XYZ123",
"sealStatus": "XYZ123"
}
}'Azure - Production
PATCH
https://api.ng.fourkites.com/api/v1/tracking/420645495
curl --location --request PATCH 'https://api.ng.fourkites.com/api/v1/tracking/420645495' \
--header 'Content-Type: application/json' \
--header 'apikey: REPLACE_KEY_VALUE' \
--data-raw '{
"simpleUpdate": "True",
"trackingInfo": {
"driverPhone": "",
"truckNumber": "",
"trailerNumber": ""
},
"additionalData": {
"modeDetails": {
"shipperModes": "TL",
"carrierModes": ""
}
},
"load": {
"carrierPermalink": "support-carrier-production",
"carrierName": "Support Carrier (Production)",
"carrier": "cc79",
"shipperAccountNumber": "tXXXXX234",
"haulType": [
"inbound_load"
],
"loadNumber": "TestUpdate",
"displayLoadNumber": "TestUpdate2",
"billOfLading": "billOfLading",
"bookingNumber": "bookingNumber",
"priority": "high",
"masterSequenceNumber": "1",
"masterReferenceNumber": "7328623",
"simultaneousTrackingSequenceNumber": 1,
"proNumber": "991",
"cost": {
"productCost": 410.00,
"extendedCost": 1200.00,
"freightCost": 45.50,
"additionalCost": 23.20,
"tariffCost": 85.00,
"landedCost": 1353.70,
"countryOfOrigin": "CN",
"currency": "USD",
"fourkitesCalculatedTariffCost": null
},
"products": [
{
"lowerTemperatureThreshold": "20",
"name": "Produce",
"productId": "0123456",
"setTemperature": "28",
"timeToleranceInMinutes": "30",
"upperTemperatureThreshold": "34"
}
],
"referenceNumbers": [
"ref1",
"ref2"
],
"deliveryNumbers": "DEL004, DEL005",
"masterTrackingNumber": "MASTER01",
"relayLoad": false,
"stops": [
{
"addressLine1": "500 West Madison Street",
"addressLine2": "Floor 33",
"city": "Chicago",
"country": "US",
"customer": {
"id": "789789",
"poNumbers": [
"00210123OF-203503"
],
"pointOfContact": {
"alert": false,
"email": "[email protected]",
"name": "John Doe",
"phone": "+19999999999"
}
},
"earliestAppointmentTime": "2024-10-11T01:00:00",
"earliestWantTime": "2024-10-11T01:00:00",
"externalAddressId": "100",
"latestAppointmentTime": "2024-10-11T02:00:00",
"latestWantTime": "2024-10-12T02:00:00",
"name": "FourKites HQ",
"loadingType": "drop",
"productLineItems": [
{
"productId": "rohit-123/78^*",
"productName": "Premium Auto Parts Kit",
"productDescription": "Complete automotive parts assembly kit including filters, belts, and gaskets",
"productCategory": "Automotive Parts",
"quantity": 100,
"measurementUnitCode": "PCE",
"netWeight": 250.5,
"weightUnit": "KGM",
"unitCost": 85.50,
"currencyCode": "USD",
"extendedCost": 8550.00,
"freightCost": 125.00,
"bestBeforeDate": "2025-07-15T08:10:00Z",
"additionalCharges": 500.00,
"tariffCost": 200.00,
"fourKitesCalculatedTariffCost": 1951.75,
"totalLandedCost": 8925.00,
"countryOfOrigin": "US",
"harmonizedSystemCode": "8708293000",
"commodityTypeCode": "AUTO_PARTS",
"htsusCode": "8708293000",
"orderNumber": "PO-2025-4567",
"deliveryNumber": "DN-789012",
"handlingUnitId": "PLT-001234",
"barcode": "123456789012",
"containerType": "pallet",
"gtin": "01234567890123",
"customerPartNumber": "CUST-AP-001",
"supplierPartNumber": "SUPP-KIT-789",
"manufacturerPartNumber": "MFG-APK-456",
"itemNumber": "ITM-001234",
"productUpc": "123456789012",
"deliveryReferences": ["DEL-REF-001", "DEL-REF-002"],
"orderReferences": ["ORD-REF-001"],
"brandName": "AutoPro",
"minimumTemperature": -10,
"maximumTemperature": 60,
"temperatureUnitCode": "cel",
"labelIdentifier": "LBL-AP-001234",
"productTrackingNumber": "TRK-789456123",
"deviceType": "RFID_TAG"
}
],
"pallets": [
{
"billOfLading": "BOL123",
"number": "123444444",
"parts": [
{
"customerPartNumber": "123-FCOSS",
"orderNumber": "123",
"quantity": "1",
"shipperPartNumber": "1259924",
"weight": "41.92 LB",
"description": "Material description 1"
},
{
"customerPartNumber": "65-2333SS",
"orderNumber": "123",
"quantity": "21",
"shipperPartNumber": "59924",
"weight": "880.32 LB",
"description": "Material description 2"
},
{
"customerPartNumber": "65-24DGOSS",
"orderNumber": "123",
"quantity": "22",
"shipperPartNumber": "1924",
"weight": "922.24 LB",
"description": "Material description 3"
},
{
"customerPartNumber": "65-24S",
"orderNumber": "123",
"quantity": "15",
"shipperPartNumber": "1255524",
"weight": "628.8 LB",
"description": "Material description 4"
}
]
}
],
"postalCode": "60611",
"referenceNumbers": [
"1234567",
"2412422222",
"PalletNumber:54831396"
],
"sequence": 1,
"shipTo": "1234",
"state": "IL",
"stopReferenceId": "123",
"stopType": "pickup",
"trackingNumber": "123456789",
"unloadTimeInMinutes": 120
},
{
"addressLine1": "1001 E 17th Street",
"addressLine2": "",
"city": "Bloomington",
"country": "US",
"customer": {
"id": "789789",
"poNumbers": [
"00210123OF-203503"
],
"customerPoFields": [
{
"delivery": "123232",
"deliveryReference": "ABC123",
"orderReference": "QWERTTY"
}
],
"pointOfContact": {
"alert": false,
"email": "[email protected]",
"name": "John Doe",
"phone": "+19999999999"
}
},
"earliestAppointmentTime": "2024-10-11T05:00:00",
"externalAddressId": "200",
"latestAppointmentTime": "2024-10-11T06:00:00",
"name": "Assembly Hall",
"productLineItems": [
{
"productId": "PROD-1234512",
"productName": "Premium Auto Parts Kit",
"productDescription": "Complete automotive parts assembly kit including filters, belts, and gaskets",
"productCategory": "Automotive Parts",
"quantity": 100,
"measurementUnitCode": "PCE",
"netWeight": 250.5,
"weightUnit": "KGM",
"unitCost": 85.50,
"currencyCode": "USD",
"extendedCost": 8550.00,
"freightCost": 125.00,
"additionalCharges": 50.00,
"tariffCost": 200.00,
"fourKitesCalculatedTariffCost": 195.75,
"totalLandedCost": 8925.00,
"countryOfOrigin": "US",
"harmonizedSystemCode": "8708293000",
"commodityTypeCode": "AUTO_PARTS",
"htsusCode": "8708293000",
"orderNumber": "PO-2025-4567",
"deliveryNumber": "DN-789012",
"handlingUnitId": "PLT-001234",
"barcode": "123456789012",
"containerType": "pallet",
"gtin": "01234567890123",
"customerPartNumber": "CUST-AP-001",
"supplierPartNumber": "SUPP-KIT-789",
"manufacturerPartNumber": "MFG-APK-456",
"itemNumber": "ITM-001234",
"productUpc": "123456789012",
"deliveryReferences": ["DEL-REF-001", "DEL-REF-002"],
"orderReferences": ["ORD-REF-001"],
"brandName": "AutoPro",
"minimumTemperature": -10,
"maximumTemperature": 60,
"temperatureUnitCode": "cel",
"labelIdentifier": "LBL-AP-001234",
"productTrackingNumber": "TRK-789456123",
"deviceType": "RFID_TAG"
},
{
"productId": "PROD-56789",
"productName": "Electronic Control Module",
"productDescription": "Advanced electronic control unit for automotive applications",
"productCategory": "Electronics",
"quantity": 25,
"measurementUnitCode": "PCE",
"netWeight": 12.5,
"weightUnit": "KGM",
"unitCost": 450.00,
"currencyCode": "USD",
"extendedCost": 11250.00,
"freightCost": 75.00,
"totalLandedCost": 11325.00,
"countryOfOrigin": "CN",
"harmonizedSystemCode": "8537109900",
"orderNumber": "PO-2025-5678",
"deliveryNumber": "DN-345678",
"handlingUnitId": "BOX-002345",
"barcode": "234567890123",
"containerType": "box",
"gtin": "09876543210987",
"customerPartNumber": "CUST-ECM-002",
"supplierPartNumber": "SUPP-ECM-890",
"brandName": "TechControl",
"labelIdentifier": "LBL-ECM-002345",
"productTrackingNumber": "TRK-890123456",
"deviceType": "QR_CODE"
}
],
"pallets": [
{
"billOfLading": "BOL123",
"number": "123444444",
"parts": [
{
"customerPartNumber": "123-FCOSS",
"orderNumber": "123",
"quantity": "1",
"shipperPartNumber": "1259924",
"weight": "41.92 LB",
"description": "Material description 1"
},
{
"customerPartNumber": "65-2333SS",
"orderNumber": "123",
"quantity": "21",
"shipperPartNumber": "59924",
"weight": "880.32 LB",
"description": "Material description 2"
},
{
"customerPartNumber": "65-24DGOSS",
"orderNumber": "123",
"quantity": "22",
"shipperPartNumber": "1924",
"weight": "922.24 LB",
"description": "Material description 3"
},
{
"customerPartNumber": "65-24S",
"orderNumber": "123",
"quantity": "15",
"shipperPartNumber": "1255524",
"weight": "628.8 LB",
"description": "Material description 4"
}
]
}
],
"postalCode": "47408",
"referenceNumbers": [
"1234567",
"2412422222",
"PalletNumber:54831396"
],
"sequence": 2,
"state": "IN",
"stopReferenceId": "9876",
"stopType": "delivery",
"trackingNumber": "123456789",
"unloadTimeInMinutes": 150,
"wantTime": "2024-10-12T13:00:00Z"
}
],
"tags": [
"Tag1",
"Tag2",
"Tag3"
],
"trackingInfo": {
"deviceId": "12356",
"driverId": "999",
"driverPhone": "+19999999999",
"mawb": "17233144555",
"trailerNumber": "123",
"truckNumber": "456"
},
"trackingNumber": "123456789",
"truckRoutingParams": {
"height": "4.145",
"length": "14.63",
"limitedWeight": "996",
"shippedHazardousGoods": "flammable",
"trailersCount": 0,
"truckType": "truck",
"tunnelCategory": "C",
"weightPerAxle": "498",
"width": "2.438"
},
"seal": "XYZ123",
"sealStatus": "XYZ123"
}
}'Azure - Staging
PATCH
https://api-staging.ng.fourkites.com/api/v1/tracking/420645495
curl --location --request PATCH 'https://api-staging.ng.fourkites.com/api/v1/tracking/420645495' \
--header 'Content-Type: application/json' \
--header 'apikey: REPLACE_KEY_VALUE' \
--data-raw '{
"simpleUpdate": "True",
"trackingInfo": {
"driverPhone": "",
"truckNumber": "",
"trailerNumber": ""
},
"additionalData": {
"modeDetails": {
"shipperModes": "TL",
"carrierModes": ""
}
},
"load": {
"carrierPermalink": "support-carrier-production",
"carrierName": "Support Carrier (Production)",
"carrier": "cc79",
"shipperAccountNumber": "tXXXXX234",
"haulType": [
"inbound_load"
],
"loadNumber": "TestUpdate",
"displayLoadNumber": "TestUpdate2",
"billOfLading": "billOfLading",
"bookingNumber": "bookingNumber",
"priority": "high",
"masterSequenceNumber": "1",
"masterReferenceNumber": "7328623",
"simultaneousTrackingSequenceNumber": 1,
"proNumber": "991",
"cost": {
"productCost": 410.00,
"extendedCost": 1200.00,
"freightCost": 45.50,
"additionalCost": 23.20,
"tariffCost": 85.00,
"landedCost": 1353.70,
"countryOfOrigin": "CN",
"currency": "USD",
"fourkitesCalculatedTariffCost": null
},
"products": [
{
"lowerTemperatureThreshold": "20",
"name": "Produce",
"productId": "0123456",
"setTemperature": "28",
"timeToleranceInMinutes": "30",
"upperTemperatureThreshold": "34"
}
],
"referenceNumbers": [
"ref1",
"ref2"
],
"deliveryNumbers": "DEL004, DEL005",
"masterTrackingNumber": "MASTER01",
"relayLoad": false,
"stops": [
{
"addressLine1": "500 West Madison Street",
"addressLine2": "Floor 33",
"city": "Chicago",
"country": "US",
"customer": {
"id": "789789",
"poNumbers": [
"00210123OF-203503"
],
"pointOfContact": {
"alert": false,
"email": "[email protected]",
"name": "John Doe",
"phone": "+19999999999"
}
},
"earliestAppointmentTime": "2024-10-11T01:00:00",
"earliestWantTime": "2024-10-11T01:00:00",
"externalAddressId": "100",
"latestAppointmentTime": "2024-10-11T02:00:00",
"latestWantTime": "2024-10-12T02:00:00",
"name": "FourKites HQ",
"loadingType": "drop",
"productLineItems": [
{
"productId": "rohit-123/78^*",
"productName": "Premium Auto Parts Kit",
"productDescription": "Complete automotive parts assembly kit including filters, belts, and gaskets",
"productCategory": "Automotive Parts",
"quantity": 100,
"measurementUnitCode": "PCE",
"netWeight": 250.5,
"weightUnit": "KGM",
"unitCost": 85.50,
"currencyCode": "USD",
"extendedCost": 8550.00,
"freightCost": 125.00,
"bestBeforeDate": "2025-07-15T08:10:00Z",
"additionalCharges": 500.00,
"tariffCost": 200.00,
"fourKitesCalculatedTariffCost": 1951.75,
"totalLandedCost": 8925.00,
"countryOfOrigin": "US",
"harmonizedSystemCode": "8708293000",
"commodityTypeCode": "AUTO_PARTS",
"htsusCode": "8708293000",
"orderNumber": "PO-2025-4567",
"deliveryNumber": "DN-789012",
"handlingUnitId": "PLT-001234",
"barcode": "123456789012",
"containerType": "pallet",
"gtin": "01234567890123",
"customerPartNumber": "CUST-AP-001",
"supplierPartNumber": "SUPP-KIT-789",
"manufacturerPartNumber": "MFG-APK-456",
"itemNumber": "ITM-001234",
"productUpc": "123456789012",
"deliveryReferences": ["DEL-REF-001", "DEL-REF-002"],
"orderReferences": ["ORD-REF-001"],
"brandName": "AutoPro",
"minimumTemperature": -10,
"maximumTemperature": 60,
"temperatureUnitCode": "cel",
"labelIdentifier": "LBL-AP-001234",
"productTrackingNumber": "TRK-789456123",
"deviceType": "RFID_TAG"
}
],
"pallets": [
{
"billOfLading": "BOL123",
"number": "123444444",
"parts": [
{
"customerPartNumber": "123-FCOSS",
"orderNumber": "123",
"quantity": "1",
"shipperPartNumber": "1259924",
"weight": "41.92 LB",
"description": "Material description 1"
},
{
"customerPartNumber": "65-2333SS",
"orderNumber": "123",
"quantity": "21",
"shipperPartNumber": "59924",
"weight": "880.32 LB",
"description": "Material description 2"
},
{
"customerPartNumber": "65-24DGOSS",
"orderNumber": "123",
"quantity": "22",
"shipperPartNumber": "1924",
"weight": "922.24 LB",
"description": "Material description 3"
},
{
"customerPartNumber": "65-24S",
"orderNumber": "123",
"quantity": "15",
"shipperPartNumber": "1255524",
"weight": "628.8 LB",
"description": "Material description 4"
}
]
}
],
"postalCode": "60611",
"referenceNumbers": [
"1234567",
"2412422222",
"PalletNumber:54831396"
],
"sequence": 1,
"shipTo": "1234",
"state": "IL",
"stopReferenceId": "123",
"stopType": "pickup",
"trackingNumber": "123456789",
"unloadTimeInMinutes": 120
},
{
"addressLine1": "1001 E 17th Street",
"addressLine2": "",
"city": "Bloomington",
"country": "US",
"customer": {
"id": "789789",
"poNumbers": [
"00210123OF-203503"
],
"customerPoFields": [
{
"delivery": "123232",
"deliveryReference": "ABC123",
"orderReference": "QWERTTY"
}
],
"pointOfContact": {
"alert": false,
"email": "[email protected]",
"name": "John Doe",
"phone": "+19999999999"
}
},
"earliestAppointmentTime": "2024-10-11T05:00:00",
"externalAddressId": "200",
"latestAppointmentTime": "2024-10-11T06:00:00",
"name": "Assembly Hall",
"productLineItems": [
{
"productId": "PROD-1234512",
"productName": "Premium Auto Parts Kit",
"productDescription": "Complete automotive parts assembly kit including filters, belts, and gaskets",
"productCategory": "Automotive Parts",
"quantity": 100,
"measurementUnitCode": "PCE",
"netWeight": 250.5,
"weightUnit": "KGM",
"unitCost": 85.50,
"currencyCode": "USD",
"extendedCost": 8550.00,
"freightCost": 125.00,
"additionalCharges": 50.00,
"tariffCost": 200.00,
"fourKitesCalculatedTariffCost": 195.75,
"totalLandedCost": 8925.00,
"countryOfOrigin": "US",
"harmonizedSystemCode": "8708293000",
"commodityTypeCode": "AUTO_PARTS",
"htsusCode": "8708293000",
"orderNumber": "PO-2025-4567",
"deliveryNumber": "DN-789012",
"handlingUnitId": "PLT-001234",
"barcode": "123456789012",
"containerType": "pallet",
"gtin": "01234567890123",
"customerPartNumber": "CUST-AP-001",
"supplierPartNumber": "SUPP-KIT-789",
"manufacturerPartNumber": "MFG-APK-456",
"itemNumber": "ITM-001234",
"productUpc": "123456789012",
"deliveryReferences": ["DEL-REF-001", "DEL-REF-002"],
"orderReferences": ["ORD-REF-001"],
"brandName": "AutoPro",
"minimumTemperature": -10,
"maximumTemperature": 60,
"temperatureUnitCode": "cel",
"labelIdentifier": "LBL-AP-001234",
"productTrackingNumber": "TRK-789456123",
"deviceType": "RFID_TAG"
},
{
"productId": "PROD-56789",
"productName": "Electronic Control Module",
"productDescription": "Advanced electronic control unit for automotive applications",
"productCategory": "Electronics",
"quantity": 25,
"measurementUnitCode": "PCE",
"netWeight": 12.5,
"weightUnit": "KGM",
"unitCost": 450.00,
"currencyCode": "USD",
"extendedCost": 11250.00,
"freightCost": 75.00,
"totalLandedCost": 11325.00,
"countryOfOrigin": "CN",
"harmonizedSystemCode": "8537109900",
"orderNumber": "PO-2025-5678",
"deliveryNumber": "DN-345678",
"handlingUnitId": "BOX-002345",
"barcode": "234567890123",
"containerType": "box",
"gtin": "09876543210987",
"customerPartNumber": "CUST-ECM-002",
"supplierPartNumber": "SUPP-ECM-890",
"brandName": "TechControl",
"labelIdentifier": "LBL-ECM-002345",
"productTrackingNumber": "TRK-890123456",
"deviceType": "QR_CODE"
}
],
"pallets": [
{
"billOfLading": "BOL123",
"number": "123444444",
"parts": [
{
"customerPartNumber": "123-FCOSS",
"orderNumber": "123",
"quantity": "1",
"shipperPartNumber": "1259924",
"weight": "41.92 LB",
"description": "Material description 1"
},
{
"customerPartNumber": "65-2333SS",
"orderNumber": "123",
"quantity": "21",
"shipperPartNumber": "59924",
"weight": "880.32 LB",
"description": "Material description 2"
},
{
"customerPartNumber": "65-24DGOSS",
"orderNumber": "123",
"quantity": "22",
"shipperPartNumber": "1924",
"weight": "922.24 LB",
"description": "Material description 3"
},
{
"customerPartNumber": "65-24S",
"orderNumber": "123",
"quantity": "15",
"shipperPartNumber": "1255524",
"weight": "628.8 LB",
"description": "Material description 4"
}
]
}
],
"postalCode": "47408",
"referenceNumbers": [
"1234567",
"2412422222",
"PalletNumber:54831396"
],
"sequence": 2,
"state": "IN",
"stopReferenceId": "9876",
"stopType": "delivery",
"trackingNumber": "123456789",
"unloadTimeInMinutes": 150,
"wantTime": "2024-10-12T13:00:00Z"
}
],
"tags": [
"Tag1",
"Tag2",
"Tag3"
],
"trackingInfo": {
"deviceId": "12356",
"driverId": "999",
"driverPhone": "+19999999999",
"mawb": "17233144555",
"trailerNumber": "123",
"truckNumber": "456"
},
"trackingNumber": "123456789",
"truckRoutingParams": {
"height": "4.145",
"length": "14.63",
"limitedWeight": "996",
"shippedHazardousGoods": "flammable",
"trailersCount": 0,
"truckType": "truck",
"tunnelCategory": "C",
"weightPerAxle": "498",
"width": "2.438"
},
"seal": "XYZ123",
"sealStatus": "XYZ123"
}
}'Notes:
- Load number cannot be updated.
- Tracking information (truck/tractor number, trailer number, and driver phone) and appointment times can be updated even after tracking has started.
- The tags field is ‘additive’; any new tag included in the Load Update API call will be added to the existing tags(s) associated with the load. And, if no tags are included in the Load Update API call, the existing tag(s) will be retained.
- Driver ID is used by drivers of private fleet owners to log into CarrierLink and see the loads assigned to them. There should be an existing driver user in the platform with the same driver ID.
- earliestAppointmentTime and latestAppointmentTime – One cannot be provided without the other and latestAppointmentTime should be greater than or equal to earliestAppointmentTime.
- Appointment time validation is applied to the most recent appointment time across all stops on the load. The system identifies the stop with the maximum (latest) appointment time and validates that this time is not more than 4 days in the past from the current time. Individual stops are not validated separately - if a load has multiple stops with appointment times older than 4 days, but the most recent appointment is within 4 days, the validation passes. This approach enables tracking for loads with at least one valid recent stop. Note: The system does not enforce chronological order between pickup and delivery appointment times. It is the customer's responsibility to ensure appointment times are logically sequenced.
- All appointment times must be in the stop's local timezone.
- additionalData is applicable only for companies enabled with Smart Forecasted Arrival where code "X3" will mark the load as "At Pickup" and code "AF" will mark the load as "Picked Up".
- In the additionalData, Description, City, State and Country fields are not mandatory, but can be included.
- In the additionalData segment, note that the "stopReferenceID" field is also accepted.
- For SFA to be triggered, we will require the status of the load to be "Picked Up", and the corresponding code to use is "AF".
- If the customers are sending "At PickUp" followed by "Picked Up", it clearly defines when the load had arrived and left the pickup stop.
- A minimum requirement for triggering SFA is for FourKites® to understand when the load "Departed Pickup" or "PickedUp". Hence, providing the inputs corresponding to this status will be sufficient.
- Setting the "Priority" as 'Hot' will mark the load as 'Hot' load.
- Passing the "holdLoad" value as 'true' will extend expiry of the load. Note that this is applicable only for TL (Truck Loads). The default value is 'false'.
- Pass the displayLoadNumber parameter to display a number other than the loadNumber in the load card.
Note:
By default, we will track the load mode detected by FourKites® but to set a ranking order, please speak to your CSM at FourKites®.
Product Line Items Schema
Field Name | Data Type | Constraints | Description |
|---|---|---|---|
productId | VARCHAR | Mandatory if productLineItems object is present | Unique identifier for the product |
productName | VARCHAR(255) | Not Null | Display name of the product |
productDescription | TEXT | Optional | Detailed description of the product |
productCategory | VARCHAR(100) | Optional | Category classification of the product |
quantity | INTEGER | Not Null, >= 0 | Number of units in the shipment |
measurementUnitCode | VARCHAR(10) | Not Null | Unit of measurement for quantity (e.g., PCE, KG, LB) |
netWeight | DECIMAL(10,3) | Optional | Weight of the product excluding packaging |
weightUnit | VARCHAR(10) | Optional | Unit of measurement for weight (e.g., KGM, LBM) |
unitCost | DECIMAL(14,2) | Optional | Cost per unit of the product |
currencyCode | CHAR(3) | ISO 4217 | Currency code for cost fields |
extendedCost | DECIMAL(14,2) | Optional | Total cost for all units (unitCost × quantity) |
freightCost | DECIMAL(14,2) | Optional | Freight cost allocated to this line item |
bestBeforeDate | TIMESTAMP | Optional | Expiration or best before date for the product |
additionalCharges | DECIMAL(14,2) | Optional | Any additional charges specific to this line item |
tariffCost | DECIMAL(14,2) | Optional | Tariff cost for this specific line item |
fourKitesCalculatedTariffCost | DECIMAL(14,2) | Optional | System-calculated tariff cost |
totalLandedCost | DECIMAL(14,2) | Optional | Total landed cost for this line item |
countryOfOrigin | CHAR(2) | ISO 3166-1 | Country of origin for this product |
harmonizedSystemCode | VARCHAR(12) | Optional | International trade classification code |
commodityTypeCode | VARCHAR(50) | Optional | Commodity classification code |
htsusCode | VARCHAR(12) | Optional | Harmonized Tariff Schedule code for US imports |
orderNumber | VARCHAR(50) | Optional | Purchase order number |
deliveryNumber | VARCHAR(50) | Optional | Delivery reference number |
handlingUnitId | VARCHAR(50) | Optional | Identifier for the handling unit (pallet, box, etc.) |
barcode | VARCHAR(50) | GS1-compliant | Product barcode |
containerType | VARCHAR(20) | Optional | Type of container (pallet, box, carton, etc.) |
gtin | VARCHAR(14) | Optional | Global Trade Item Number |
customerPartNumber | VARCHAR(100) | Optional | Customer's part number for the product |
supplierPartNumber | VARCHAR(100) | Optional | Supplier's part number for the product |
manufacturerPartNumber | VARCHAR(100) | Optional | Manufacturer's part number |
itemNumber | VARCHAR(50) | Optional | Internal item number |
productUpc | VARCHAR(15) | Optional | Universal Product Code |
deliveryReferences | JSONB | Optional | Array of delivery reference numbers |
orderReferences | JSONB | Optional | Array of order reference numbers |
brandName | VARCHAR(100) | Optional | Brand name of the product |
minimumTemperature | INTEGER | Optional | Minimum storage/transport temperature |
maximumTemperature | INTEGER | Optional | Maximum storage/transport temperature |
temperatureUnitCode | VARCHAR(10) | Optional | Temperature unit (cel, fah) |
labelIdentifier | VARCHAR(100) | Optional | Label identifier for tracking |
productTrackingNumber | VARCHAR(100) | Optional | Unique tracking number for the product |
deviceType | VARCHAR(50) | Optional | Type of tracking device (RFID_TAG, QR_CODE, etc.) |
Shipment Costs Schema
Field Name | Data Type | Constraints | Description |
|---|---|---|---|
productCost | DECIMAL(14,2) | Optional | Base cost of the product before any additional charges |
extendedCost | DECIMAL(14,2) | Optional | Extended cost calculated from unit cost × quantity |
freightCost | DECIMAL(14,2) | Optional | Transportation/shipping cost for the shipment |
additionalCost | DECIMAL(14,2) | Optional | Any additional miscellaneous costs |
tariffCost | DECIMAL(14,2) | Optional | Import/export tariff costs |
landedCost | DECIMAL(14,2) | Optional | Total cost including all fees and charges |
countryOfOrigin | CHAR(2) | ISO 3166-1 | Country code where the product originated |
currency | CHAR(3) | ISO 4217 | Currency code for all cost fields |
fourkitesCalculatedTariffCost | DECIMAL(14,2) | Nullable | System-calculated tariff cost, can be null |
Response Attributes:
Name | Format | Description |
|---|---|---|
message | String | It represents the status of the request submitted. |
statusCode | String | HTTP StatusCode of the response. |
Create/Update Errors
It is possible that you hit an error due to various reasons when trying to create or update a load. The following table is directed towards making your life simpler by providing the list of possible errors you will encounter and the steps to resolve them.
Error Code | Error Message | Resolution |
|---|---|---|
400 | State 'ABCD' is not valid | Provide a valid 2 character state code for US and Canada and a 3 character state code for Mexico.Example: CA, NY, ON, BCN, CAM. |
400 | Postal 'EFGH' is not a valid US postal code | Provide a valid US postal code.Example: 87901 |
400 | Postal 'EFGH' is not a valid Canada postal code | Provide a valid Canada postal code.Example: V3J |
400 | Postal 'EFGH' is not a valid Mexico postal code | Provide a valid Mexico postal code.Example: 46958 |
400 | Stops should contain at least one pickup and one delivery | Ensure that you create a load with at least one pickup and one delivery stop. |
400 | Stops stop Earliest Appointment Time should not be greater than Latest Appointment Time | Ensure that the stop's earliest appointment time is not greater than the latest appointment time. |
400 | Stops cannot have appointment time earlier than 4 days | Ensure that the stop's appointment time is not earlier than 4 days from the current time. |
400 | Address should contain Address line 1 or city, state and country or Latitude and Longitude | While creating a load, ensure that stop address contains at least one of the following:Address Line 1, City, State, Country,Latitude/Longitude. This helps in geocoding the stop address. |
400 | Load information is empty | Ensure that the "load" object is included in your API request: {"load": { ... ... }} |
400 | Carrier is not specified | Specify the SCAC of the Carrier. |
400 | Stops stop should contain both earliest and latest want times | If you want to create a load with want time as time ranges (earliest and latest want time), ensure that you provide the values for both these fields. |
400 | Stops stop Earliest Want Time should not be greater than Latest Want Time | Ensure that the stop's earliest want time is not greater than the latest want time. |
400 | Products temperature unit is invalid | If you create a temperature-tracked load, ensure that you provide the correct temperature unit. The Valid values are: C (Celsius), F (Fahrenheit) |
400 | Products temperature parameters need to be valid | If you create a temperature-tracked load with setTemperature and timeToleranceInMinutes, ensure that you provide values for both fields. That is, this error will be posted when you try to create a temperature-tracked load by sending values only for setTemperature and not for timeToleranceInMinutes or vice-versa. |
409 | API call limit exceeded | This occurs when a user has made multiple API calls for the same request. |
403 | Invalid Session, please login | The session may have timed out. Log in again. |
401 | User not authorized for this resource | Check if the user is a FourKites user and has the necessary permissions to perform the action. |
500 | Internal Server Error | Service may be down. Try again later. Note: 5XX error means that our server is unable to establish a connection. In case of a 5XX error, we suggest applying a procedure to retry the API call after an hour. |