Create Shipment
⚠️ Important Update:
The Pallets structure is being deprecated. Please transition to for product details. Learn more
Please be advised that the terms "Shipment" and "Load" are interchangeable in all our API documentation.
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.
Create Shipment/Load API allows authorized users to create a new load for tracking.
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.
When you create a load using only latitude and longitude without including other address details (such as city, state, country, or addressLine), you need to ensure the Process Lat/Long From API flag is enabled for your company. If not, reach out to your Customer Success Manager at FourKites to have it enabled. If the Process Lat/Long From API flag is enabled for your company, you do not have to consider addressLine1 as a mandatory field.
Shipment Creation Timeliness
OTR Shipments: We highly recommend creating shipments before the pickup appointment. Ideally, shipments should be created at least two days in advance to allow carriers sufficient time for asset assignment.
Ocean Shipments: For ocean shipments, we recommend creating loads as early as possible. However, they must be created no later than before the vessel departure event occurs at the Port of Loading.
Air & Rail Shipments: We require Air & Rail shipments to be created before pickup to ensure seamless end-to-end milestone tracking.
Rate Limit
1 request per second
Format Supported
JSON
Authenticated Resource
API Key
For more information on Authentication, click here.
Point to note:
productLineItems will serve as the standard place to receive product details corresponding to every stop. This structure will need to be followed going forward instead of pallets - pallets will soon be phased out. The productId will be a mandatory field for every product line item, and it should be unique for a specific product.
Refer here for the field descriptions of Product Line Items & Shipment Cost Schema.
curl --location 'https://api.fourkites.com/api/v1/tracking' \
--header 'Content-Type: application/json' \
--header 'apikey: REPLACE_KEY_VALUE' \
--data-raw '{
"additionalData": {
"modeDetails": {
"shipperModes": "TL",
"carrierModes": ""
}
},
"load": {
"carrierPermalink": "insights-carrier-6870",
"carrierName": "Insights Carrier",
"carrier": "IC68",
"shipperAccountNumber": "tXXXXX234",
"haulType": [
"inbound_load"
],
"loadNumber": "KDPKDLTEST09",
"displayLoadNumber": "KDPKDLTEST09",
"billOfLading": "billOfLading",
"bookingNumber": "bookingNumber",
"priority": "high",
"simultaneousTrackingReferenceNumber": "simul123",
"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": "-10",
"name": "Premium Auto Parts Kit",
"productId": "rohit-123/78^*",
"setTemperature": "25",
"timeToleranceInMinutes": "30",
"upperTemperatureThreshold": "60",
"temperatureUnitCode": "cel"
},
{
"lowerTemperatureThreshold": "-10",
"name": "Electronic Control Module",
"productId": "PROD-56789",
"setTemperature": "25",
"timeToleranceInMinutes": "30",
"upperTemperatureThreshold": "60",
"temperatureUnitCode": "cel"
}
],
"referenceNumbers": [
"PO-2025-4567",
"DN-789012",
"PO-2025-5678",
"DN-345678"
],
"deliveryNumbers": "DN-789012, DN-345678",
"masterTrackingNumber": "MASTER01",
"relayLoad": false,
"stops": [
{
"stopId": "1529659839",
"addressLine1": "500 West Madison Street",
"addressLine2": "Floor 33",
"city": "Chicago",
"country": "US",
"customer": {
"id": "789789",
"name": "sample name 12",
"poNumbers": [
"PO-2025-4567"
],
"customerPoFields": [
{
"deliveryNumber": "DN-789012",
"deliveryReference": "DEL-REF-001",
"orderReference": "ORD-REF-001"
}
],
"pointOfContact": {
"alert": false,
"email": "[email protected]",
"name": "John Doe",
"phone": "+19999999999"
}
},
"earliestAppointmentTime": "2026-07-19T01:00:00",
"earliestWantTime": "2026-07-19T01:00:00",
"externalAddressId": "100",
"latestAppointmentTime": "2026-07-19T02:00:00",
"latestWantTime": "2026-07-19T02: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"
}
],
"postalCode": "60611",
"referenceNumbers": [
"DEL-REF-001",
"DEL-REF-002",
"TRK-789456123"
],
"sequence": 1,
"shipTo": "1234",
"state": "IL",
"stopReferenceId": "1529659839",
"stopType": "pickup",
"trackingNumber": "TRK-789456123",
"unloadTimeInMinutes": 120
},
{
"stopId": "1529659852",
"addressLine1": "1001 E 17th Street",
"addressLine2": "",
"city": "Bloomington",
"country": "US",
"customer": {
"id": "789789",
"name": "sample name 12",
"poNumbers": [
"PO-2025-4567",
"PO-2025-5678"
],
"customerPoFields": [
{
"deliveryNumber": "DN-345678",
"deliveryReference": "DEL-REF-002",
"orderReference": "ORD-REF-001"
}
],
"pointOfContact": {
"alert": false,
"email": "[email protected]",
"name": "John Doe",
"phone": "+19999999999"
}
},
"earliestAppointmentTime": "2026-07-20T05:00:00",
"externalAddressId": "200",
"latestAppointmentTime": "2026-07-20T06: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"
}
],
"postalCode": "47408",
"referenceNumbers": [
"DEL-REF-001",
"DEL-REF-002",
"TRK-789456123",
"TRK-890123456"
],
"sequence": 2,
"state": "IN",
"stopReferenceId": "1529659852",
"stopType": "delivery",
"trackingNumber": "TRK-890123456",
"unloadTimeInMinutes": 150,
"wantTime": "2026-07-21T13: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"
}
}'curl --location 'https://api-staging.fourkites.com/api/v1/tracking' \
--header 'Content-Type: application/json' \
--header 'apikey: REPLACE_KEY_VALUE' \
--data-raw '{
"additionalData": {
"modeDetails": {
"shipperModes": "TL",
"carrierModes": ""
}
},
"load": {
"carrierPermalink": "insights-carrier-6870",
"carrierName": "Insights Carrier",
"carrier": "IC68",
"shipperAccountNumber": "tXXXXX234",
"haulType": [
"inbound_load"
],
"loadNumber": "KDPKDLTEST09",
"displayLoadNumber": "KDPKDLTEST09",
"billOfLading": "billOfLading",
"bookingNumber": "bookingNumber",
"priority": "high",
"simultaneousTrackingReferenceNumber": "simul123",
"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": "-10",
"name": "Premium Auto Parts Kit",
"productId": "rohit-123/78^*",
"setTemperature": "25",
"timeToleranceInMinutes": "30",
"upperTemperatureThreshold": "60",
"temperatureUnitCode": "cel"
},
{
"lowerTemperatureThreshold": "-10",
"name": "Electronic Control Module",
"productId": "PROD-56789",
"setTemperature": "25",
"timeToleranceInMinutes": "30",
"upperTemperatureThreshold": "60",
"temperatureUnitCode": "cel"
}
],
"referenceNumbers": [
"PO-2025-4567",
"DN-789012",
"PO-2025-5678",
"DN-345678"
],
"deliveryNumbers": "DN-789012, DN-345678",
"masterTrackingNumber": "MASTER01",
"relayLoad": false,
"stops": [
{
"stopId": "1529659839",
"addressLine1": "500 West Madison Street",
"addressLine2": "Floor 33",
"city": "Chicago",
"country": "US",
"customer": {
"id": "789789",
"name": "sample name 12",
"poNumbers": [
"PO-2025-4567"
],
"customerPoFields": [
{
"deliveryNumber": "DN-789012",
"deliveryReference": "DEL-REF-001",
"orderReference": "ORD-REF-001"
}
],
"pointOfContact": {
"alert": false,
"email": "[email protected]",
"name": "John Doe",
"phone": "+19999999999"
}
},
"earliestAppointmentTime": "2026-07-19T01:00:00",
"earliestWantTime": "2026-07-19T01:00:00",
"externalAddressId": "100",
"latestAppointmentTime": "2026-07-19T02:00:00",
"latestWantTime": "2026-07-19T02: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"
}
],
"postalCode": "60611",
"referenceNumbers": [
"DEL-REF-001",
"DEL-REF-002",
"TRK-789456123"
],
"sequence": 1,
"shipTo": "1234",
"state": "IL",
"stopReferenceId": "1529659839",
"stopType": "pickup",
"trackingNumber": "TRK-789456123",
"unloadTimeInMinutes": 120
},
{
"stopId": "1529659852",
"addressLine1": "1001 E 17th Street",
"addressLine2": "",
"city": "Bloomington",
"country": "US",
"customer": {
"id": "789789",
"name": "sample name 12",
"poNumbers": [
"PO-2025-4567",
"PO-2025-5678"
],
"customerPoFields": [
{
"deliveryNumber": "DN-345678",
"deliveryReference": "DEL-REF-002",
"orderReference": "ORD-REF-001"
}
],
"pointOfContact": {
"alert": false,
"email": "[email protected]",
"name": "John Doe",
"phone": "+19999999999"
}
},
"earliestAppointmentTime": "2026-07-20T05:00:00",
"externalAddressId": "200",
"latestAppointmentTime": "2026-07-20T06: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"
}
],
"postalCode": "47408",
"referenceNumbers": [
"DEL-REF-001",
"DEL-REF-002",
"TRK-789456123",
"TRK-890123456"
],
"sequence": 2,
"state": "IN",
"stopReferenceId": "1529659852",
"stopType": "delivery",
"trackingNumber": "TRK-890123456",
"unloadTimeInMinutes": 150,
"wantTime": "2026-07-21T13: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"
}
}'import http.client
import json
conn = http.client.HTTPSConnection("api.ng.fourkites.com")
payload = json.dumps({
"additionalData": {
"modeDetails": {
"shipperModes": "TL",
"carrierModes": ""
}
},
"load": {
"carrierPermalink": "insights-carrier-6870",
"carrierName": "Insights Carrier",
"carrier": "IC68",
"shipperAccountNumber": "tXXXXX234",
"haulType": [
"inbound_load"
],
"loadNumber": "KDPKDLTEST09",
"displayLoadNumber": "KDPKDLTEST09",
"billOfLading": "billOfLading",
"bookingNumber": "bookingNumber",
"priority": "high",
"simultaneousTrackingReferenceNumber": "simul123",
"simultaneousTrackingSequenceNumber": 1,
"proNumber": "991",
"cost": {
"productCost": 410,
"extendedCost": 1200,
"freightCost": 45.5,
"additionalCost": 23.2,
"tariffCost": 85,
"landedCost": 1353.7,
"countryOfOrigin": "CN",
"currency": "USD",
"fourkitesCalculatedTariffCost": None
},
"products": [
{
"lowerTemperatureThreshold": "-10",
"name": "Premium Auto Parts Kit",
"productId": "rohit-123/78^*",
"setTemperature": "25",
"timeToleranceInMinutes": "30",
"upperTemperatureThreshold": "60",
"temperatureUnitCode": "cel"
},
{
"lowerTemperatureThreshold": "-10",
"name": "Electronic Control Module",
"productId": "PROD-56789",
"setTemperature": "25",
"timeToleranceInMinutes": "30",
"upperTemperatureThreshold": "60",
"temperatureUnitCode": "cel"
}
],
"referenceNumbers": [
"PO-2025-4567",
"DN-789012",
"PO-2025-5678",
"DN-345678"
],
"deliveryNumbers": "DN-789012, DN-345678",
"masterTrackingNumber": "MASTER01",
"relayLoad": False,
"stops": [
{
"stopId": "1529659839",
"addressLine1": "500 West Madison Street",
"addressLine2": "Floor 33",
"city": "Chicago",
"country": "US",
"customer": {
"id": "789789",
"name": "sample name 12",
"poNumbers": [
"PO-2025-4567"
],
"customerPoFields": [
{
"deliveryNumber": "DN-789012",
"deliveryReference": "DEL-REF-001",
"orderReference": "ORD-REF-001"
}
],
"pointOfContact": {
"alert": False,
"email": "[email protected]",
"name": "John Doe",
"phone": "+19999999999"
}
},
"earliestAppointmentTime": "2026-07-19T01:00:00",
"earliestWantTime": "2026-07-19T01:00:00",
"externalAddressId": "100",
"latestAppointmentTime": "2026-07-19T02:00:00",
"latestWantTime": "2026-07-19T02: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.5,
"currencyCode": "USD",
"extendedCost": 8550,
"freightCost": 125,
"bestBeforeDate": "2025-07-15T08:10:00Z",
"additionalCharges": 500,
"tariffCost": 200,
"fourKitesCalculatedTariffCost": 1951.75,
"totalLandedCost": 8925,
"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"
}
],
"postalCode": "60611",
"referenceNumbers": [
"DEL-REF-001",
"DEL-REF-002",
"TRK-789456123"
],
"sequence": 1,
"shipTo": "1234",
"state": "IL",
"stopReferenceId": "1529659839",
"stopType": "pickup",
"trackingNumber": "TRK-789456123",
"unloadTimeInMinutes": 120
},
{
"stopId": "1529659852",
"addressLine1": "1001 E 17th Street",
"addressLine2": "",
"city": "Bloomington",
"country": "US",
"customer": {
"id": "789789",
"name": "sample name 12",
"poNumbers": [
"PO-2025-4567",
"PO-2025-5678"
],
"customerPoFields": [
{
"deliveryNumber": "DN-345678",
"deliveryReference": "DEL-REF-002",
"orderReference": "ORD-REF-001"
}
],
"pointOfContact": {
"alert": False,
"email": "[email protected]",
"name": "John Doe",
"phone": "+19999999999"
}
},
"earliestAppointmentTime": "2026-07-20T05:00:00",
"externalAddressId": "200",
"latestAppointmentTime": "2026-07-20T06: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.5,
"currencyCode": "USD",
"extendedCost": 8550,
"freightCost": 125,
"additionalCharges": 50,
"tariffCost": 200,
"fourKitesCalculatedTariffCost": 195.75,
"totalLandedCost": 8925,
"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,
"currencyCode": "USD",
"extendedCost": 11250,
"freightCost": 75,
"totalLandedCost": 11325,
"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"
}
],
"postalCode": "47408",
"referenceNumbers": [
"DEL-REF-001",
"DEL-REF-002",
"TRK-789456123",
"TRK-890123456"
],
"sequence": 2,
"state": "IN",
"stopReferenceId": "1529659852",
"stopType": "delivery",
"trackingNumber": "TRK-890123456",
"unloadTimeInMinutes": 150,
"wantTime": "2026-07-21T13: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"
}
})
headers = {
'Content-Type': 'application/json',
'apikey': 'REPLACE_KEY_VALUE'
}
conn.request("POST", "/api/v1/tracking", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))curl --location 'https://api-staging.ng.fourkites.com/api/v1/tracking' \
--header 'Content-Type: application/json' \
--header 'apikey: REPLACE_KEY_VALUE' \
--data-raw '{
"additionalData": {
"modeDetails": {
"shipperModes": "TL",
"carrierModes": ""
}
},
"load": {
"carrierPermalink": "insights-carrier-6870",
"carrierName": "Insights Carrier",
"carrier": "IC68",
"shipperAccountNumber": "tXXXXX234",
"haulType": [
"inbound_load"
],
"loadNumber": "KDPKDLTEST09",
"displayLoadNumber": "KDPKDLTEST09",
"billOfLading": "billOfLading",
"bookingNumber": "bookingNumber",
"priority": "high",
"simultaneousTrackingReferenceNumber": "simul123",
"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": "-10",
"name": "Premium Auto Parts Kit",
"productId": "rohit-123/78^*",
"setTemperature": "25",
"timeToleranceInMinutes": "30",
"upperTemperatureThreshold": "60",
"temperatureUnitCode": "cel"
},
{
"lowerTemperatureThreshold": "-10",
"name": "Electronic Control Module",
"productId": "PROD-56789",
"setTemperature": "25",
"timeToleranceInMinutes": "30",
"upperTemperatureThreshold": "60",
"temperatureUnitCode": "cel"
}
],
"referenceNumbers": [
"PO-2025-4567",
"DN-789012",
"PO-2025-5678",
"DN-345678"
],
"deliveryNumbers": "DN-789012, DN-345678",
"masterTrackingNumber": "MASTER01",
"relayLoad": false,
"stops": [
{
"stopId": "1529659839",
"addressLine1": "500 West Madison Street",
"addressLine2": "Floor 33",
"city": "Chicago",
"country": "US",
"customer": {
"id": "789789",
"name": "sample name 12",
"poNumbers": [
"PO-2025-4567"
],
"customerPoFields": [
{
"deliveryNumber": "DN-789012",
"deliveryReference": "DEL-REF-001",
"orderReference": "ORD-REF-001"
}
],
"pointOfContact": {
"alert": false,
"email": "[email protected]",
"name": "John Doe",
"phone": "+19999999999"
}
},
"earliestAppointmentTime": "2026-07-19T01:00:00",
"earliestWantTime": "2026-07-19T01:00:00",
"externalAddressId": "100",
"latestAppointmentTime": "2026-07-19T02:00:00",
"latestWantTime": "2026-07-19T02: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"
}
],
"postalCode": "60611",
"referenceNumbers": [
"DEL-REF-001",
"DEL-REF-002",
"TRK-789456123"
],
"sequence": 1,
"shipTo": "1234",
"state": "IL",
"stopReferenceId": "1529659839",
"stopType": "pickup",
"trackingNumber": "TRK-789456123",
"unloadTimeInMinutes": 120
},
{
"stopId": "1529659852",
"addressLine1": "1001 E 17th Street",
"addressLine2": "",
"city": "Bloomington",
"country": "US",
"customer": {
"id": "789789",
"name": "sample name 12",
"poNumbers": [
"PO-2025-4567",
"PO-2025-5678"
],
"customerPoFields": [
{
"deliveryNumber": "DN-345678",
"deliveryReference": "DEL-REF-002",
"orderReference": "ORD-REF-001"
}
],
"pointOfContact": {
"alert": false,
"email": "[email protected]",
"name": "John Doe",
"phone": "+19999999999"
}
},
"earliestAppointmentTime": "2026-07-20T05:00:00",
"externalAddressId": "200",
"latestAppointmentTime": "2026-07-20T06: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"
}
],
"postalCode": "47408",
"referenceNumbers": [
"DEL-REF-001",
"DEL-REF-002",
"TRK-789456123",
"TRK-890123456"
],
"sequence": 2,
"state": "IN",
"stopReferenceId": "1529659852",
"stopType": "delivery",
"trackingNumber": "TRK-890123456",
"unloadTimeInMinutes": 150,
"wantTime": "2026-07-21T13: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"
}
}'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 |
- It is possible to create multiple loads with the same Load Number (Bill Of Lading). Though multiple loads can have the same Load Number, their Load ID will be unique.
- It is recommended to provide the latitude & longitude of the stop for accurate geofencing. If not provided, they will be geocoded from stop address.
- The only accepted format of lat/long by FourKites® is the "Decimal Degrees" format. For example: 41.8781 (lat), -87.6298 (long).
- If geofencePoints for polygon geofence are provided, it will be used for geofencing logic. If geofencePoints are not provided, circular geofence with the radius specified in stop's geofenceRadius will be used. In the absence of both geofencePoints & geofenceRadius, FourKites® will use circular geofence with its internal default radius.
- Tracking Info can be updated by the carrier or shipper after the load is created.
- Driver Phone is required if CarrierLink mobile app for Android & iPhone is used for tracking.
- 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.
- Appointment times cannot be more than 4 days in the past from the current time, and should be provided in the stop's local timezone.
- If a stop has to be created as a terminal, please provide the following: "stopType" : "transfer"
- Setting the 'Priority' as 'Hot' will mark the load as 'Hot' load.
- Pass the displayLoadNumber parameter to show a number other than the loadNumber on the load card.
- For Air Loads, you must provide either IATA or ICAO airport codes for the externalAddressId parameter and the departingFlightNumber parameter should contain a different flight number for every airport stop.
- If a stop has to be created as an Origin Airport, Hub Aiport, & Destination Airport, please provide the following: "stopType": "originAirport" / "hubAirport" / "destinationAirport".
- By default, FourKites will ingest the value given in the "Weight" field in Pounds(lbs) and not Kilograms(Kgs). Hence, the value for the "Weight" field under the pallet section at the stop level should be converted from Kilograms (Kgs) to Pounds (lbs) while creating the load. Also, if you add units like "Kgs" and "lbs" as part of the "Weight" field, it will be displayed on the load card as well.
Load Mode Detection
"additionalData": { "modeDetails":{ "shipperModes": "", "carrierModes": "" } },Now, Shippers, 3PLs and Carriers have the ability to set the Load Mode (TL, LTL, Rail, Ocean or Parcel) of a load. The load creators can specify the load mode using the Load Create and Load Update API and carriers can specify the load mode using Truck Assignment API, Dispatcher update API, Locations API and Batch Locations API.
However, if both the load creator and carrier sends different load modes, we can define a rank order of which source is the most trustworthy.
For example, let's consider the priority is set as Carrier > Shipper > FourKites. Carrier sends mode as “TL” while shipper sends it as “LTL” and FK detects it as “LTL”. In this case the load will track as TL only.
- By default, we will track the load mode detected by FourKites but to set a ranking order, please speak to your CSM at FourKites.
- The master sequence number and the master reference number parameters are applicable only for the users creating a consignment load.
- masterSequenceNumber is the Consignment Sequence Number which corresponds to the leg for each load.
- masterReferenceNumber is the Consignment Reference Number which is the identifier for all the loads that are a part of a consignment group.
- Please reach out to your FourKites® Customer Success Manager if you would like to learn more about Consignment Pooling.
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. |
400 | Address Should contain Address line 1 or city, state and country or Latitude and Longitude. | If you're sending only Latitude & Longitude co-ordinates for an address, check if the Process Lat/Long From API flag is enabled for your company. Reach out to your customer success manager at Fourkites. |
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. |