API Reference

Routes, Schedules and Rates

post
https://api.cargoai.co/solutions/search

This document provides information about request body parameters and headers as well as example requests and responses for different search modes

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
Defaults to CDG

Origin airport code (or a city code in Search by City Code)

string
required
Defaults to JFK

Destination airport code (or a city code in Search by City Code)

string
required
Defaults to 2024-01-01

Your earliest desired departure date

shipment
object

Shipment details (required for Quote & Book)

user
object

User details (required for Quote & Book)

int32
Defaults to 25

Request timeout in seconds

int32
Defaults to 5

Departure dates in the search result can be up to {offset} days in the future (max value is 5)

string

Search Id to add to params before repeating request to get missing results

filters
object

Search filters to refine API results

Headers
string
required
string
Defaults to Schedules

Set it to "Schedules" for Route & Schedule

Responses

Updated 13 days ago

What’s Next

Looking ahead, once you've obtained your search results, the next phase involves booking your preferred option. To determine whether 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.

Concerned about obtaining an Air Waybill (AWB) number for booking? Not to worry. Simply look for options with the "awbOptional" field in your search results. If set to true, the airline will facilitate an AWB from their stock, providing you with the necessary documentation.

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json

Updated 13 days ago

What’s Next

Looking ahead, once you've obtained your search results, the next phase involves booking your preferred option. To determine whether 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.

Concerned about obtaining an Air Waybill (AWB) number for booking? Not to worry. Simply look for options with the "awbOptional" field in your search results. If set to true, the airline will facilitate an AWB from their stock, providing you with the necessary documentation.