This page provides details, examples and object definition for the booking callback
Introduction
The Booking callback is a message send on a provided webhook URL that can provides you all the details about a recent booking creation as well as any updates (flight, shipment, rate) shared by the airline, but also Tracking information.
In the callback you will find the flight information and associated rate, shipment details, as well as user information. In other words, you will have all the information needed to recreate the booking and link it to the corresponding user even if your user didn't create the shipment in your TMS first, allowing you to receive booking performed directly in Airline's system. This feature will enhance productivity and reduce human error as you will remove manual input for booking creation.
You will find also all the tracking details available for your shipment. In other words, no need for numerous mapping or integration, everything will be available in a single message.
To be able to receive the Booking callback you need to contact us to set a URL allowing https POST requests.
Why Booking Callback is a game changer?
Our booking callback solution offers significant advantages for both you and your users.
By integrating the booking callback, your system will automatically receive real-time updates from airlines, eliminating the need for manual data retrieval. This ensures reduced latency and minimizes the risk of human errors.
Whether it’s a change in flight details or updated rates, our booking callback keeps your system perfectly aligned with airline systems, avoiding discrepancies and ensuring seamless operations.
Additionally, the feature empowers you to notify your users instantly about any booking modifications made by airlines, preventing unexpected surprises and ensuring smooth coordination at the warehouse.
Booking Callback example
{
"awb": "000-00092142",
"flightUUID": "d88ea3cc-864e-11ef-9f4f-465af58dc8d0",
"rateID": "d88ea3ab-864e-11ef-9f4f-465af58dc8d0",
"bookingStatus": "DELIVERED",
"bookingCreatedDate": "2024-10-09T14:58:34+00:00",
"flight": {
"flightUUID": "e5778a23-d3e6-11ef-a886-426d9d7c51d3",
"flightUID": "e5778a23-d3e6-11ef-a886-426d9d7c51d3",
"airlineCode": "00",
"flightNumber": "00768",
"arrivalTime": "2025-01-22T03:00:01+08:00",
"arrivalAirport": "SIN",
"departureTime": "2025-01-21T15:00:01+01:00",
"departureAirport": "CDG",
"latestAcceptanceTime": "2025-01-21T10:00:01+01:00",
"timeOfAvailability": "2025-01-22T08:00:01+08:00",
"legs": [
{
"flightNumber": "00768",
"arrivalTime": "2025-01-22T03:00:01+08:00",
"arrivalAirport": "SIN",
"departureTime": "2025-01-21T15:00:01+01:00",
"departureAirport": "CDG",
"bodyType": "Widebody",
"aircraftCode": "777",
"parentFlightUID": "e5778a23-d3e6-11ef-a886-426d9d7c51d3",
"parentFlightUUID": "e5778a23-d3e6-11ef-a886-426d9d7c51d3",
"co2": {
"value": 268.7270446087906,
"estimation": false
}
}
],
"features": {
"bookable": true,
"awbOptional": true
},
"rates": [
{
"id": "e5778a02-d3e6-11ef-a886-426d9d7c51d3",
"name": "Spot",
"type": "live",
"currency": "EUR",
"netRate": 6.688000000000001,
"allInRate": 6.838000000000001,
"total": 1136.586,
"internalNetRate": 6.08,
"internalAllInRate": 6.23,
"internalTotal": 1035.05,
"markupTotal": 101.53600000000002,
"minimumRate": false,
"lastUpdatedDate": "",
"charges": [
{
"label": "Fuel surcharge",
"rate": 0.07,
"type": "CHARGEABLE_WEIGHT",
"code": "fsc",
"minAmount": 0,
"maxAmount": 0
},
{
"label": "Security surcharge",
"rate": 0.08,
"type": "GROSS_WEIGHT",
"code": "ssc",
"minAmount": 0,
"maxAmount": 0
}
],
"ocdc": null,
"markups": [
{
"type": "cargogate",
"rate": 0.6080000000000001,
"total": 101.53600000000002,
"original_rate": 0.1,
"original_flat_rate": 0
}
],
"isSpotQuoteRate": true,
"handlingCodes": [
"GCR"
],
"coloaderOfficeId": 0
}
],
"available": true,
"source": "AI-MOCK",
"awbPrefixes": [
"000"
],
"airlineConditions": "\n\t1- Offer subject to capacity when booking.\n\t2- Quotation reference to be imperatively mentioned when booking.\n\t3- This quotation is valid for the packaging indicated only, in the event of modification, please make a new request to the sales department.\n\t4- Taxes (IRC – MYC – etc…) subject to change without notice.\n\t5- In the event of cancellation or no show, we reserve the right to pass on all or part of the costs\n\t- Cancellation 72 hours before the departure of the truck and/or the flight (working hours): invoicing 50% of the amount of the freight\n\t- Cancellation 48 hours before the departure of the truck and/or the flight (working hours): invoicing of 75% of the amount of the freight\n\t- Cancellation 24 hours before the departure of the truck and/or the flight (working hours): invoicing of 100% of the amount of the freight\n\t- In the case of a no show (no presentation of the freight): invoicing of 100% of the amount of the freight\n\t- In the case of a low show (discount less than 50% of the reserved taxable weight): invoicing of 75% of the reserved taxable weight\n",
"contacts": [
"tests@cargoai.co"
],
"handlingInfoLink": "https://www.cargoai.co/terms",
"ghaName": "Mocked GHA",
"hle": "19:00",
"ghaAddress": "Airport road, Cargo Terminal, Mocked Cargo building"
},
"searchRequest": {
"clientID": "damien+tests_fw_cgogate@cargoaitest.co",
"destinationCriteria": "SIN",
"originCriteria": "CDG",
"requestDate": "2024-10-10",
"offset": 5,
"product": "GCR",
"weight": 200,
"pieces": 50,
"chargeableWeight": 200,
"dimensions": [
{
"length": 100,
"width": 100,
"height": 100,
"pieces": 50,
"weight": 200,
"volume": 1,
"stackable": true,
"tiltable": false,
"toploadable": false,
"weightType": "TOTAL",
"loadType": "TOTAL"
}
],
"specialHandlingCodes": [
"GCR"
],
"dangerousGoods": null,
"scrs": null,
"globalHS": null,
"europeanHS": null,
"volume": 1,
"forwarder": 0,
"airline": "00",
"isScreened": false,
"officeId": "",
"measurementUnit": "METRIC",
"commodities": null,
"filters": {
"airlineCode": "00",
"withRateOnly": false,
"liveRequests": true,
"scheduleOnly": null
},
"isAllotment": false,
"isAdvancedBooking": false,
"isMultiCallBlocked": false,
"isInterlineEnabled": false
},
"user": {
"airport": "CDG",
"country": "FR",
"iata": "0000000",
"cass": "0000",
"userName": "Test FW CgoGate",
"firstName": "Test FW",
"lastName": "CgoGate",
"email": "email@tests.co",
"isColoader": false
},
"oldEvents": [
{
"code": "BKD",
"eventDate": "2025-01-16T08:50:39Z",
"eventLocation": "CDG",
"eventLocationCoord": "2.54999995,49.01279831",
"flight": {
"number": "00768",
"origin": "CDG",
"destination": "SIN",
"originCoord": "2.54999995,49.01279831",
"destinationCoord": "103.99400330,1.35019004",
"scheduledDeparture": "2025-01-21T15:00:01+01:00",
"scheduledArrival": "2025-01-22T03:00:01+08:00",
"carbonEmission": "486.92 kg (est)",
"distance": "10724.60",
"duration": "11h 54m 58s"
},
"isPlanned": false,
"distance": "10724.60",
"origin": "CDG",
"destination": "SIN",
"time": "11h 54m 58s",
"flightNumber": "00768",
"scheduledDepartureDate": "2025-01-21T15:00:01+01:00",
"carbonEmission": "486.92 kg (est)",
"originCoord": "2.54999995,49.01279831",
"destinationCoord": "103.99400330,1.35019004"
},
{
"code": "BKD",
"eventDate": "2025-01-16T08:50:39+01:00",
"eventLocation": "CDG",
"eventLocationCoord": "2.54999995,49.01279831",
"flight": {
"number": "00768",
"origin": "CDG",
"destination": "SIN",
"originCoord": "2.54999995,49.01279831",
"destinationCoord": "103.99400330,1.35019004",
"date": "2025-01-16T08:50:39+01:00",
"scheduledDeparture": "2025-01-21T15:00:01+01:00",
"estimatedDeparture": "2025-01-21T15:00:01+01:00",
"actualDeparture": "2025-01-21T15:00:01+01:00",
"scheduledArrival": "2025-01-22T03:00:01+08:00",
"estimatedArrival": "2025-01-22T03:00:01+08:00",
"actualArrival": "2025-01-22T03:00:01+08:00",
"carbonEmission": "486.92 kg (est)",
"distance": "10724.60",
"duration": "11h 54m 58s"
},
"weight": "100.0",
"volume": "1.0",
"pieces": "1",
"isPlanned": false,
"distance": "10724.60",
"origin": "CDG",
"destination": "SIN",
"time": "11h 54m 58s",
"flightNumber": "00768",
"scheduledDepartureDate": "2025-01-21T15:00:01+01:00",
"carbonEmission": "486.92 kg (est)",
"originCoord": "2.54999995,49.01279831",
"destinationCoord": "103.99400330,1.35019004"
},
{
"code": "PRE",
"eventDate": "2025-01-21T13:42:01Z",
"eventLocation": "CDG",
"eventLocationCoord": "2.54999995,49.01279831",
"flight": {
"number": "00768",
"origin": "CDG",
"destination": "SIN",
"originCoord": "2.54999995,49.01279831",
"destinationCoord": "103.99400330,1.35019004",
"date": "2025-01-21T13:42:01Z",
"scheduledDeparture": "2025-01-21T15:00:01+01:00",
"estimatedDeparture": "2025-01-21T15:00:01+01:00",
"actualDeparture": "2025-01-21T15:00:01+01:00",
"scheduledArrival": "2025-01-22T03:00:01+08:00",
"estimatedArrival": "2025-01-22T03:00:01+08:00",
"actualArrival": "2025-01-22T03:00:01+08:00",
"carbonEmission": "269.00 kg",
"distance": "10724.60",
"duration": "10724.60"
},
"weight": "100.0",
"volume": "1.0",
"pieces": "1",
"isPlanned": true,
"distance": "10724.60",
"origin": "CDG",
"destination": "SIN",
"flightNumber": "00768",
"scheduledDepartureDate": "2025-01-21T15:00:01+01:00",
"carbonEmission": "269.00 kg",
"originCoord": "2.54999995,49.01279831",
"destinationCoord": "103.99400330,1.35019004"
},
{
"code": "DEP",
"eventDate": "2025-01-21T14:00:01Z",
"eventLocation": "CDG",
"eventLocationCoord": "2.54999995,49.01279831",
"flight": {
"number": "00768",
"origin": "CDG",
"destination": "SIN",
"originCoord": "2.54999995,49.01279831",
"destinationCoord": "103.99400330,1.35019004",
"date": "2025-01-21T14:00:01Z",
"scheduledDeparture": "2025-01-21T15:00:01+01:00",
"estimatedDeparture": "2025-01-21T15:00:01+01:00",
"actualDeparture": "2025-01-21T15:00:01+01:00",
"scheduledArrival": "2025-01-22T03:00:01+08:00",
"estimatedArrival": "2025-01-22T03:00:01+08:00",
"actualArrival": "2025-01-22T03:00:01+08:00",
"carbonEmission": "486.92 kg (est)",
"distance": "10724.60",
"duration": "11h 54m 58s"
},
"weight": "100.0",
"volume": "1.0",
"pieces": "1",
"isPlanned": true,
"distance": "10724.60",
"origin": "CDG",
"destination": "SIN",
"time": "11h 54m 58s",
"flightNumber": "00768",
"scheduledDepartureDate": "2025-01-21T15:00:01+01:00",
"carbonEmission": "486.92 kg (est)",
"originCoord": "2.54999995,49.01279831",
"destinationCoord": "103.99400330,1.35019004"
},
{
"code": "ARR",
"eventDate": "2025-01-21T19:00:01Z",
"eventLocation": "SIN",
"eventLocationCoord": "103.99400330,1.35019004",
"flight": {
"number": "00768",
"origin": "CDG",
"destination": "SIN",
"originCoord": "2.54999995,49.01279831",
"destinationCoord": "103.99400330,1.35019004",
"date": "2025-01-21T19:00:01Z",
"scheduledDeparture": "2025-01-21T15:00:01+01:00",
"estimatedDeparture": "2025-01-21T15:00:01+01:00",
"actualDeparture": "2025-01-21T15:00:01+01:00",
"scheduledArrival": "2025-01-22T03:00:01+08:00",
"estimatedArrival": "2025-01-22T03:00:01+08:00",
"actualArrival": "2025-01-22T03:00:01+08:00",
"carbonEmission": "269.00 kg",
"distance": "10724.60",
"duration": "10724.60"
},
"weight": "100.0",
"volume": "1.0",
"pieces": "1",
"isPlanned": true,
"distance": "10724.60",
"origin": "CDG",
"destination": "SIN",
"flightNumber": "00768",
"scheduledDepartureDate": "2025-01-21T15:00:01+01:00",
"carbonEmission": "269.00 kg",
"originCoord": "2.54999995,49.01279831",
"destinationCoord": "103.99400330,1.35019004"
}
],
"newEvents": [
{
"code": "DLV",
"eventDate": "2025-01-21T19:30:01Z",
"eventLocation": "SIN",
"eventLocationCoord": "103.99400330,1.35019004",
"flight": {
"number": "00768",
"origin": "CDG",
"destination": "SIN",
"originCoord": "2.54999995,49.01279831",
"destinationCoord": "103.99400330,1.35019004",
"date": "2025-01-21T19:30:01Z",
"scheduledDeparture": "2025-01-21T15:00:01+01:00",
"estimatedDeparture": "2025-01-21T15:00:01+01:00",
"actualDeparture": "2025-01-21T15:00:01+01:00",
"scheduledArrival": "2025-01-22T03:00:01+08:00",
"estimatedArrival": "2025-01-22T03:00:01+08:00",
"actualArrival": "2025-01-22T03:00:01+08:00",
"carbonEmission": "269.00 kg",
"distance": "10724.60",
"duration": "10724.60"
},
"weight": "100.0",
"volume": "1.0",
"pieces": "1",
"isPlanned": true,
"distance": "10724.60",
"origin": "CDG",
"destination": "SIN",
"flightNumber": "00768",
"scheduledDepartureDate": "2025-01-21T15:00:01+01:00",
"carbonEmission": "269.00 kg",
"originCoord": "2.54999995,49.01279831",
"destinationCoord": "103.99400330,1.35019004"
}
],
"events": [
{
"code": "BKD",
"eventDate": "2025-01-16T08:50:39Z",
"eventLocation": "CDG",
"eventLocationCoord": "2.54999995,49.01279831",
"flight": {
"number": "00768",
"origin": "CDG",
"destination": "SIN",
"originCoord": "2.54999995,49.01279831",
"destinationCoord": "103.99400330,1.35019004",
"scheduledDeparture": "2025-01-21T15:00:01+01:00",
"scheduledArrival": "2025-01-22T03:00:01+08:00",
"carbonEmission": "486.92 kg (est)",
"distance": "10724.60",
"duration": "11h 54m 58s"
},
"isPlanned": false,
"distance": "10724.60",
"origin": "CDG",
"destination": "SIN",
"time": "11h 54m 58s",
"flightNumber": "00768",
"scheduledDepartureDate": "2025-01-21T15:00:01+01:00",
"carbonEmission": "486.92 kg (est)",
"originCoord": "2.54999995,49.01279831",
"destinationCoord": "103.99400330,1.35019004"
},
{
"code": "BKD",
"eventDate": "2025-01-16T08:50:39+01:00",
"eventLocation": "CDG",
"eventLocationCoord": "2.54999995,49.01279831",
"flight": {
"number": "00768",
"origin": "CDG",
"destination": "SIN",
"originCoord": "2.54999995,49.01279831",
"destinationCoord": "103.99400330,1.35019004",
"date": "2025-01-16T08:50:39+01:00",
"scheduledDeparture": "2025-01-21T15:00:01+01:00",
"estimatedDeparture": "2025-01-21T15:00:01+01:00",
"actualDeparture": "2025-01-21T15:00:01+01:00",
"scheduledArrival": "2025-01-22T03:00:01+08:00",
"estimatedArrival": "2025-01-22T03:00:01+08:00",
"actualArrival": "2025-01-22T03:00:01+08:00",
"carbonEmission": "486.92 kg (est)",
"distance": "10724.60",
"duration": "11h 54m 58s"
},
"weight": "100.0",
"volume": "1.0",
"pieces": "1",
"isPlanned": false,
"distance": "10724.60",
"origin": "CDG",
"destination": "SIN",
"time": "11h 54m 58s",
"flightNumber": "00768",
"scheduledDepartureDate": "2025-01-21T15:00:01+01:00",
"carbonEmission": "486.92 kg (est)",
"originCoord": "2.54999995,49.01279831",
"destinationCoord": "103.99400330,1.35019004"
},
{
"code": "PRE",
"eventDate": "2025-01-21T13:42:01Z",
"eventLocation": "CDG",
"eventLocationCoord": "2.54999995,49.01279831",
"flight": {
"number": "00768",
"origin": "CDG",
"destination": "SIN",
"originCoord": "2.54999995,49.01279831",
"destinationCoord": "103.99400330,1.35019004",
"date": "2025-01-21T13:42:01Z",
"scheduledDeparture": "2025-01-21T15:00:01+01:00",
"estimatedDeparture": "2025-01-21T15:00:01+01:00",
"actualDeparture": "2025-01-21T15:00:01+01:00",
"scheduledArrival": "2025-01-22T03:00:01+08:00",
"estimatedArrival": "2025-01-22T03:00:01+08:00",
"actualArrival": "2025-01-22T03:00:01+08:00",
"carbonEmission": "269.00 kg",
"distance": "10724.60",
"duration": "10724.60"
},
"weight": "100.0",
"volume": "1.0",
"pieces": "1",
"isPlanned": true,
"distance": "10724.60",
"origin": "CDG",
"destination": "SIN",
"flightNumber": "00768",
"scheduledDepartureDate": "2025-01-21T15:00:01+01:00",
"carbonEmission": "269.00 kg",
"originCoord": "2.54999995,49.01279831",
"destinationCoord": "103.99400330,1.35019004"
},
{
"code": "DEP",
"eventDate": "2025-01-21T14:00:01Z",
"eventLocation": "CDG",
"eventLocationCoord": "2.54999995,49.01279831",
"flight": {
"number": "00768",
"origin": "CDG",
"destination": "SIN",
"originCoord": "2.54999995,49.01279831",
"destinationCoord": "103.99400330,1.35019004",
"date": "2025-01-21T14:00:01Z",
"scheduledDeparture": "2025-01-21T15:00:01+01:00",
"estimatedDeparture": "2025-01-21T15:00:01+01:00",
"actualDeparture": "2025-01-21T15:00:01+01:00",
"scheduledArrival": "2025-01-22T03:00:01+08:00",
"estimatedArrival": "2025-01-22T03:00:01+08:00",
"actualArrival": "2025-01-22T03:00:01+08:00",
"carbonEmission": "486.92 kg (est)",
"distance": "10724.60",
"duration": "11h 54m 58s"
},
"weight": "100.0",
"volume": "1.0",
"pieces": "1",
"isPlanned": true,
"distance": "10724.60",
"origin": "CDG",
"destination": "SIN",
"time": "11h 54m 58s",
"flightNumber": "00768",
"scheduledDepartureDate": "2025-01-21T15:00:01+01:00",
"carbonEmission": "486.92 kg (est)",
"originCoord": "2.54999995,49.01279831",
"destinationCoord": "103.99400330,1.35019004"
},
{
"code": "ARR",
"eventDate": "2025-01-21T19:00:01Z",
"eventLocation": "SIN",
"eventLocationCoord": "103.99400330,1.35019004",
"flight": {
"number": "00768",
"origin": "CDG",
"destination": "SIN",
"originCoord": "2.54999995,49.01279831",
"destinationCoord": "103.99400330,1.35019004",
"date": "2025-01-21T19:00:01Z",
"scheduledDeparture": "2025-01-21T15:00:01+01:00",
"estimatedDeparture": "2025-01-21T15:00:01+01:00",
"actualDeparture": "2025-01-21T15:00:01+01:00",
"scheduledArrival": "2025-01-22T03:00:01+08:00",
"estimatedArrival": "2025-01-22T03:00:01+08:00",
"actualArrival": "2025-01-22T03:00:01+08:00",
"carbonEmission": "269.00 kg",
"distance": "10724.60",
"duration": "10724.60"
},
"weight": "100.0",
"volume": "1.0",
"pieces": "1",
"isPlanned": true,
"distance": "10724.60",
"origin": "CDG",
"destination": "SIN",
"flightNumber": "00768",
"scheduledDepartureDate": "2025-01-21T15:00:01+01:00",
"carbonEmission": "269.00 kg",
"originCoord": "2.54999995,49.01279831",
"destinationCoord": "103.99400330,1.35019004"
},
{
"code": "DLV",
"eventDate": "2025-01-21T19:30:01Z",
"eventLocation": "SIN",
"eventLocationCoord": "103.99400330,1.35019004",
"flight": {
"number": "00768",
"origin": "CDG",
"destination": "SIN",
"originCoord": "2.54999995,49.01279831",
"destinationCoord": "103.99400330,1.35019004",
"date": "2025-01-21T19:30:01Z",
"scheduledDeparture": "2025-01-21T15:00:01+01:00",
"estimatedDeparture": "2025-01-21T15:00:01+01:00",
"actualDeparture": "2025-01-21T15:00:01+01:00",
"scheduledArrival": "2025-01-22T03:00:01+08:00",
"estimatedArrival": "2025-01-22T03:00:01+08:00",
"actualArrival": "2025-01-22T03:00:01+08:00",
"carbonEmission": "269.00 kg",
"distance": "10724.60",
"duration": "10724.60"
},
"weight": "100.0",
"volume": "1.0",
"pieces": "1",
"isPlanned": true,
"distance": "10724.60",
"origin": "CDG",
"destination": "SIN",
"flightNumber": "00768",
"scheduledDepartureDate": "2025-01-21T15:00:01+01:00",
"carbonEmission": "269.00 kg",
"originCoord": "2.54999995,49.01279831",
"destinationCoord": "103.99400330,1.35019004"
}
]
}
Booking Callback Object Definition
| Name | Type | Description |
|---|---|---|
| awb | string | Search Id for getting missing results |
| flightUUID | string | Unique flight id used for booking |
| rateID | string | FlyWINDOW link |
| bookingStatus | string | Status of the booking after creation |
| bookingCreatedDate | string | booking creation date |
| flight | Flight | Flight associated to booking |
| searchRequest | SearchRequest | Shipment details used for booking |
| user | User | User that performed the booking |
| oldEvents | []trackingEvent | Previously updated tracking events |
| newEvents | []trackingEvent | Newly updated tracking events |
| events | []trackingEvent | All the events found in the last tracking |
Flight Object
| Name | Type | Description |
|---|---|---|
| flightUUID | string | Unique flight id for booking |
| flightUID | string | Unique flight id for booking (DEPRECATED) |
| airlineCode | string | Flight airline code |
| flightNumber | string | Flight number (with airline code). In case of connected flights flight numbers of every leg, e.g. "00768-00687" |
| arrivalTime | string | Flight arrival time and date in the format YYYY-MM-DDTHH:MM:SS±HH:MM |
| arrivalAirport | string | Flight arrival airport code |
| departureTime | string | Flight departure time and date in the format YYYY-MM-DDTHH:MM:SS±HH:MM |
| departureAirport | string | Flight departure airport code |
| latestAcceptanceTime | string | Latest acceptance time at the first origin warehouse |
| timeOfAvailability | string | The earliest time the shipment will be at the final destination |
| stops | int | Number of stops |
| legs | []Leg | Legs of the flight |
| features | FlightFeatures | Features available for the flight |
| rates | []Rate | Rates available for the flight |
| available | bool | Indicates whether flight is eligible for booking ("bookable" in FlightFeatures has to be true as well) |
| availableReason | string | Reasons for not available booking |
| awbPrefixes | []string | AWB prefixes that can be used with the airline |
| airlineConditions | string | Conditions imposed by airline |
| salesConditions | string | Conditions related to the sale of the rate imposed by airline (can be related to product, market, etc.) |
| contacts | []string | Email addresses for questions regarding booking to GHA or airline |
| handlingInfoLink | string | Link to Terms and Conditions |
| ghaName | string | Ground Handling Agent name |
| hle | string | "Heure Limite d'Enregistrement" refer to latestAcceptanceTime |
| ghaAddress | string | Ground Handling Agent address |
Leg Object
| Name | Type | Description |
|---|---|---|
| flightNumber | string | Leg flight number (with airline code) |
| arrivalTime | string | Leg arrival time and date in the format YYYY-MM-DDTHH:MM:SS±HH:MM |
| arrivalAirport | string | Leg arrival airport code |
| departureTime | string | Leg departure time and date in the format YYYY-MM-DDTHH:MM:SS±HH:MM |
| departureAirport | string | Leg departure airport code |
| bodyType | string | Leg aircraft body type (Narrowbody, Widebody, Surface, Freighter or Unknown) |
| aircraftCode | string | Leg aircraft code (ex: B72) |
| co2 | CO2Calculation | Leg CO2 emissions calculation |
| detailedFlightNumber | FlightNumber | Leg flight number as carrier code and number separately |
CO2Calculation Object
| Name | Type | Description |
|---|---|---|
| value | float64 | CO2 emissions in kg |
| estimation | bool | Indicates whether the value is an estimation or a calculated exact number |
FlightNumber Object
| Name | Type | Description |
|---|---|---|
| carrier | string | Carrier code part of a flight number |
| number | string | Numbers part of a flight number |
FlightFeatures Object
| Name | Type | Description |
|---|---|---|
| bookable | bool | Indicates whether flight is eligible for booking ("available" in the Flight has to be true as well) |
| awbOptional | bool | Indicates whether booking will require an AWB number or not |
| allotment | bool | Indicates whether flight booking is eligible to be placed under allotment |
Rate Object
| Name | Type | Description |
|---|---|---|
| id | string | Rate id for booking |
| name | string | Rate name provided by airline |
| type | string | Rate type (live, express, Market, Contract, Promo or Express*) |
| currency | string | Rate currency |
| netRate | float64 | Net rate: applied to a shipment without the charges calculation (rate/kg) |
| allInRate | float64 | All in rate: applied to a shipment with the charges calculation (rate/kg) |
| total | float64 | Total price applied to a shipment |
| minimumRate | bool | Indicates whether the rate to apply is the lowest price the carrier will charge for this shipment |
| lastUpdatedDate | string | Rate last updated date |
| charges | []Charge | Rate charges |
| ocdc | []Charge | Rate OCDC charges |
| isManualRate | bool | Indicates whether the rate has been manually uploaded into cargoAi system (not bookable with API) |
| isSpotQuoteRate | bool | Indicates whether the rate is a spot rate |
| latestAcceptanceTime | string | Latest acceptance time at the first origin warehouse (rate specific) |
| timeOfAvailability | string | The earliest time the shipment will be at the final destination (rate specific) |
| handlingCodes | []string | Handling codes for which rate is applicable |
| allotmentCode | string | Allotment code |
*Dynamic rates are all in lower case whereas static rates are starting with a capital letter. express is dynamic; Express is static.
**In airfreight, OCDC (Other Charge Due Carrier) refers to additional fees or surcharges that the carrier imposes on the shipment. These charges are collected to cover costs not included in the base airfreight rate, which could arise from handling, security, fuel, or special services required for the cargo. Most of the time they are collected apart and are part of the all-in rate calculation, because they are just here as information and depends of the shipments.
Charge Object
| Name | Type | Description |
|---|---|---|
| label | string | Charge label |
| rate | float64 | Charge rate |
| type | string | Charge type (SHIPMENT, GROSS_WEIGHT or CHARGEABLE_WEIGHT)* |
| code | string | Charge code |
| minAmount | float64 | Refers to the minimum charge a carrier will apply to a shipment** |
| maxAmount | float64 | Refers to a cap or maximum charge a carrier will apply to a shipment** |
*Please, see details about charge types here
**after calculation of the charge rate times the type (Shipment or Gross weight or Chargeable weight) and if the total is lower/higher than the amount displayed
SearchRequest Object
| Name | Type | Description |
|---|---|---|
| destinationCriteria | string | shipment final destination |
| originCriteria | string | shipment first origin |
| requestDate | string | shipment's search requested departure date |
| offset | int | shipment's search offset |
| product | string | shipment's product code |
| weight | float64 | shipment's total weight |
| pieces | int | shipment's total pieces |
| chargeableWeight | float64 | shipment's total chargeable weight* |
| dimensions | []Dimension | shipment's piece group dimensions |
| specialHandlingCodes | []string | shipment's handling codes |
| dangerousGoods | []string | shipment's dangerous goods (if any) |
| scrs | []string | shipment's scrs code (Specific Commodity Rate code) |
| globalHS | []string | shipment's global HS codes (Harmonized System code) |
| europeanHS | []string | shipment's European HS codes (Harmonized System code) |
| volume | float64 | shipment's total volume |
| airline | string | airline code (if filtered during user's search) |
| isScreened | boolean | flag to inform if booking is screened (secured) |
| measurementUnit | string | shipment's measurement unit (METRIC, IMPERIAL) (unit of the shipments will depend on the value of measurement unit: - Metric: Kg, cm, cbm - Imperial: Kg, in, cbf |
| filters | Filters | shipment's search filters to refine API results |
*Please, see details about chargeable weight here
Dimension Object
| Name | Type | Description |
|---|---|---|
| pieces | int | number of piece of the piece group |
| length | float64 | indicates length of piece group |
| width | float64 | indicates width of piece group |
| height | float64 | indicates height of piece group |
| weight | float64 | indicates piece group weight (per piece or total, based on weightType field value) |
| loadType | string | enum["DIMENSIONS", "TOTAL", "BUP"] |
| weightType | string | indicates if piece group weight is total or per piece enum["PER_ITEM", "TOTAL"] |
| stackable | boolean | indicates if shipment can be stack during loading in aircraft |
| tiltable | boolean | indicates if shipment is turnable during loading in aircraft |
| toploadable | boolean | indicates if shipment can be loaded on top during loading in aircraft |
| uldType | boolean | indicates piece group uld type (if loadType = BUP) |
| volume | float64 | volume of the piece group |
Filters Object
| Name | Type | Description |
|---|---|---|
| airlineCode | string | filters results to a specific airline - accepts only IATA 2 letter code |
| withRateOnly | boolean | filters results to return only flights with a rate |
| liveRequests | boolean | filters results to return only Airlines' APIs results |
| isOriginByCity | boolean | indicates if the origin of your search is a city code or an airport code (only true if isDestinationByCity is false) |
| isDestinationByCity | boolean | indicates if the destination of your search is a city code or an airport code (only true if isOriginByCity is false) |
User Object
| Name | Type | Description |
|---|---|---|
| airport | string | user's office airport code (or closest airport) |
| country | string | user's country code |
| iata | string | user's IATA code |
| cass | string | user's Cass code |
| userName | string | username of the user |
| firstName | string | first name of the user |
| lastName | string | last name of the user |
| string | user's email address |
trackingEvent Object
| Name | Type | Description |
|---|---|---|
| code | string | Tracking event code |
| description | string | Tracking event description |
| eventDate | string | Tracking event date and time; standard format: YYYY-MM-DDTHH:MM:SS±HH:MM (e.g., "2024-05-14T14:05:35+02:00") |
| eventLocation | string | Tracking event airport location |
| eventLocationCoord | string | Tracking event airport coordinates location; data format: string — latitude,longitude (e.g., "14.26000023,50.10079956") |
| flight | trackingFlight | Flight associated to tracking event |
| weight | string | Shipment event weight; data format: string(float, one decimal place in kg) (e.g., "123.4") |
| volume | string | Shipment event volume; data format: string(float, one decimal place in cbm) (e.g., "56.7") |
| pieces | string | Shipment event pieces; data format: string(integer) (e.g., "3") |
| additionalInformation | additionalTrackingInformation | Tracking event additional information (Notifications, Delivery, etc.) |
| eventUlds | []eventULDdetails | ULD information if event contains ULDs |
| isPlanned | string | Flag to inform if the event is planned to happen in the future |
| distance | string | Distance between origin and destination in km; data format: string(float, two decimal places) (e.g., "789.01") |
| origin | string | Origin airport code |
| destination | string | Destination airport code |
| time | string | Flight total duration - (format: HH MM SS) |
| flightNumber | string | Flight number; data format: string — airline code and flight number with removed leading zeros (e.g., "AA123") |
| scheduledDepartureDate | string | Scheduled flight event departure date and time; standard format: YYYY-MM-DDTHH:MM:SS±HH:MM (e.g., "2024-05-14T14:05:35+02:00") |
| carbonEmission | string | Total carbon emission of the event; data format: string(float, two decimal places followed by "kg" and in case of estimated value "(est)") (e.g., "123.45 kg (est)") |
| originCoord | string | Origin latitude and longitude coordinates; data format: string — latitude,longitude (e.g., "14.26000023,50.10079956") |
| destinationCoord | string | Destination latitude and longitude coordinates; data format: string — latitude,longitude (e.g., "14.26000023,50.10079956") |
trackingFlight Object
| Name | Type | Description |
|---|---|---|
| number | string | Flight number; data format: string — airline code and flight number with removed leading zeros (e.g., "AA123") |
| origin | string | Origin airport code |
| destination | string | Destination airport code |
| originCoord | string | Origin latitude and longitude coordinates; data format: string — latitude,longitude (e.g., "14.26000023,50.10079956") |
| destinationCoord | string | Destination latitude and longitude coordinates; data format: string — latitude,longitude (e.g., "14.26000023,50.10079956") |
| date | string | Flight departure date; standard format: YYYY-MM-DDTHH:MM:SS±HH:MM (e.g., "2024-05-14T14:05:35+02:00") |
| scheduledDeparture | string | Scheduled flight departure date and time; standard format: YYYY-MM-DDTHH:MM:SS±HH:MM (e.g., "2024-05-14T14:05:35+02:00") |
| estimatedDeparture | string | Estimated flight departure date and time; standard format: YYYY-MM-DDTHH:MM:SS±HH:MM (e.g., "2024-05-14T14:05:35+02:00") |
| actualDeparture | string | Real flight departure date and time; standard format: YYYY-MM-DDTHH:MM:SS±HH:MM (e.g., "2024-05-14T14:05:35+02:00") |
| scheduledArrival | string | Scheduled flight arrival date and time; standard format: YYYY-MM-DDTHH:MM:SS±HH:MM (e.g., "2024-05-14T14:05:35+02:00") |
| estimatedArrival | string | Estimated flight arrival date and time; standard format: YYYY-MM-DDTHH:MM:SS±HH:MM (e.g., "2024-05-14T14:05:35+02:00") |
| actualArrival | string | Real flight arrival date and time; standard format: YYYY-MM-DDTHH:MM:SS±HH:MM (e.g., "2024-05-14T14:05:35+02:00") |
| carbonEmission | string | Total carbon emission of the flight; data format: string(float, two decimal places followed by "kg" and in case of estimated value "(est)") (e.g., "123.45 kg (est)") |
| distance | string | Distance between origin and destination in km; data format: string(float, two decimal places) (e.g., "789.01") |
| duration | string | Flight total duration (format: HH MM SS) |
| flightUlds | []eventULDdetails | ULD information if flight contains ULDs |
additionalTrackingInformation Object
| Name | Type | Description |
|---|---|---|
| receivedFromName | string | Name of the person who drop shipment at the warehouse |
| notificationToName | string | Name of the person to notify about shipment availability |
| deliveryToName | string | Name of the person to deliver the shipment |
| transferredToCarrier | string | Carrier to which shipment has been transferred to |
eventULDdetails Object
| Name | Type | Description |
|---|---|---|
| pieces | string | Number of ULD; data format: string(integer) (e.g., "3") |
| uld | string | ULD type ("AKE", "LDP", "MDP") |