API Reference

Routes, Schedules and Rates

This document provides all the information you need to fully use our Routes, Schedules and Rates endpoint

Let's delve into the functionality of our Routes, Schedules and Rates endpoint, which serves as the gateway to our API ecosystem. We are providing schedules of over 700 airlines (Route & Schedule API) as well as bookable rates from over 100 airlines (Quote & Book API). Further, we provide a state-of-the-art CO2 calculator that allows you to make the most environmentally friendly transportation decisions.

Route & Schedule

Route & Schedule API allows you to easily retrieve schedules for a specific date and route, in case you are only interested in flight schedules. Route & Schedule coverage can be found here under the tab "Live Schedule Coverage".

To retrieve schedules, add the header: "x-api-name": "Schedules" to the search endpoint, that way you will restrict your query results to schedules only. The header also reduces the mandatory fields of the request to just three: "origin", “destination" and “departureDate". You can use Search by City Code feature with Route & Schedule.

Route & Schedule only provides access to schedules, to get rates and booking capabilities please refer to Quote & Book API.

Quote & Book

Quote & Book API allows you to search for available air freight capacities and rates and decide which options you’d like to book as though you were navigating our CargoMART. You can search and book rates of 105 airlines, this coverage is growing on a regular basis as we are integrating new airlines and expand the market scope of existing airline integrations. Quote & Book coverage can be found here under the tab "Live eBooking Coverage".

Please refer to this page for the detailed description of the search response you get with Quote & Book API.

You can use Search by City Code feature with Quote & Book.

Please note that in order to get all available search results with Quote & Book API a user has to be configured through the User Provisioning API.

BASIC and ADVANCED Search Modes

We offer two operational modes for this endpoint.

In the BASIC mode responses may take longer due to partners' response times, but you get all your search results in 1-3 API calls. To use the BASIC mode either set a higher timeout (max value is 25 seconds) or omit the “timeout” field making it take the default value of 25 seconds.

Conversely, in the ADVANCED mode you can get fast-updating search results by setting a shorter timeout and recalling rapidly with the specified time frame.

In both modes, if the status is "COMPLETED," you've received all results; if the status is "STARTED," you need to iterate your search using the provided ID until the status switches to "COMPLETED".

Click here to watch a demo on the two search modes.

FlyWINDOW

Each bookable rate response includes a FlyWINDOW link. The FlyWINDOW feature provides an alternative booking experience within your own application. Please read about it here.

Additional Details

Live Request: Currently CargoCONNECT offers two types of request options:

  • Live flight & rates: dynamic flight schedules and rates, directly fetched from airline's system.
  • Non live flight & rates: static flight schedules and rates uploaded into our system on a daily basis for flights and weekly for rates. They are there to offer options when Airline's API is not providing options for your search (in case of a market restriction, for example).

Market and contract rates can be uploaded to our system by following the process described here.

Please refer to our Rate Types page to see a comprehensive overview of all possible rate types.

Charge Types: Here are the charge types you might get with every rate:

  • "SHIPMENT": the charge applied once per shipment
  • "GROSS_WEIGHT": the charge applied per 1kg of the weight of the shipment
  • "CHARGEABLE_WEIGHT": the charge applied per 1kg of the chargeable weight of the shipment

Please refer to our Air Freight Calculations to see an overview of charge types & how to calculate the cost of your shipment with them.

Bookable Options: it's an option that is eligible for Booking creation. To know if an option is bookable examine two critical fields within the flight object: "available" in the root, and "bookable" within the "features" object. If both are true, the option is eligible for online booking. However, if either is false, your booking request will be preemptively rejected.

AWB Optional: "awbOptional" field in "features" object specifies if you can send your booking creation request with or without an AWB number. When the field is true, it means that the Airline API offering this option provides an AWB number from its stock (depending on stock availability).

Request Filters

You can limit the results based on your needs using following filters:

  • withRatesOnly: Limit the results to flights with rates (rates can be offline).
  • liveRequests: Limit the results to direct airline API queries (ignore offline schedules).
"filters": {
  "withRateOnly": true,
  "liveRequests": true
}

Additionally, as described below, setting "isOriginByCity" or "isDestinationByCity" fields in the "filters" to true activates Search by City Code mode.

Search by City Code

This feature is used for the retrieval of flight schedules and their corresponding rates (in case of Quote & Book) for all airports within a specified city, instead of a specific airport.

Note that:

  • You may initiate a search with a city as either the origin or the destination, but not both simultaneously.
  • The API exclusively accepts IATA three-letter code cities (e.g. "PAR" for Paris, "MIA" for Miami). The list of city codes used in CargoCONNECT API is available in Airports Masterdata here.
  • Due to cities and airports sharing identical codes (e.g. "MIA" for both Miami airport and the city itself), newly introduced fields must be added within the filter section: "IsOriginByCity" or "IsDestinationByCity", depending on whether the origin or the destination is identified by a city code.
"filters": {
  "isOriginByCity": true,
  "isDestinationByCity": false
}

User Responsibility for Data Accuracy

Our API processes and returns data exactly as provided in your request. It is the user's responsibility to ensure that all shipment details—such as dimensions, weights, and totals—are accurate before submission.

In some cases, Freight Forwarders may manually adjust the chargeable weight to meet specific pricing. As a result, we do not verify or adjust the data you submit. Any discrepancies, incorrect rates, or unexpected pricing outcomes due to incorrect input data are solely the user's responsibility. We are not liable for any errors resulting from incorrect shipment details provided in API requests.

By using this API, you acknowledge and accept that ensuring data accuracy is your responsibility.