Port-to-Port
7 min
Create a Port-to-Port load with Port of Loading and Port of Discharge stop types -- or, a purely ocean leg.
⚠️ Important Update:
The Pallets structure is being deprecated. Please transition to for product details. Learn more
Note: This documentation provides load mode-specific API payloads for this transportation type. For a comprehensive reference of all available API parameters that can be applied to these payloads, including parameters across all load modes, please refer to the Create Shipment / Update Shipment documentation.
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.
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.
Supporting Document: Create Shipment
Rate Limit
1 request per second
Format Supported
JSON
Authenticated Resource
API Key
For more information on Authentication, click here.
FourKites does not limit customers from creating more than one load with the same load number or PRO number. When making POST requests to create a load, please ensure that it is the first time that specific load number has been used to create a load. If multiple POST requests are made with the same data, FourKites will generate duplicate loads
It's mandatory to send either bookingNumber or billOfLading while creating port-to-port loads.
Production
POST
https://api.fourkites.com/api/v1/tracking
curl --location --request POST 'https://api.fourkites.com/api/v1/tracking' \
--header 'Content-Type: application/json' \
--header 'apikey: REPLACE_KEY_VALUE' \
--data-raw '{
"trackingInfo": {
"driverPhone": "",
"truckNumber": "",
"vesselName": "",
"imo": "",
"mmsi": "",
"containerNumber": "OOLU4404637"
},
"containerInfo": {
"containerNumber": "OOLU4404637"
},
"load": {
"loadNumber": "stop_completion_1",
"priority": "normal",
"operatingCarrierScac": null,
"carrier": "1234",
"carrierName": "",
"carrierPermalink": "oceancarrier",
"products": [],
"bookingNumber": "",
"trackingNumber": "",
"billOfLading": "GOA230437868",
"referenceNumbers": [],
"stops": [
{
"stopType": "portOfLoading",
"customer": {
"id": null,
"originalCustomerId": null,
"poNumbers": []
},
"addressLine1": "",
"city": "",
"state": "",
"country": "",
"postalCode": "",
"latitude": "",
"longitude": "",
"geofencePoints": [],
"externalAddressId": "INMAA",
"appointmentTime": null,
"stopReferenceId": "",
"earliestAppointmentTime": null,
"latestAppointmentTime": null,
"estimatedDepartureTime": "2023-07-20T06:00:00",
"wantTime": null,
"productLineItems": [
{
"productId": "0123456",
"productName": "Ocean Freight Item",
"productDescription": "Port-to-port ocean shipment item",
"productCategory": "General Freight",
"quantity": 25,
"measurementUnitCode": "PCE",
"netWeight": 44.8,
"weightUnit": "KGM",
"unitCost": 25.0,
"currencyCode": "USD",
"extendedCost": 625.00,
"freightCost": 20.00,
"additionalCharges": 5.00,
"tariffCost": 2.50,
"fourKitesCalculatedTariffCost": 2.50,
"totalLandedCost": 655.00,
"countryOfOrigin": "IN",
"harmonizedSystemCode": "8471499000",
"commodityTypeCode": "OCEAN_FREIGHT",
"htsusCode": "8471499000",
"orderNumber": "GOA230437868",
"deliveryNumber": "DN-INMAA",
"handlingUnitId": "PAL-INMAA",
"barcode": "PALINMAA",
"containerType": "pallet",
"gtin": "00012345678905",
"customerPartNumber": "22EE",
"supplierPartNumber": "22EE",
"manufacturerPartNumber": "MFG-22EE",
"itemNumber": "ITM-22EE",
"productUpc": "012345678905",
"deliveryReferences": ["OOLU4404637"],
"orderReferences": ["GOA230437868"],
"brandName": "Generic Ocean Freight Co",
"minimumTemperature": 0,
"maximumTemperature": 0,
"temperatureUnitCode": "cel",
"labelIdentifier": "LBL-22EE",
"productTrackingNumber": "OOLU4404637-1",
"deviceType": "RFID_TAG"
}
]
},
{
"stopType": "transshipmentPort",
"customer": {
"id": null,
"originalCustomerId": null,
"poNumbers": []
},
"addressLine1": "",
"city": "",
"state": "",
"country": "",
"postalCode": "",
"latitude": "",
"longitude": "",
"geofencePoints": [],
"externalAddressId": "SGSIN",
"appointmentTime": null,
"stopReferenceId": "",
"earliestAppointmentTime": "2023-07-21T06:00:00",
"latestAppointmentTime": "2023-07-21T16:00:00",
"wantTime": null,
"productLineItems": [
{
"productId": "0123456",
"productName": "Ocean Freight Item",
"productDescription": "Port-to-port ocean shipment item",
"productCategory": "General Freight",
"quantity": 25,
"measurementUnitCode": "PCE",
"netWeight": 44.8,
"weightUnit": "KGM",
"unitCost": 25.0,
"currencyCode": "USD",
"extendedCost": 625.00,
"freightCost": 20.00,
"additionalCharges": 5.00,
"tariffCost": 2.50,
"fourKitesCalculatedTariffCost": 2.50,
"totalLandedCost": 655.00,
"countryOfOrigin": "IN",
"harmonizedSystemCode": "8471499000",
"commodityTypeCode": "OCEAN_FREIGHT",
"htsusCode": "8471499000",
"orderNumber": "GOA230437868",
"deliveryNumber": "DN-INMAA",
"handlingUnitId": "PAL-INMAA",
"barcode": "PALINMAA",
"containerType": "pallet",
"gtin": "00012345678905",
"customerPartNumber": "22EE",
"supplierPartNumber": "22EE",
"manufacturerPartNumber": "MFG-22EE",
"itemNumber": "ITM-22EE",
"productUpc": "012345678905",
"deliveryReferences": ["OOLU4404637"],
"orderReferences": ["GOA230437868"],
"brandName": "Generic Ocean Freight Co",
"minimumTemperature": 0,
"maximumTemperature": 0,
"temperatureUnitCode": "cel",
"labelIdentifier": "LBL-22EE",
"productTrackingNumber": "OOLU4404637-1",
"deviceType": "RFID_TAG"
}
]
},
{
"stopType": "portOfDischarge",
"customer": {
"id": null,
"originalCustomerId": null,
"poNumbers": []
},
"addressLine1": "",
"city": "",
"state": "",
"country": "",
"postalCode": "",
"latitude": "",
"longitude": "",
"geofencePoints": [],
"externalAddressId": "USJAX",
"appointmentTime": "2024-03-31T16:00:00",
"stopReferenceId": "",
"earliestAppointmentTime": null,
"latestAppointmentTime": null,
"wantTime": null,
"productLineItems": [
{
"productId": "0123456",
"productName": "Ocean Freight Item",
"productDescription": "Port-to-port ocean shipment item",
"productCategory": "General Freight",
"quantity": 25,
"measurementUnitCode": "PCE",
"netWeight": 44.8,
"weightUnit": "KGM",
"unitCost": 25.0,
"currencyCode": "USD",
"extendedCost": 625.00,
"freightCost": 20.00,
"additionalCharges": 5.00,
"tariffCost": 2.50,
"fourKitesCalculatedTariffCost": 2.50,
"totalLandedCost": 655.00,
"countryOfOrigin": "IN",
"harmonizedSystemCode": "8471499000",
"commodityTypeCode": "OCEAN_FREIGHT",
"htsusCode": "8471499000",
"orderNumber": "GOA230437868",
"deliveryNumber": "DN-USJAX",
"handlingUnitId": "PAL-USJAX",
"barcode": "PALUSJAX",
"containerType": "pallet",
"gtin": "00012345678905",
"customerPartNumber": "22EE",
"supplierPartNumber": "22EE",
"manufacturerPartNumber": "MFG-22EE",
"itemNumber": "ITM-22EE",
"productUpc": "012345678905",
"deliveryReferences": ["OOLU4404637"],
"orderReferences": ["GOA230437868"],
"brandName": "Generic Ocean Freight Co",
"minimumTemperature": 0,
"maximumTemperature": 0,
"temperatureUnitCode": "cel",
"labelIdentifier": "LBL-22EE",
"productTrackingNumber": "OOLU4404637-3",
"deviceType": "QR_CODE"
}
]
}
]
}
}'Staging
POST
https://api-staging.fourkites.com/api/v1/tracking
curl --location --request POST 'https://api-staging.fourkites.com/api/v1/tracking' \
--header 'Content-Type: application/json' \
--header 'apikey: REPLACE_KEY_VALUE' \
--data-raw '{
"trackingInfo": {
"driverPhone": "",
"truckNumber": "",
"vesselName": "",
"imo": "",
"mmsi": "",
"containerNumber": "OOLU4404637"
},
"containerInfo": {
"containerNumber": "OOLU4404637"
},
"load": {
"loadNumber": "stop_completion_1",
"priority": "normal",
"operatingCarrierScac": null,
"carrier": "1234",
"carrierName": "",
"carrierPermalink": "oceancarrier",
"products": [],
"bookingNumber": "",
"trackingNumber": "",
"billOfLading": "GOA230437868",
"referenceNumbers": [],
"stops": [
{
"stopType": "portOfLoading",
"customer": {
"id": null,
"originalCustomerId": null,
"poNumbers": []
},
"addressLine1": "",
"city": "",
"state": "",
"country": "",
"postalCode": "",
"latitude": "",
"longitude": "",
"geofencePoints": [],
"externalAddressId": "INMAA",
"appointmentTime": null,
"stopReferenceId": "",
"earliestAppointmentTime": null,
"latestAppointmentTime": null,
"estimatedDepartureTime": "2023-07-20T06:00:00",
"wantTime": null,
"productLineItems": [
{
"productId": "0123456",
"productName": "Ocean Freight Item",
"productDescription": "Port-to-port ocean shipment item",
"productCategory": "General Freight",
"quantity": 25,
"measurementUnitCode": "PCE",
"netWeight": 44.8,
"weightUnit": "KGM",
"unitCost": 25.0,
"currencyCode": "USD",
"extendedCost": 625.00,
"freightCost": 20.00,
"additionalCharges": 5.00,
"tariffCost": 2.50,
"fourKitesCalculatedTariffCost": 2.50,
"totalLandedCost": 655.00,
"countryOfOrigin": "IN",
"harmonizedSystemCode": "8471499000",
"commodityTypeCode": "OCEAN_FREIGHT",
"htsusCode": "8471499000",
"orderNumber": "GOA230437868",
"deliveryNumber": "DN-INMAA",
"handlingUnitId": "PAL-INMAA",
"barcode": "PALINMAA",
"containerType": "pallet",
"gtin": "00012345678905",
"customerPartNumber": "22EE",
"supplierPartNumber": "22EE",
"manufacturerPartNumber": "MFG-22EE",
"itemNumber": "ITM-22EE",
"productUpc": "012345678905",
"deliveryReferences": ["OOLU4404637"],
"orderReferences": ["GOA230437868"],
"brandName": "Generic Ocean Freight Co",
"minimumTemperature": 0,
"maximumTemperature": 0,
"temperatureUnitCode": "cel",
"labelIdentifier": "LBL-22EE",
"productTrackingNumber": "OOLU4404637-1",
"deviceType": "RFID_TAG"
}
]
},
{
"stopType": "transshipmentPort",
"customer": {
"id": null,
"originalCustomerId": null,
"poNumbers": []
},
"addressLine1": "",
"city": "",
"state": "",
"country": "",
"postalCode": "",
"latitude": "",
"longitude": "",
"geofencePoints": [],
"externalAddressId": "SGSIN",
"appointmentTime": null,
"stopReferenceId": "",
"earliestAppointmentTime": "2023-07-21T06:00:00",
"latestAppointmentTime": "2023-07-21T16:00:00",
"wantTime": null,
"productLineItems": [
{
"productId": "0123456",
"productName": "Ocean Freight Item",
"productDescription": "Port-to-port ocean shipment item",
"productCategory": "General Freight",
"quantity": 25,
"measurementUnitCode": "PCE",
"netWeight": 44.8,
"weightUnit": "KGM",
"unitCost": 25.0,
"currencyCode": "USD",
"extendedCost": 625.00,
"freightCost": 20.00,
"additionalCharges": 5.00,
"tariffCost": 2.50,
"fourKitesCalculatedTariffCost": 2.50,
"totalLandedCost": 655.00,
"countryOfOrigin": "IN",
"harmonizedSystemCode": "8471499000",
"commodityTypeCode": "OCEAN_FREIGHT",
"htsusCode": "8471499000",
"orderNumber": "GOA230437868",
"deliveryNumber": "DN-INMAA",
"handlingUnitId": "PAL-INMAA",
"barcode": "PALINMAA",
"containerType": "pallet",
"gtin": "00012345678905",
"customerPartNumber": "22EE",
"supplierPartNumber": "22EE",
"manufacturerPartNumber": "MFG-22EE",
"itemNumber": "ITM-22EE",
"productUpc": "012345678905",
"deliveryReferences": ["OOLU4404637"],
"orderReferences": ["GOA230437868"],
"brandName": "Generic Ocean Freight Co",
"minimumTemperature": 0,
"maximumTemperature": 0,
"temperatureUnitCode": "cel",
"labelIdentifier": "LBL-22EE",
"productTrackingNumber": "OOLU4404637-1",
"deviceType": "RFID_TAG"
}
]
},
{
"stopType": "portOfDischarge",
"customer": {
"id": null,
"originalCustomerId": null,
"poNumbers": []
},
"addressLine1": "",
"city": "",
"state": "",
"country": "",
"postalCode": "",
"latitude": "",
"longitude": "",
"geofencePoints": [],
"externalAddressId": "USJAX",
"appointmentTime": "2024-03-31T16:00:00",
"stopReferenceId": "",
"earliestAppointmentTime": null,
"latestAppointmentTime": null,
"wantTime": null,
"productLineItems": [
{
"productId": "0123456",
"productName": "Ocean Freight Item",
"productDescription": "Port-to-port ocean shipment item",
"productCategory": "General Freight",
"quantity": 25,
"measurementUnitCode": "PCE",
"netWeight": 44.8,
"weightUnit": "KGM",
"unitCost": 25.0,
"currencyCode": "USD",
"extendedCost": 625.00,
"freightCost": 20.00,
"additionalCharges": 5.00,
"tariffCost": 2.50,
"fourKitesCalculatedTariffCost": 2.50,
"totalLandedCost": 655.00,
"countryOfOrigin": "IN",
"harmonizedSystemCode": "8471499000",
"commodityTypeCode": "OCEAN_FREIGHT",
"htsusCode": "8471499000",
"orderNumber": "GOA230437868",
"deliveryNumber": "DN-USJAX",
"handlingUnitId": "PAL-USJAX",
"barcode": "PALUSJAX",
"containerType": "pallet",
"gtin": "00012345678905",
"customerPartNumber": "22EE",
"supplierPartNumber": "22EE",
"manufacturerPartNumber": "MFG-22EE",
"itemNumber": "ITM-22EE",
"productUpc": "012345678905",
"deliveryReferences": ["OOLU4404637"],
"orderReferences": ["GOA230437868"],
"brandName": "Generic Ocean Freight Co",
"minimumTemperature": 0,
"maximumTemperature": 0,
"temperatureUnitCode": "cel",
"labelIdentifier": "LBL-22EE",
"productTrackingNumber": "OOLU4404637-3",
"deviceType": "QR_CODE"
}
]
}
]
}
}'Azure - Production
POST
https://api.ng.fourkites.com/api/v1/tracking
import http.client
import json
conn = http.client.HTTPSConnection("api.ng.fourkites.com")
payload = json.dumps({
"trackingInfo": {
"driverPhone": "",
"truckNumber": "",
"vesselName": "",
"imo": "",
"mmsi": "",
"containerNumber": "OOLU4404637"
},
"containerInfo": {
"containerNumber": "OOLU4404637"
},
"load": {
"loadNumber": "stop_completion_1",
"priority": "normal",
"operatingCarrierScac": None,
"carrier": "1234",
"carrierName": "",
"carrierPermalink": "oceancarrier",
"products": [],
"bookingNumber": "",
"trackingNumber": "",
"billOfLading": "GOA230437868",
"referenceNumbers": [],
"stops": [
{
"stopType": "portOfLoading",
"customer": {
"id": None,
"originalCustomerId": None,
"poNumbers": []
},
"addressLine1": "",
"city": "",
"state": "",
"country": "",
"postalCode": "",
"latitude": "",
"longitude": "",
"geofencePoints": [],
"externalAddressId": "INMAA",
"appointmentTime": None,
"stopReferenceId": "",
"earliestAppointmentTime": None,
"latestAppointmentTime": None,
"estimatedDepartureTime": "2023-07-20T06:00:00",
"wantTime": None
},
{
"stopType": "transshipmentPort",
"customer": {
"id": None,
"originalCustomerId": None,
"poNumbers": []
},
"addressLine1": "",
"city": "",
"state": "",
"country": "",
"postalCode": "",
"latitude": "",
"longitude": "",
"geofencePoints": [],
"externalAddressId": "SGSIN",
"appointmentTime": None,
"stopReferenceId": "",
"earliestAppointmentTime": "2023-07-21T06:00:00",
"latestAppointmentTime": "2023-07-21T16:00:00",
"wantTime": None
},
{
"stopType": "portOfDischarge",
"customer": {
"id": None,
"originalCustomerId": None,
"poNumbers": []
},
"addressLine1": "",
"city": "",
"state": "",
"country": "",
"postalCode": "",
"latitude": "",
"longitude": "",
"geofencePoints": [],
"externalAddressId": "USJAX",
"appointmentTime": "2024-03-31T16:00:00",
"stopReferenceId": "",
"earliestAppointmentTime": None,
"latestAppointmentTime": None,
"wantTime": None
}
]
}
})
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"))Azure - Staging
POST
https://api-staging.ng.fourkites.com/api/v1/tracking
import http.client
import json
conn = http.client.HTTPSConnection("api-staging.ng.fourkites.com")
payload = json.dumps({
"trackingInfo": {
"driverPhone": "",
"truckNumber": "",
"vesselName": "",
"imo": "",
"mmsi": "",
"containerNumber": "OOLU4404637"
},
"containerInfo": {
"containerNumber": "OOLU4404637"
},
"load": {
"loadNumber": "stop_completion_1",
"priority": "normal",
"operatingCarrierScac": None,
"carrier": "1234",
"carrierName": "",
"carrierPermalink": "oceancarrier",
"products": [],
"bookingNumber": "",
"trackingNumber": "",
"billOfLading": "GOA230437868",
"referenceNumbers": [],
"stops": [
{
"stopType": "portOfLoading",
"customer": {
"id": None,
"originalCustomerId": None,
"poNumbers": []
},
"addressLine1": "",
"city": "",
"state": "",
"country": "",
"postalCode": "",
"latitude": "",
"longitude": "",
"geofencePoints": [],
"externalAddressId": "INMAA",
"appointmentTime": None,
"stopReferenceId": "",
"earliestAppointmentTime": None,
"latestAppointmentTime": None,
"estimatedDepartureTime": "2023-07-20T06:00:00",
"wantTime": None
},
{
"stopType": "transshipmentPort",
"customer": {
"id": None,
"originalCustomerId": None,
"poNumbers": []
},
"addressLine1": "",
"city": "",
"state": "",
"country": "",
"postalCode": "",
"latitude": "",
"longitude": "",
"geofencePoints": [],
"externalAddressId": "SGSIN",
"appointmentTime": None,
"stopReferenceId": "",
"earliestAppointmentTime": "2023-07-21T06:00:00",
"latestAppointmentTime": "2023-07-21T16:00:00",
"wantTime": None
},
{
"stopType": "portOfDischarge",
"customer": {
"id": None,
"originalCustomerId": None,
"poNumbers": []
},
"addressLine1": "",
"city": "",
"state": "",
"country": "",
"postalCode": "",
"latitude": "",
"longitude": "",
"geofencePoints": [],
"externalAddressId": "USJAX",
"appointmentTime": "2024-03-31T16:00:00",
"stopReferenceId": "",
"earliestAppointmentTime": None,
"latestAppointmentTime": None,
"wantTime": None
}
]
}
})
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"))