Update Shipment (Full)
4 min
In order to update a load, you can use the PATCH verb and specify the unique FourKites generated tracking_id in the URL path. This will allow the updates to take place on the load.
Rate Limit
60 requests per minute
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.
PARAMS
simpleUpdate | true If set to "true" then FourKites will assume the full representation of the load is present and will detect updates by reviewing each field |
|---|
Production
PATCH
https://api.fourkites.com/api/v1/tracking/432728294?simpleUpdate=true
curl --location --request PATCH 'https://api.fourkites.com/api/v1/tracking/432728294?simpleUpdate=true' \
--header 'Content-Type: application/json' \
--header 'apikey: REPLACE_KEY_VALUE' \
--data-raw '{
"trackingInfo": {
"driverPhone": "",
"trailerNumber": "2106030123"
},
"load": {
"loadNumber": "Test-appointment",
"nonTrackable": false,
"priority": "hot",
"originalScac": "csapitl",
"carrierPermalink": "carrierseranew",
"carrierName": "carrierseranew",
"tags": [],
"shipper": null,
"products": [],
"referenceNumbers": [
"2256492",
"ProductType: Bulk"
],
"stops": [
{
"stopType": "delivery",
"stopReferenceId": "xyz",
"customer": {
"id": "customer-company-6439",
"poNumbers": [
"po-pickup-1"
]
},
"completeAddress": "976 County Road 394, Delphos, KS, US",
"addressLine1": "976 County Road 394",
"city": "Delphos",
"state": "KS",
"county": "Cloud",
"loadingType": "Drop-HOOK",
"country": "US",
"postalCode": "67436",
"latitude": 39.31831267307849,
"longitude": -97.7440669937134,
"geofencePoints": [],
"appointmentTime": "2024-12-23T20:00:00.000Z",
"wantTime": null,
"earliestWantTime": null,
"latestWantTime": null,
"transportationMode": "truck",
"addressType": "",
"useLocalLatLng": true,
"pallets": [
{
"number": 1,
"parts": [
{
"customerPartNumber": "Mat1",
"quantity": 1000,
"shipperPartNumber": "Mat1",
"weight": "3072.0 LB",
"description": "Hello, This is description of Mat1"
}
]
}
]
},
{
"stopType": "pickup",
"stopReferenceId": "abc",
"customer": {
"id": "customer-company-6439",
"originalCustomerId": "",
"poNumbers": [
"po-delivery-1",
"po-delivery-2"
]
},
"name": "CypressSt",
"loadingType": "drop-hook",
"externalAddressId": "ZACHARY",
"completeAddress": null,
"addressLine1": null,
"city": null,
"state": null,
"country": null,
"postalCode": null,
"latitude": null,
"longitude": null,
"geofencePoints": [],
"appointmentTime": "2024-12-13T20:00:00.000Z",
"wantTime": "2024-12-30T20:00:00.000Z",
"earliestWantTime": null,
"latestWantTime": null,
"transportationMode": "Air",
"addressType": "",
"useLocalLatLng": true,
"pallets": [
{
"number": 1,
"parts": [
{
"customerPartNumber": "Mat2",
"quantity": 10,
"shipperPartNumber": "Mat2",
"weight": "3072.0 LB",
"description": "Hello, This is description of Mat2"
}
]
}
]
}
]
},
"simpleUpdate": true
}'Staging
PATCH
https://api-staging.fourkites.com/api/v1/tracking/432728294?simpleUpdate=true
curl --location --request PATCH 'https://api-staging.fourkites.com/api/v1/tracking/432728294?simpleUpdate=true' \
--header 'Content-Type: application/json' \
--header 'apikey: REPLACE_KEY_VALUE' \
--data-raw '{
"trackingInfo": {
"driverPhone": "",
"trailerNumber": "2106030123"
},
"load": {
"loadNumber": "Test-appointment",
"nonTrackable": false,
"priority": "hot",
"originalScac": "csapitl",
"carrierPermalink": "carrierseranew",
"carrierName": "carrierseranew",
"tags": [],
"shipper": null,
"products": [],
"referenceNumbers": [
"2256492",
"ProductType: Bulk"
],
"stops": [
{
"stopType": "delivery",
"stopReferenceId": "xyz",
"customer": {
"id": "customer-company-6439",
"poNumbers": [
"po-pickup-1"
]
},
"completeAddress": "976 County Road 394, Delphos, KS, US",
"addressLine1": "976 County Road 394",
"city": "Delphos",
"state": "KS",
"county": "Cloud",
"loadingType": "Drop-HOOK",
"country": "US",
"postalCode": "67436",
"latitude": 39.31831267307849,
"longitude": -97.7440669937134,
"geofencePoints": [],
"appointmentTime": "2024-12-23T20:00:00.000Z",
"wantTime": null,
"earliestWantTime": null,
"latestWantTime": null,
"transportationMode": "truck",
"addressType": "",
"useLocalLatLng": true,
"pallets": [
{
"number": 1,
"parts": [
{
"customerPartNumber": "Mat1",
"quantity": 1000,
"shipperPartNumber": "Mat1",
"weight": "3072.0 LB",
"description": "Hello, This is description of Mat1"
}
]
}
]
},
{
"stopType": "pickup",
"stopReferenceId": "abc",
"customer": {
"id": "customer-company-6439",
"originalCustomerId": "",
"poNumbers": [
"po-delivery-1",
"po-delivery-2"
]
},
"name": "CypressSt",
"loadingType": "drop-hook",
"externalAddressId": "ZACHARY",
"completeAddress": null,
"addressLine1": null,
"city": null,
"state": null,
"country": null,
"postalCode": null,
"latitude": null,
"longitude": null,
"geofencePoints": [],
"appointmentTime": "2024-12-13T20:00:00.000Z",
"wantTime": "2024-12-30T20:00:00.000Z",
"earliestWantTime": null,
"latestWantTime": null,
"transportationMode": "Air",
"addressType": "",
"useLocalLatLng": true,
"pallets": [
{
"number": 1,
"parts": [
{
"customerPartNumber": "Mat2",
"quantity": 10,
"shipperPartNumber": "Mat2",
"weight": "3072.0 LB",
"description": "Hello, This is description of Mat2"
}
]
}
]
}
]
},
"simpleUpdate": true
}'