FourKites
App · 24 actions
Track truckload, LTL, ocean, rail, air and parcel shipments in FourKites: list and read shipments with their ETAs, stops and positions, create truckload shipments, share tracking links, comment, get documents, send carrier updates, look up orders and deliveries, manage dock appointments, and start workflows when a shipment is created, moves, arrives, departs, changes ETA or is delivered.
Actions
| Action | What it does |
|---|---|
| Add shipment comment | Add a comment to a shipment, shown in FourKites and, if you choose, to the driver in the CarrierLink app. |
| Assign truck and trailer | As the carrier, tell FourKites which truck, trailer, driver or tracking device carries a load, so it can start tracking. |
| Check order exists | Check whether an order number is in FourKites, and get its FourKites order ID for 'Get order tracking link'. |
| Create truckload shipment | Start tracking a truckload (TL) shipment from one pickup to one delivery, once its carrier has accepted it. |
| Delete shipments | Withdraw up to 100 shipments, for loads cancelled in your own system. |
| Find order | Find an order by its number, FourKites ID or customer reference, with its status, parties and counts of lines, shipments and deliveries. |
| Get API usage | Count the requests made with this API key each day, over the last 30 days at most, for every endpoint or one. |
| Get appointment slots | Get the open dock appointment slots for a load on one day, at the facility its appointment is with. |
| Get delivery | Get one delivery of an order by its delivery number, with its status, appointment, trailer, origin and destination. |
| Get delivery tracking link | Get a link anyone can open to follow one delivery. |
| Get order tracking link | Get a link anyone can open to follow an order and its deliveries. |
| Get shipment | Get one shipment with its status, ETA, last position, carrier, tags and every stop's appointment, arrival and departure. |
| Get shipment documents | Get a load's documents of one type, such as its proof of delivery or bill of lading, at the last delivery stop or a stop you choose. |
| Get shipment tracking link | Get a link anyone can open, without signing in, to follow a shipment and its ETA. |
| Get stop tracking link | Get a link anyone can open to follow a shipment and its ETA at one delivery stop, for the customer at that stop. |
| List shipments | List your shipments with their status, ETA, last position and stops, filtered by status, load or order number, or pickup, delivery or creation dates. |
| Mark shipments delivered | Mark up to 50 shipments as delivered, so FourKites stops tracking them. |
| Mark shipments hot | Mark up to 100 shipments as hot (top priority) in FourKites. |
| Record appointment check-in | Record when a load checked in at the facility for its appointment, when it checked out, or both. |
| Release appointment slot | Give back a slot held with 'Reserve appointment slot' that no appointment was booked in. |
| Reserve appointment slot | Hold a dock slot for a load for a while (30 minutes unless you say), then book it with 'Schedule appointment' or give it back with 'Release appointment slot'. |
| Schedule appointment | Book or move a load's dock appointment, into a slot you reserved or at a start and end time. |
| Send ETA update | As the carrier, give your estimated arrival at a load's destination. |
| Send location update | As the carrier, report where a load is now, by latitude and longitude. |
Add shipment comment
Add a comment to a shipment, shown in FourKites and, if you choose, to the driver in the CarrierLink app.
Inputs
- Shipment
shipment_idtextRequired - The shipment. Pick one, or give its FourKites shipment ID (digits) from an earlier step.
- Comment
commenttextRequired - The comment, up to 1,000 characters.
- Show to the driver
send_to_drivertrue/false - Also show it to the driver in CarrierLink.
Outputs
comment_idtext- FourKites' ID for the comment
shipment_idtext- The shipment
statustext- What FourKites said, such as Message posted successfully
Example output
{
"comment_id": "e87c35c6-84af-4615-b107-eb21ab3cd528",
"shipment_id": "471175003",
"status": "Message posted successfully"
}Assign truck and trailer
As the carrier, tell FourKites which truck, trailer, driver or tracking device carries a load, so it can start tracking. FourKites applies the update shortly after accepting it.
Inputs
- Load reference
load_referencetextRequired - The shipper's reference for the load: its load number, PRO number or another reference FourKites can match.
- Reference type
reference_typetext - What Load reference is. Leave empty to let FourKites match it against every reference on the shipper's loads.One of:
loadNumber(Load number),proNumber(PRO number),loadReferenceNumber(Load reference number),loadTrackingNumber(Tracking number),carrierReferenceNumber(Carrier reference number). - Bill-to code
bill_to_codetext - The shipper's bill-to code, as entered in FourKites Connect. Helps FourKites find the right shipper's load.
- Truck number
truck_numbertext - The tractor's number, as in your GPS or ELD portal.
- Trailer number
trailer_numbertext - The trailer's number, as in your GPS or ELD portal.
- Driver phone
driver_phonetext - The driver's mobile number with its country code, such as +13125555555.
- Driver name
driver_nametext - The driver's name.
- Tracking device ID
device_idtext - The GPS device's ID, as in your GPS or ELD portal.
- Operating carrier SCAC
operating_carrier_scactext - The SCAC of the carrier actually moving the load.
Outputs
accepted_attext- When FourKites accepted it (UTC)
messagetext- What FourKites said, such as API Request Accepted
request_idtext- FourKites' ID for the update, for its support team
statustext- 202 once FourKites has accepted it
Example output
{
"accepted_at": "2026-09-29T13:54:34.594806",
"message": "API Request Accepted",
"request_id": "1eec2aaa-0539-441a-b15a-d7272112f8a1",
"status": "202"
}Check order exists
Check whether an order number is in FourKites, and get its FourKites order ID for 'Get order tracking link'. Needs Order Visibility.
Inputs
- Order number
order_numbertextRequired - The order number to look for.
Outputs
existstrue/false- Whether the order is in FourKites
order_idtext- FourKites' ID for the order, empty when not found
order_numbertext- The order number
Example output
{
"exists": true,
"order_id": "b10dce6f-a119-4390-9d82-f291fbc3c229",
"order_number": "4302314363"
}Create truckload shipment
Start tracking a truckload (TL) shipment from one pickup to one delivery, once its carrier has accepted it. FourKites doesn't stop you creating the same load number twice, so check with 'List shipments' first.
Inputs
- Load number
load_numbertextRequired - Your number for the load, as your TMS has it.
- Carrier SCAC
carrier_scactextRequired - The SCAC (or FourKites service provider ID) of the carrier moving the load, such as IC68.
- Pickup name
pickup_nametextRequired - The pickup location's name, such as the warehouse.
- Pickup street address
pickup_addresstextRequired - The first line of the pickup address.
- Pickup city
pickup_citytextRequired - The pickup city.
- Pickup state
pickup_statetextRequired - The pickup state or province: 2 letters in the US and Canada, 3 in Mexico, such as IL.
- Pickup time zone
pickup_time_zonetextRequired - The pickup location's time zone. FourKites reads appointment times in it.
- Pickup window opens
pickup_earliestdate and timeRequired - The start of the pickup appointment window.
- Pickup window closes
pickup_latestdate and timeRequired - The end of the pickup appointment window, the same as or after it opens.
- Delivery name
delivery_nametextRequired - The delivery location's name, such as the warehouse.
- Delivery street address
delivery_addresstextRequired - The first line of the delivery address.
- Delivery city
delivery_citytextRequired - The delivery city.
- Delivery state
delivery_statetextRequired - The delivery state or province: 2 letters in the US and Canada, 3 in Mexico, such as IL.
- Delivery time zone
delivery_time_zonetextRequired - The delivery location's time zone. FourKites reads appointment times in it.
- Delivery window opens
delivery_earliestdate and timeRequired - The start of the delivery appointment window.
- Delivery window closes
delivery_latestdate and timeRequired - The end of the delivery appointment window, the same as or after it opens.
- Pickup postal code
pickup_postal_codetext - The pickup postal or ZIP code.
- Pickup country
pickup_countrytext - The pickup country as a 2-letter code, such as US.
- Delivery postal code
delivery_postal_codetext - The delivery postal or ZIP code.
- Delivery country
delivery_countrytext - The delivery country as a 2-letter code, such as US.
- Reference numbers
reference_numberslist - Your other numbers for the load, such as PO or delivery numbers. FourKites can be searched by them.
- Tags
tagslist - Labels to filter loads by in FourKites.
- Priority
prioritytext - Normal unless chosen. Hot marks the load as hot.One of:
normal,high,hot. - Truck number
truck_numbertext - The tractor's number, as in your GPS or ELD portal.
- Trailer number
trailer_numbertext - The trailer's number, as in your GPS or ELD portal.
- Driver phone
driver_phonetext - The driver's mobile number with its country code, such as +13125555555.
Outputs
load_numbertext- The load number
messagetext- What FourKites said, such as Load created successfully
shipment_idtext- FourKites' ID for the new shipment, for the other steps
Example output
{
"load_number": "LOAD-10421",
"message": "Load created successfully",
"shipment_id": "1000"
}Delete shipments
Withdraw up to 100 shipments, for loads cancelled in your own system. FourKites deletes them shortly after, if it still can, and bills deleted loads as usual.
Inputs
- Shipments
shipment_idslistRequired - The shipments. Pick them, or give FourKites shipment IDs from an earlier step.
Outputs
messagetext- What FourKites said, such as Tracking records marked as hot
shipment_idslist- The shipments FourKites accepted
Example output
{
"message": "Tracking records submitted for deletion",
"shipment_ids": [
"1000"
]
}Find order
Find an order by its number, FourKites ID or customer reference, with its status, parties and counts of lines, shipments and deliveries. Gives found false when there is none. Needs Order Visibility.
Inputs
- Order
valuetextRequired - The order's number, ID or customer reference.
- Order is a
search_bytext - What Order is. Defaults to the order number.One of:
orderNumber(Order number (default)),orderId(FourKites order ID),customerReference(Customer reference).
Outputs
foundtrue/false- Whether FourKites has the order
orderobject- The order, empty when not found
Example output
{
"found": true,
"order": {
"freightType": "inbound",
"lastUpdatedTime": "2026-02-28T11:00:27.464596Z",
"numberOfDeliveries": 1,
"numberOfLineItems": 2,
"numberOfShipments": 1,
"orderFulfillmentPercentage": 0,
"orderNumber": "Order_8Nov_test",
"orderPriority": "HIGH",
"orderTypeCode": "PO",
"orderTypeDescription": "Purchase Order",
"referenceNumbers": [
{
"type": "IDOC",
"value": "DTXT"
}
],
"requiredDeliveryDateTime": "2026-10-25T11:00:27.464596Z",
"seller": {
"address": {
"city": "Kemmerer",
"country": "US",
"name": "Acme Plant",
"state": "WY",
"streetAddress": "100 Main Street",
"zip": "83101"
},
"name": "Jo Bloggs",
"organisationName": "Acme Foods"
},
"shipFrom": {
"address": {
"city": "Kemmerer",
"country": "US",
"name": "Acme Plant",
"state": "WY",
"streetAddress": "100 Main Street",
"zip": "83101"
},
"name": "Jo Bloggs",
"organisationName": "Acme Foods"
},
"shipTo": {
"address": {
"city": "Kemmerer",
"country": "US",
"name": "Acme Plant",
"state": "WY",
"streetAddress": "100 Main Street",
"zip": "83101"
},
"name": "Jo Bloggs",
"organisationName": "Destination 123"
},
"status": "dispatch",
"statusOccurredTime": "2026-02-28T11:00:27.464596Z"
}
}Get API usage
Count the requests made with this API key each day, over the last 30 days at most, for every endpoint or one.
Inputs
- From
start_datedate - The first day to count, within the last 30 days.
- Endpoint
api_pathtext - Only requests to this API path, such as /shipments. Leave empty for every endpoint.
Outputs
dayslist- Requests on each day
total_requestsnumber- Requests in the period
Example output
{
"days": [
{
"date": "2026-06-25",
"requests": 37
},
{
"date": "2026-06-26",
"requests": 1
}
],
"total_requests": 38
}Get appointment slots
Get the open dock appointment slots for a load on one day, at the facility its appointment is with. Needs Appointment Manager.
Inputs
- Load number
load_numbertextRequired - The load's number (or its PO or SO number) in Appointment Manager.
- Inbound or outbound
shipping_typetextRequired - Whether the load is coming into the facility or leaving it.One of:
inbound,outbound. - Date
datedateRequired - The day to look at.
Outputs
calendar_idtext- The calendar's ID
calendar_nametext- The calendar the slots are on
capacity_reachedtrue/false- Whether the day is full
countnumber- How many slots are open
facility_idtext- The facility's ID
facility_nametext- The facility
is_holidaytrue/false- Whether the day is a holiday at the facility
slot_minutesnumber- How long each slot is, in minutes
slotslist- The open slots
time_zonetext- The facility's time zone, such as CST
Example output
{
"calendar_id": "20309",
"calendar_name": "Live pickup",
"capacity_reached": false,
"count": 1,
"facility_id": "Rk1fOTAzMTQy",
"facility_name": "CST -21600 Facility",
"is_holiday": false,
"slot_minutes": 60,
"slots": [
{
"available": 1,
"end": "2026-03-28T12:00:00Z",
"start": "2026-03-28T11:00:00Z"
}
],
"time_zone": "CST"
}Get delivery
Get one delivery of an order by its delivery number, with its status, appointment, trailer, origin and destination. Gives found false when there is none. Needs Order Visibility.
Inputs
- Delivery number
delivery_numbertextRequired - Your delivery number, such as SI7956DA-DELIVERY.
Outputs
deliveryobject- The delivery, empty when not found
foundtrue/false- Whether FourKites has the delivery
Example output
{
"delivery": {
"deliveryDestination": {
"address": {
"addressLine1": "2000 Electronics Blvd",
"city": "Santa Clara",
"country": "USA",
"state": "CA",
"zip": "95054"
},
"id": "RETAIL-STORE-042",
"organisationName": "ElectroMax Distribution Services"
},
"deliveryID": "del-test-011",
"deliveryOrigin": {
"address": {
"addressLine1": "2000 Electronics Blvd",
"city": "Santa Clara",
"country": "USA",
"state": "CA",
"zip": "95054"
},
"id": "ELECTROMAX-DC-001",
"organisationName": "ElectroMax Distribution Services"
},
"deliveryStatus": "scheduled",
"deliveryType": "OUTBOUND",
"eventTime": "2026-08-21T15:45Z[GMT]",
"plannedDeliveryDate": "2026-08-28T16:00Z[GMT]",
"plannedPickupDate": "2026-08-20T08:00Z[GMT]",
"shipmentNumber": "shipment_01_2026",
"trailerNumber": "TRL-45678",
"warehouseAppointmentTime": "2026-08-28T14:30Z[GMT]"
},
"found": true
}Get delivery tracking link
Get a link anyone can open to follow one delivery. Needs Order Visibility.
Inputs
- Delivery
delivery_idtextRequired - Your delivery number, or FourKites' delivery ID.
- Delivery is a
id_typetext - What Delivery is. Leave empty and FourKites works it out.One of:
deliveryIdentifier(Your delivery number),deliveryId(FourKites delivery ID). - Template ID
template_idtext - The tracking page template to use, if your company has more than one. Leave empty for your default template.
Outputs
request_idtext- FourKites' ID for the request, for its support team
urltext- The tracking link; anyone with it can follow the shipment
Example output
{
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"url": "https://app.fourkites.com/inventory/deliveries/eurl/token"
}Get order tracking link
Get a link anyone can open to follow an order and its deliveries. Needs Order Visibility.
Inputs
- Order ID
order_idtextRequired - The order's FourKites ID, from 'Check order exists'.
Outputs
request_idtext- FourKites' ID for the request, for its support team
urltext- The tracking link; anyone with it can follow the shipment
Example output
{
"request_id": "crr5eo8ikb5oemug8iig",
"url": "https://tracking.fourkites.com/eurl/abc123token"
}Get shipment
Get one shipment with its status, ETA, last position, carrier, tags and every stop's appointment, arrival and departure.
Inputs
- Shipment
shipment_idtextRequired - The shipment. Pick one, or give its FourKites shipment ID (digits) from an earlier step.
- Shipment is a
look_up_bytext - Whether Shipment is FourKites' shipment ID or your load number. Defaults to the shipment ID.One of:
fourKitesShipmentID(FourKites shipment ID (default)),loadNumber(Load number).
Outputs
shipmentobject- The shipment
Example output
{
"shipment": {
"SCAC": "IC68",
"fourKitesETA": "2026-07-19T14:37:00-04:00",
"fourKitesShipmentID": "471175003",
"identifiers": {
"purchaseOrderNumbers": [
"PO-2026-4567"
],
"referenceNumbers": [
"GLOG Refnum: C003859078"
]
},
"latestLocation": {
"latitude": 39.7173,
"longitude": -86.2944,
"name": "Indianapolis, IN",
"timeZone": "America/Indiana/Indianapolis",
"updatedTime": "2026-07-19T15:18:00-04:00"
},
"loadNumber": "KDPKDLTEST09",
"numberOfDeliveryStops": 1,
"priority": "normal",
"remainingDistanceInMeters": 0,
"stakeholders": {
"carrier": "Insights Carrier",
"shipper": "Acme Foods"
},
"status": "Completed",
"stops": [
{
"address": "500 West Madison Street, Chicago, IL - 60661, US",
"arrivalTime": "2026-07-19T07:52:00-05:00",
"city": "Chicago",
"country": "US",
"departureTime": "2026-07-19T08:41:00-05:00",
"dwellDurationInMinutes": 49,
"fourKitesStopID": "1250930739",
"latitude": 41.8818,
"longitude": -87.6417,
"postalCode": "60661",
"schedule": {
"appointmentTime": "2026-07-19T08:00:00-05:00"
},
"sequence": 1,
"state": "IL",
"status": "Completed",
"stopName": "FourKites HQ",
"stopType": "PICKUP",
"timeZone": "America/Chicago"
},
{
"address": "2 Ameriplex Parkway, Indianapolis, IN - 46241, US",
"arrivalTime": "2026-07-19T14:37:00-04:00",
"city": "Indianapolis",
"country": "US",
"departureTime": "2026-07-19T15:20:00-04:00",
"dwellDurationInMinutes": 43,
"fourKitesStopID": "1250930740",
"latitude": 39.7173,
"longitude": -86.2944,
"postalCode": "46241",
"schedule": {
"appointmentTime": "2026-07-19T15:00:00-04:00"
},
"sequence": 2,
"state": "IN",
"status": "On Time",
"stopName": "Acme Distribution Center",
"stopType": "DELIVERY",
"timeZone": "America/Indiana/Indianapolis"
}
],
"tags": [
"PALLET"
],
"timeZone": "America/Indiana/Indianapolis",
"totalDistanceInMeters": 293000
}
}Get shipment documents
Get a load's documents of one type, such as its proof of delivery or bill of lading, at the last delivery stop or a stop you choose. Gives found false when there are none.
Inputs
- Find the load by
load_identifiertextRequired - Which of the load's numbers Load value is.One of:
loadNumber(Load number),proNumber(PRO number),trackingNumber(Tracking number),loadReferenceNumber(Load reference number). - Load value
load_valuetextRequired - The load's number of that kind.
- Document type
document_typetextRequired - Which kind of document to get.One of:
DR(Delivery receipt / proof of delivery),BL(Bill of lading),BLD(Bill of lading (driver)),PS(Packing slip),PSD(Packing slip (driver)),CD(Customs document),IV(Invoice),FB(Freight bill),PO(Purchase order),OD(Overages, shortages and damages), and 5 more. - Find the stop by
stop_identifiertext - Which of the stop's numbers Stop value is. Leave both empty for the last delivery stop.One of:
stopSequence(Stop sequence (1 is the first stop)),stopReferenceId(Stop reference ID),locationId(Location ID),stopId(FourKites stop ID). - Stop value
stop_valuetext - The stop's number of that kind, such as 1.
- Every stop
all_stopstrue/false - Get the documents of every stop instead, up to 50 files.
Outputs
countnumber- How many documents came back
documentslist- The documents
foundtrue/false- Whether FourKites has any such documents
Example output
{
"count": 1,
"documents": [
{
"base64_content": "JVBERi0xLjQK",
"name": "doc.pdf",
"type": "pdf"
}
],
"found": true
}Get shipment tracking link
Get a link anyone can open, without signing in, to follow a shipment and its ETA. Send it to a customer or partner.
Inputs
- Shipment
shipment_idtextRequired - The shipment. Pick one, or give its FourKites shipment ID (digits) from an earlier step.
- Shipment is a
look_up_bytext - Whether Shipment is FourKites' shipment ID or your load number. Defaults to the shipment ID.One of:
fourKitesShipmentID(FourKites shipment ID (default)),loadNumber(Load number). - Template ID
template_idtext - The tracking page template to use, if your company has more than one. Leave empty for your default template.
Outputs
request_idtext- FourKites' ID for the request, for its support team
urltext- The tracking link; anyone with it can follow the shipment
Example output
{
"request_id": "brkrjs9ghpuac6skpa5g",
"url": "https://app.fourkites.com/shipment-shareable-e-url"
}Get stop tracking link
Get a link anyone can open to follow a shipment and its ETA at one delivery stop, for the customer at that stop.
Inputs
- Shipment
shipment_idtextRequired - The shipment. Pick one, or give its FourKites shipment ID (digits) from an earlier step.
- Stop
stop_idtextRequired - The stop. Pick one of the shipment's stops, or give its FourKites stop ID from 'Get shipment'.
- Template ID
template_idtext - The tracking page template to use, if your company has more than one. Leave empty for your default template.
Outputs
request_idtext- FourKites' ID for the request, for its support team
urltext- The tracking link; anyone with it can follow the shipment
Example output
{
"request_id": "brkrjs9ghpuac6skpa5g",
"url": "https://app.fourkites.com/stop-shareable-e-url"
}List shipments
List your shipments with their status, ETA, last position and stops, filtered by status, load or order number, or pickup, delivery or creation dates. Gets one page; to see more, run it again with the next page number.
Inputs
- Status
statustext - Only shipments in this tracking status.One of:
active(Active (tracking)),awaitingTrackingInfo(Awaiting tracking info),delivered,expired. - Load number
load_numbertext - Only the shipment with this load number.
- Order number
order_numbertext - Only shipments carrying this order.
- Pickup on or after
pickup_fromdate - Only shipments with a pickup appointment on or after this date. FourKites looks back 30 days by default.
- Pickup on or before
pickup_todate - Only shipments with a pickup appointment on or before this date, at most 90 days ahead.
- Delivery on or after
delivery_fromdate - Only shipments with a delivery appointment on or after this date.
- Delivery on or before
delivery_todate - Only shipments with a delivery appointment on or before this date.
- Created on or after
created_fromdate - Only shipments created on or after this date, at most 90 days ago. FourKites needs a created range for ocean and intermodal shipments.
- Created on or before
created_todate - Only shipments created on or before this date.
- Page
pagenumber - Which page to get, starting at 1.At least 1.
- Page size
per_pagenumber - How many to return, 1 to 100. FourKites' default is 10.From 1 to 100.
Outputs
countnumber- How many are on this page
pagenumber- This page's number
per_pagenumber- The page size
shipmentslist- The shipments on this page
total_countnumber- How many match, across every page
Example output
{
"count": 1,
"page": 1,
"per_page": 10,
"shipments": [
{
"SCAC": "IC68",
"fourKitesETA": "2026-07-19T14:37:00-04:00",
"fourKitesShipmentID": "471175003",
"identifiers": {
"purchaseOrderNumbers": [
"PO-2026-4567"
],
"referenceNumbers": [
"GLOG Refnum: C003859078"
]
},
"latestLocation": {
"latitude": 39.7173,
"longitude": -86.2944,
"name": "Indianapolis, IN",
"timeZone": "America/Indiana/Indianapolis",
"updatedTime": "2026-07-19T15:18:00-04:00"
},
"loadNumber": "KDPKDLTEST09",
"numberOfDeliveryStops": 1,
"priority": "normal",
"remainingDistanceInMeters": 0,
"stakeholders": {
"carrier": "Insights Carrier",
"shipper": "Acme Foods"
},
"status": "Completed",
"stops": [
{
"arrivalTime": "2026-07-19T07:52:00-05:00",
"city": "Chicago",
"country": "US",
"departureTime": "2026-07-19T08:41:00-05:00",
"fourKitesStopID": "1250930739",
"latitude": 41.8818,
"longitude": -87.6417,
"postalCode": "60661",
"schedule": {
"appointmentTime": "2026-07-19T08:00:00-05:00"
},
"sequence": 1,
"state": "IL",
"status": "Completed",
"stopName": "FourKites HQ",
"stopType": "PICKUP",
"timeZone": "America/Chicago"
},
{
"arrivalTime": "2026-07-19T14:37:00-04:00",
"city": "Indianapolis",
"country": "US",
"departureTime": "2026-07-19T15:20:00-04:00",
"fourKitesStopID": "1250930740",
"latitude": 39.7173,
"longitude": -86.2944,
"postalCode": "46241",
"schedule": {
"appointmentTime": "2026-07-19T15:00:00-04:00"
},
"sequence": 2,
"state": "IN",
"status": "On Time",
"stopName": "Acme Distribution Center",
"stopType": "DELIVERY",
"timeZone": "America/Indiana/Indianapolis"
}
],
"timeZone": "America/Indiana/Indianapolis",
"totalDistanceInMeters": 293000
}
],
"total_count": 1
}Mark shipments delivered
Mark up to 50 shipments as delivered, so FourKites stops tracking them. Needs a FourKites admin's username and password on the connection.
Inputs
- Shipments
shipment_idslistRequired - The shipments. Pick them, or give FourKites shipment IDs from an earlier step.
Outputs
messagetext- What FourKites said, such as Tracking records marked as hot
shipment_idslist- The shipments FourKites accepted
Example output
{
"message": "Tracking records marked as delivered",
"shipment_ids": [
"427208796"
]
}Mark shipments hot
Mark up to 100 shipments as hot (top priority) in FourKites. Needs a FourKites admin's username and password on the connection.
Inputs
- Shipments
shipment_idslistRequired - The shipments. Pick them, or give FourKites shipment IDs from an earlier step.
Outputs
messagetext- What FourKites said, such as Tracking records marked as hot
shipment_idslist- The shipments FourKites accepted
Example output
{
"message": "Tracking records marked as hot",
"shipment_ids": [
"427208796"
]
}Record appointment check-in
Record when a load checked in at the facility for its appointment, when it checked out, or both. Needs Appointment Manager.
Inputs
- Load number
load_numbertextRequired - The load's number (or its PO or SO number) in Appointment Manager.
- Inbound or outbound
shipping_typetextRequired - Whether the load is coming into the facility or leaving it.One of:
inbound,outbound. - Checked in at
checked_in_atdate and time - When the load checked in.
- Checked out at
checked_out_atdate and time - When the load checked out.
Outputs
load_numbertext- The load
messagetext- What FourKites said, such as Appointment scheduled successfully
request_idtext- FourKites' ID for the request, for its support team
Example output
{
"load_number": "NB23B23423",
"message": "Updated appointment with check in check out details successfully",
"request_id": "cq8hbj14cktev3sofddg"
}Release appointment slot
Give back a slot held with 'Reserve appointment slot' that no appointment was booked in. Needs Appointment Manager.
Inputs
- Reservation ID
reserve_slot_idtextRequired - The ID 'Reserve appointment slot' gave.
Outputs
messagetext- What FourKites said
request_idtext- FourKites' ID for the request, for its support team
reserve_slot_idtext- The reservation released
Example output
{
"message": "Unblocked Reserve slot successfully",
"request_id": "cr24nh7r816353h819l0",
"reserve_slot_id": "1539865"
}Reserve appointment slot
Hold a dock slot for a load for a while (30 minutes unless you say), then book it with 'Schedule appointment' or give it back with 'Release appointment slot'. Needs Appointment Manager.
Inputs
- Load number
load_numbertextRequired - The load's number (or its PO or SO number) in Appointment Manager.
- Inbound or outbound
shipping_typetextRequired - Whether the load is coming into the facility or leaving it.One of:
inbound,outbound. - Start
startdate and timeRequired - When the slot starts.
- End
enddate and timeRequired - When the slot ends, after it starts.
- Reservation name
slot_nametextRequired - A name for the reservation; it needn't be unique.
- Hold for (minutes)
expiry_minutesnumber - How long to hold it. FourKites' default is 30.From 1 to 1440.
Outputs
company_idtext- Your company's FourKites ID
facility_idtext- The facility's ID
messagetext- What FourKites said, such as Slots reserved successfully
request_idtext- FourKites' ID for the request, for its support team
reserve_slot_idtext- The reservation's ID, for scheduling or releasing it
Example output
{
"company_id": "shipper-sera",
"facility_id": "Rk1fOTAzMTQy",
"message": "Slots reserved successfully",
"request_id": "cnrebhp2kfp1012q5ug0",
"reserve_slot_id": "789799"
}Schedule appointment
Book or move a load's dock appointment, into a slot you reserved or at a start and end time. Needs Appointment Manager.
Inputs
- Load number
load_numbertextRequired - The load's number (or its PO or SO number) in Appointment Manager.
- Inbound or outbound
shipping_typetextRequired - Whether the load is coming into the facility or leaving it.One of:
inbound,outbound. - Reservation ID
reserve_slot_idtext - The slot reserved with 'Reserve appointment slot'. Or leave it empty and give Start and End.
- Start
startdate and time - When the appointment starts, when no reservation is given.
- End
enddate and time - When the appointment ends, when no reservation is given.
Outputs
load_numbertext- The load
messagetext- What FourKites said, such as Appointment scheduled successfully
request_idtext- FourKites' ID for the request, for its support team
Example output
{
"load_number": "NB23B23423",
"message": "Appointment scheduled successfully",
"request_id": "cnrebhp2kfp1012q5ug0"
}Send ETA update
As the carrier, give your estimated arrival at a load's destination. FourKites applies the update shortly after accepting it.
Inputs
- Load reference
load_referencetextRequired - The shipper's reference for the load: its load number, PRO number or another reference FourKites can match.
- Estimated arrival
etadate and timeRequired - When the load is expected at its destination.
- Reference type
reference_typetext - What Load reference is. Leave empty to let FourKites match it against every reference on the shipper's loads.One of:
loadNumber(Load number),proNumber(PRO number),loadReferenceNumber(Load reference number),loadTrackingNumber(Tracking number),carrierReferenceNumber(Carrier reference number). - Bill-to code
bill_to_codetext - The shipper's bill-to code, as entered in FourKites Connect. Helps FourKites find the right shipper's load.
Outputs
accepted_attext- When FourKites accepted it (UTC)
messagetext- What FourKites said, such as API Request Accepted
request_idtext- FourKites' ID for the update, for its support team
statustext- 202 once FourKites has accepted it
Example output
{
"accepted_at": "2026-09-29T13:54:34.594806",
"message": "API Request Accepted",
"request_id": "f8a301c7-5ed1-4e23-8299-b6a06ccc41f7",
"status": "202"
}Send location update
As the carrier, report where a load is now, by latitude and longitude. FourKites applies the update shortly after accepting it.
Inputs
- Load reference
load_referencetextRequired - The shipper's reference for the load: its load number, PRO number or another reference FourKites can match.
- Latitude
latitudenumberRequired - The latitude, such as 41.8818.From -90 to 90.
- Longitude
longitudenumberRequired - The longitude, such as -87.6417.From -180 to 180.
- Reference type
reference_typetext - What Load reference is. Leave empty to let FourKites match it against every reference on the shipper's loads.One of:
loadNumber(Load number),proNumber(PRO number),loadReferenceNumber(Load reference number),loadTrackingNumber(Tracking number),carrierReferenceNumber(Carrier reference number). - Bill-to code
bill_to_codetext - The shipper's bill-to code, as entered in FourKites Connect. Helps FourKites find the right shipper's load.
- Recorded at
located_atdate and time - When the position was recorded. Defaults to now.
- City
citytext - The city the load is in.
- State
statetext - The state or province code, such as IL.
Outputs
accepted_attext- When FourKites accepted it (UTC)
messagetext- What FourKites said, such as API Request Accepted
request_idtext- FourKites' ID for the update, for its support team
statustext- 202 once FourKites has accepted it
Example output
{
"accepted_at": "2026-09-29T13:54:34.594806",
"message": "API Request Accepted",
"request_id": "05020435-50fd-4293-9631-1abd1c72b2d9",
"status": "202"
}