Search Response Objects Definition

Name	Type	Description
id	string	Search Id for getting missing results
status	string	Search status
resultsURL	string	FlyWINDOW link
flights	[]Flight	Found flights

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 when static rates are starting with 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*

*after calculation of charge rate x type (Shipment or Gross weight or Chargeable weight) and if the total is lower/higher than the amount displayed. Please, see details about charge types and calculations here

*** These fields are partially supported and used only with some specific airlines that automatically book on allotments.
For proper allotment booking or maximum coverage, please use our Direct Booking Flow