Parcel
4 min
To update your Parcel load without any hassle, follow the instructions given within this document.
If you receive a server error (5xx error code), please try again a few times. It's best to wait a little longer between each retry attempt. Try at least 3-5 times before giving up, as many server issues resolve themselves quickly.
Rate Limit
1 request per second
Format Supported
JSON
Authenticated Resource
API Key
For more information on Authentication, click here.
The FourKites internal loadId that is returned during load creation should be added to the endpoint to update the load. Click on the load that you would like to update to get the FourKites Internal LoadId as shown in the image below.
Production
PATCH
https://api.fourkites.com/api/v1/tracking/417537760
import http.client
import json
conn = http.client.HTTPSConnection("api.fourkites.com")
payload = json.dumps({
"simpleUpdate": "True",
"trackingInfo": {
"driverPhone": "",
"truckNumber": "",
"trailerNumber": ""
},
"additionalData": {
"modeDetails": {
"shipperModes": "Parcel"
}
},
"load": {
"carrier": "cc79",
"haulType": [
"outbound_load"
],
"simultaneousTrackingReferenceNumber": "simul123",
"masterSequenceNumber": None,
"simultaneousTrackingSequenceNumber": 1,
"trackingNumber": "1122334455",
"loadNumber": "TestParcelUpdate",
"priority": "normal",
"referenceNumbers": [
"LID:3454353,43534535",
"BOL:5343,764345",
"TMSID:L23432",
"L34535",
"SCAC:SER1"
],
"relayLoad": False,
"stops": [
{
"addressLine1": "500 West Madison Street",
"addressLine2": "Suite 3300",
"city": "Chicago",
"country": "US",
"name": "FourKites HQ",
"postalCode": "60611",
"referenceNumbers": [
"STNR:D43",
"BOL:43489495",
"43489495",
"SO:G024307300"
],
"sequence": 1,
"state": "LA",
"stopReferenceId": "D43",
"stopType": "pickup",
"unloadTimeInMinutes": 120,
"timeInUtc": True,
"customer": {
"id": None,
"poNumbers": [
"04112024"
],
"pointOfContact": {
"email": "[email protected]",
"phone": "545454"
}
},
"earliestAppointmentTime": "2024-04-21T19:16:15",
"latestAppointmentTime": "2024-04-21T19:16:15",
"earliestWantTime": "2024-04-21T16:31:29",
"latestWantTime": "2024-04-21T16:31:29",
"pallets": [
{
"parts": [
{
"quantity": "CARTON-WMS",
"shipperPartNumber": "1KYGQ",
"weight": "7.998"
},
{
"quantity": "CARTON-WMS",
"shipperPartNumber": "1KYGR",
"weight": "36.800"
}
]
}
],
"productLineItems": [
{
"productId": "0123456",
"productName": "Parcel Item",
"productDescription": "Parcel shipment item",
"productCategory": "General Merchandise",
"quantity": 5,
"measurementUnitCode": "PCE",
"netWeight": 44.8,
"weightUnit": "KGM",
"unitCost": 25,
"currencyCode": "USD",
"extendedCost": 125,
"freightCost": 10,
"bestBeforeDate": "2024-04-25T00:00:00Z",
"additionalCharges": 5,
"tariffCost": 2.5,
"fourKitesCalculatedTariffCost": 2.5,
"totalLandedCost": 132.5,
"countryOfOrigin": "US",
"harmonizedSystemCode": "4819500000",
"commodityTypeCode": "GENERAL_MERCHANDISE",
"htsusCode": "4819500000",
"orderNumber": "04112024",
"deliveryNumber": "DN-D43",
"handlingUnitId": "1KYGQ",
"barcode": "1KYGQ",
"containerType": "box",
"gtin": "00012345678905",
"customerPartNumber": "1KYGQ",
"supplierPartNumber": "1KYGQ",
"manufacturerPartNumber": "MFG-1KYGQ",
"itemNumber": "ITM-1KYGQ",
"productUpc": "012345678905",
"deliveryReferences": [
"BOL:43489495"
],
"orderReferences": [
"SO:G024307300"
],
"brandName": "Generic Merchandise Co",
"minimumTemperature": 0,
"maximumTemperature": 0,
"temperatureUnitCode": "cel",
"labelIdentifier": "LBL-1KYGQ",
"productTrackingNumber": "1122334455",
"deviceType": "RFID_TAG"
}
]
},
{
"addressLine1": "425 South Palos Verdes Street",
"addressLine2": "",
"city": "Los Angeles",
"country": "US",
"customer": {
"id": 1453242,
"poNumbers": [
"04112024",
"04112024"
],
"pointOfContact": {
"email": "[email protected]",
"phone": "1234456734"
}
},
"earliestAppointmentTime": "2024-04-22T19:16:15",
"latestAppointmentTime": "2024-04-22T19:16:15",
"earliestWantTime": "2024-04-22T16:31:29",
"latestWantTime": "2024-04-22T16:31:29",
"name": "Hammond, LA DC",
"pallets": [
{
"billOfLading": 43489495,
"number": "00001",
"parts": [
{
"quantity": "CARTON-WMS",
"shipperPartNumber": "1KYGQ",
"weight": "7.998"
},
{
"quantity": "CARTON-WMS",
"shipperPartNumber": "1KYGR",
"weight": "36.800"
}
]
}
],
"postalCode": "70401",
"referenceNumbers": [
"STNR:D43",
"BOL:43489495",
"43489495",
"SO:G024307300"
],
"sequence": 2,
"state": "LA",
"stopReferenceId": "D41",
"stopType": "delivery",
"unloadTimeInMinutes": 120,
"timeInUtc": True,
"productLineItems": [
{
"productId": "0123456",
"productName": "Parcel Item",
"productDescription": "Parcel shipment item",
"productCategory": "General Merchandise",
"quantity": 5,
"measurementUnitCode": "PCE",
"netWeight": 44.8,
"weightUnit": "KGM",
"unitCost": 25,
"currencyCode": "USD",
"extendedCost": 125,
"freightCost": 10,
"additionalCharges": 5,
"tariffCost": 2.5,
"fourKitesCalculatedTariffCost": 2.5,
"totalLandedCost": 132.5,
"countryOfOrigin": "US",
"harmonizedSystemCode": "4819500000",
"commodityTypeCode": "GENERAL_MERCHANDISE",
"htsusCode": "4819500000",
"orderNumber": "04112024",
"deliveryNumber": "DN-D41",
"handlingUnitId": "00001",
"barcode": "1KYGR",
"containerType": "box",
"gtin": "00012345678912",
"customerPartNumber": "1KYGR",
"supplierPartNumber": "1KYGR",
"manufacturerPartNumber": "MFG-1KYGR",
"itemNumber": "ITM-1KYGR",
"productUpc": "012345678912",
"deliveryReferences": [
"BOL:43489495"
],
"orderReferences": [
"SO:G024307300"
],
"brandName": "Generic Merchandise Co",
"minimumTemperature": 0,
"maximumTemperature": 0,
"temperatureUnitCode": "cel",
"labelIdentifier": "LBL-1KYGR",
"productTrackingNumber": "1122334455",
"deviceType": "QR_CODE"
}
]
}
]
}
})
headers = {
'Content-Type': 'application/json',
'apikey': 'REPLACE_KEY_VALUE'
}
conn.request("PATCH", "/api/v1/tracking/417537760", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))Staging
PATCH
https://api-staging.fourkites.com/api/v1/tracking/417537760
import http.client
import json
conn = http.client.HTTPSConnection("api-staging.fourkites.com")
payload = json.dumps({
"simpleUpdate": "True",
"trackingInfo": {
"driverPhone": "",
"truckNumber": "",
"trailerNumber": ""
},
"additionalData": {
"modeDetails": {
"shipperModes": "Parcel"
}
},
"load": {
"carrier": "cc79",
"haulType": [
"outbound_load"
],
"simultaneousTrackingReferenceNumber": "simul123",
"masterSequenceNumber": None,
"simultaneousTrackingSequenceNumber": 1,
"trackingNumber": "1122334455",
"loadNumber": "TestParcelUpdate",
"priority": "normal",
"referenceNumbers": [
"LID:3454353,43534535",
"BOL:5343,764345",
"TMSID:L23432",
"L34535",
"SCAC:SER1"
],
"relayLoad": False,
"stops": [
{
"addressLine1": "500 West Madison Street",
"addressLine2": "Suite 3300",
"city": "Chicago",
"country": "US",
"name": "FourKites HQ",
"postalCode": "60611",
"referenceNumbers": [
"STNR:D43",
"BOL:43489495",
"43489495",
"SO:G024307300"
],
"sequence": 1,
"state": "LA",
"stopReferenceId": "D43",
"stopType": "pickup",
"unloadTimeInMinutes": 120,
"timeInUtc": True,
"customer": {
"id": None,
"poNumbers": [
"04112024"
],
"pointOfContact": {
"email": "[email protected]",
"phone": "545454"
}
},
"earliestAppointmentTime": "2024-04-21T19:16:15",
"latestAppointmentTime": "2024-04-21T19:16:15",
"earliestWantTime": "2024-04-21T16:31:29",
"latestWantTime": "2024-04-21T16:31:29",
"pallets": [
{
"parts": [
{
"quantity": "CARTON-WMS",
"shipperPartNumber": "1KYGQ",
"weight": "7.998"
},
{
"quantity": "CARTON-WMS",
"shipperPartNumber": "1KYGR",
"weight": "36.800"
}
]
}
],
"productLineItems": [
{
"productId": "0123456",
"productName": "Parcel Item",
"productDescription": "Parcel shipment item",
"productCategory": "General Merchandise",
"quantity": 5,
"measurementUnitCode": "PCE",
"netWeight": 44.8,
"weightUnit": "KGM",
"unitCost": 25,
"currencyCode": "USD",
"extendedCost": 125,
"freightCost": 10,
"bestBeforeDate": "2024-04-25T00:00:00Z",
"additionalCharges": 5,
"tariffCost": 2.5,
"fourKitesCalculatedTariffCost": 2.5,
"totalLandedCost": 132.5,
"countryOfOrigin": "US",
"harmonizedSystemCode": "4819500000",
"commodityTypeCode": "GENERAL_MERCHANDISE",
"htsusCode": "4819500000",
"orderNumber": "04112024",
"deliveryNumber": "DN-D43",
"handlingUnitId": "1KYGQ",
"barcode": "1KYGQ",
"containerType": "box",
"gtin": "00012345678905",
"customerPartNumber": "1KYGQ",
"supplierPartNumber": "1KYGQ",
"manufacturerPartNumber": "MFG-1KYGQ",
"itemNumber": "ITM-1KYGQ",
"productUpc": "012345678905",
"deliveryReferences": [
"BOL:43489495"
],
"orderReferences": [
"SO:G024307300"
],
"brandName": "Generic Merchandise Co",
"minimumTemperature": 0,
"maximumTemperature": 0,
"temperatureUnitCode": "cel",
"labelIdentifier": "LBL-1KYGQ",
"productTrackingNumber": "1122334455",
"deviceType": "RFID_TAG"
}
]
},
{
"addressLine1": "425 South Palos Verdes Street",
"addressLine2": "",
"city": "Los Angeles",
"country": "US",
"customer": {
"id": 1453242,
"poNumbers": [
"04112024",
"04112024"
],
"pointOfContact": {
"email": "[email protected]",
"phone": "1234456734"
}
},
"earliestAppointmentTime": "2024-04-22T19:16:15",
"latestAppointmentTime": "2024-04-22T19:16:15",
"earliestWantTime": "2024-04-22T16:31:29",
"latestWantTime": "2024-04-22T16:31:29",
"name": "Hammond, LA DC",
"pallets": [
{
"billOfLading": 43489495,
"number": "00001",
"parts": [
{
"quantity": "CARTON-WMS",
"shipperPartNumber": "1KYGQ",
"weight": "7.998"
},
{
"quantity": "CARTON-WMS",
"shipperPartNumber": "1KYGR",
"weight": "36.800"
}
]
}
],
"postalCode": "70401",
"referenceNumbers": [
"STNR:D43",
"BOL:43489495",
"43489495",
"SO:G024307300"
],
"sequence": 2,
"state": "LA",
"stopReferenceId": "D41",
"stopType": "delivery",
"unloadTimeInMinutes": 120,
"timeInUtc": True,
"productLineItems": [
{
"productId": "0123456",
"productName": "Parcel Item",
"productDescription": "Parcel shipment item",
"productCategory": "General Merchandise",
"quantity": 5,
"measurementUnitCode": "PCE",
"netWeight": 44.8,
"weightUnit": "KGM",
"unitCost": 25,
"currencyCode": "USD",
"extendedCost": 125,
"freightCost": 10,
"additionalCharges": 5,
"tariffCost": 2.5,
"fourKitesCalculatedTariffCost": 2.5,
"totalLandedCost": 132.5,
"countryOfOrigin": "US",
"harmonizedSystemCode": "4819500000",
"commodityTypeCode": "GENERAL_MERCHANDISE",
"htsusCode": "4819500000",
"orderNumber": "04112024",
"deliveryNumber": "DN-D41",
"handlingUnitId": "00001",
"barcode": "1KYGR",
"containerType": "box",
"gtin": "00012345678912",
"customerPartNumber": "1KYGR",
"supplierPartNumber": "1KYGR",
"manufacturerPartNumber": "MFG-1KYGR",
"itemNumber": "ITM-1KYGR",
"productUpc": "012345678912",
"deliveryReferences": [
"BOL:43489495"
],
"orderReferences": [
"SO:G024307300"
],
"brandName": "Generic Merchandise Co",
"minimumTemperature": 0,
"maximumTemperature": 0,
"temperatureUnitCode": "cel",
"labelIdentifier": "LBL-1KYGR",
"productTrackingNumber": "1122334455",
"deviceType": "QR_CODE"
}
]
}
]
}
})
headers = {
'Content-Type': 'application/json',
'apikey': 'REPLACE_KEY_VALUE'
}
conn.request("PATCH", "/api/v1/tracking/417537760", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))