> This page is for version Prod (default).
> For other versions, use one of these documentation indexes:
> - Prod (default): https://docs.chrt.com/prod/llms.txt
> - Staging: https://docs.chrt.com/staging/llms.txt
> - Dev: https://docs.chrt.com/dev/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.chrt.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.chrt.com/_mcp/server.

# Search

POST https://api.chrt.com/cargo_on_flight_integrations/cargoai/search/v1/{cargo_on_flight_booking_id}
Content-Type: application/json

Starts a CargoAi search for flights with space and rates for a draft booking's cargos on a route and date, as the chosen CargoAi product or the one its special handling codes imply, and stores it. | authz_personas=[task_group_coordinator_operators] | (CargoOnFlightBookingSearchClientCreate1) -> (CargoOnFlightBookingSearch1)

Reference: https://docs.chrt.com/api-reference/api-reference/cargo-on-flight-integrations/cargoai/search-v-1

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Servers

- `https://api.chrt.com` (Production, default)
- `https://api.dev.chrt.com` (Development)
- `https://api.staging.chrt.com` (Staging)
- `https://localhost:8000` (Local)

## Request

### Path parameters

- `cargo_on_flight_booking_id` (string, required)

### Body (application/json)

This endpoint expects a CargoOnFlightBookingSearchClientCreate1.

- `destination_iata` (string, required)
- `earliest_departure_date` (string, required)
- `origin_iata` (string, required)
- `schema_version` (integer, required)
- `air_canada_product` (enum, optional)
  - Allowed values: `AFR`, `PPR`, `SFX`, `PPS`, `PPP`, `AFH`, `PFH`
- `airline_cargo_account_id` (string, optional)
- `cargoai_product` (enum, optional)
  - Allowed values: `GCR`, `PHARM`, `FRESH`, `AVI`, `HUM/LHO`, `VAL/VUN`
- `iata_cass_office_id` (string, optional)
- `offset_days` (integer, optional, default: 5)

## Response

### 200

Successful Response

- `_id` (string, required)
- `cargo_on_flight_booking_id` (string, required)
- `cargo_on_flight_integration` (enum, required)
  - Allowed values: `air_canada`, `cargoai`, `manual`
- `created_at_timestamp` (datetime, required)
- `created_by_org_id` (string, required) — Must be a string starting with `org_`
- `destination_iata` (string, required)
- `earliest_departure_date` (string, required)
- `integration_search_id` (string, required)
- `origin_iata` (string, required)
- `schema_version` (integer, required)
- `search_completed` (boolean, required)
- `updated_at_timestamp` (datetime, required)
- `air_canada_product` (enum, optional)
  - Allowed values: `AFR`, `PPR`, `SFX`, `PPS`, `PPP`, `AFH`, `PFH`
- `airline_cargo_account_id` (string, optional)
- `cargoai_product` (enum, optional)
  - Allowed values: `GCR`, `PHARM`, `FRESH`, `AVI`, `HUM/LHO`, `VAL/VUN`
- `created_by_user_id` (string, optional) — Must be a string starting with `user_`
- `iata_cass_office_id` (string, optional)
- `offset_days` (integer, optional, default: 5)
- `results` (list of CargoOnFlightBookingSearchResult1, optional)

## Errors

### 422 Cargoai Search V1request Unprocessable Entity Error

Validation Error

- `detail` (list of ValidationError, optional)

## Types

### CargoOnFlightBookingSearchResult1

- `awb_required` (boolean, required)
- `bookable` (boolean, required)
- `carrier_iata` (string, required)
- `integration_result_id` (string, required)
- `airline_conditions` (string, optional)
- `airline_contacts` (list of string, optional)
- `awb_prefixes` (list of string, optional)
- `handling_info_link` (string, optional)
- `latest_acceptance_utc` (datetime, optional)
- `legs` (list of CargoOnFlightBookingItineraryLeg1, optional)
- `not_bookable_reason` (string, optional)
- `origin_ground_handling_agent_address` (string, optional)
- `origin_ground_handling_agent_name` (string, optional)
- `rates` (list of CargoOnFlightBookingRate1, optional)
- `time_of_availability_utc` (datetime, optional)

### ValidationError

- `loc` (list of LocationItem, required)
- `msg` (string, required)
- `type` (string, required)
- `ctx` (map from string to any, optional)
- `input` (any, optional)

### CargoOnFlightBookingItineraryLeg1

One leg of an itinerary: a flight, or a road feeder truck (`surface_transport`).

- `carrier_iata` (string, required)
- `destination_iata` (string, required)
- `flight_number` (string, required)
- `origin_iata` (string, required)
- `scheduled_arrival_utc` (datetime, required)
- `scheduled_departure_utc` (datetime, required)
- `surface_transport` (boolean, required)
- `aircraft_body_type` (enum, optional)
  - Allowed values: `widebody`, `narrowbody`, `freighter`, `unknown`
- `aircraft_code` (string, optional)
- `integration_body_type` (string, optional)

### CargoOnFlightBookingRate1

A price quoted for a shipment: one of a search result's rates, or the price a MANUAL booking was quoted.

- `currency_code` (string, required)
- `total_amount` (double, required)
- `all_in_rate_per_kilogram` (double, optional)
- `chargeable_weight_kilograms` (double, optional)
- `charges` (list of CargoOnFlightBookingRateCharge1, optional)
- `integration_rate_id` (string, optional)
- `net_rate_per_kilogram` (double, optional)
- `other_charges_due_carrier` (list of CargoOnFlightBookingRateCharge1, optional)
- `rate_name` (string, optional)
- `special_handling_codes` (list of string, optional)

### LocationItem

- string
- integer

### CargoOnFlightBookingRateCharge1

One charge in a rate's breakdown, priced per `basis` unit in the rate's currency.

- `basis` (string, required)
- `label` (string, required)
- `rate` (double, required)
- `code` (string, optional)
- `maximum_amount` (double, optional)
- `minimum_amount` (double, optional)

## Examples

**Request**

```json
{
  "destination_iata": "destination_iata",
  "earliest_departure_date": "earliest_departure_date",
  "origin_iata": "origin_iata",
  "schema_version": 1
}
```

**Response**

```json
{
  "_id": "_id",
  "cargo_on_flight_booking_id": "cargo_on_flight_booking_id",
  "cargo_on_flight_integration": "air_canada",
  "created_at_timestamp": "2024-01-15T09:30:00Z",
  "created_by_org_id": "created_by_org_id",
  "destination_iata": "destination_iata",
  "earliest_departure_date": "earliest_departure_date",
  "integration_search_id": "integration_search_id",
  "origin_iata": "origin_iata",
  "schema_version": 1,
  "search_completed": true,
  "updated_at_timestamp": "2024-01-15T09:30:00Z",
  "air_canada_product": "AFR",
  "airline_cargo_account_id": "airline_cargo_account_id",
  "cargoai_product": "GCR",
  "created_by_user_id": "created_by_user_id",
  "iata_cass_office_id": "iata_cass_office_id",
  "offset_days": 1,
  "results": [
    {
      "awb_required": true,
      "bookable": true,
      "carrier_iata": "carrier_iata",
      "integration_result_id": "integration_result_id",
      "airline_conditions": "airline_conditions",
      "airline_contacts": [
        "airline_contacts"
      ],
      "awb_prefixes": [
        "awb_prefixes"
      ],
      "handling_info_link": "handling_info_link",
      "latest_acceptance_utc": "2024-01-15T09:30:00Z",
      "legs": [
        {
          "carrier_iata": "carrier_iata",
          "destination_iata": "destination_iata",
          "flight_number": "flight_number",
          "origin_iata": "origin_iata",
          "scheduled_arrival_utc": "2024-01-15T09:30:00Z",
          "scheduled_departure_utc": "2024-01-15T09:30:00Z",
          "surface_transport": true
        }
      ],
      "not_bookable_reason": "not_bookable_reason",
      "origin_ground_handling_agent_address": "origin_ground_handling_agent_address",
      "origin_ground_handling_agent_name": "origin_ground_handling_agent_name",
      "rates": [
        {
          "currency_code": "currency_code",
          "total_amount": 1.1,
          "integration_rate_id": null,
          "rate_name": null
        }
      ],
      "time_of_availability_utc": "2024-01-15T09:30:00Z"
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://api.chrt.com/cargo_on_flight_integrations/cargoai/search/v1/cargo_on_flight_booking_id"

payload = {
    "destination_iata": "destination_iata",
    "earliest_departure_date": "earliest_departure_date",
    "origin_iata": "origin_iata",
    "schema_version": 1
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.chrt.com/cargo_on_flight_integrations/cargoai/search/v1/cargo_on_flight_booking_id';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"destination_iata":"destination_iata","earliest_departure_date":"earliest_departure_date","origin_iata":"origin_iata","schema_version":1}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.chrt.com/cargo_on_flight_integrations/cargoai/search/v1/cargo_on_flight_booking_id"

	payload := strings.NewReader("{\n  \"destination_iata\": \"destination_iata\",\n  \"earliest_departure_date\": \"earliest_departure_date\",\n  \"origin_iata\": \"origin_iata\",\n  \"schema_version\": 1\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.chrt.com/cargo_on_flight_integrations/cargoai/search/v1/cargo_on_flight_booking_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"destination_iata\": \"destination_iata\",\n  \"earliest_departure_date\": \"earliest_departure_date\",\n  \"origin_iata\": \"origin_iata\",\n  \"schema_version\": 1\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.chrt.com/cargo_on_flight_integrations/cargoai/search/v1/cargo_on_flight_booking_id")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"destination_iata\": \"destination_iata\",\n  \"earliest_departure_date\": \"earliest_departure_date\",\n  \"origin_iata\": \"origin_iata\",\n  \"schema_version\": 1\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.chrt.com/cargo_on_flight_integrations/cargoai/search/v1/cargo_on_flight_booking_id', [
  'body' => '{
  "destination_iata": "destination_iata",
  "earliest_departure_date": "earliest_departure_date",
  "origin_iata": "origin_iata",
  "schema_version": 1
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.chrt.com/cargo_on_flight_integrations/cargoai/search/v1/cargo_on_flight_booking_id");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"destination_iata\": \"destination_iata\",\n  \"earliest_departure_date\": \"earliest_departure_date\",\n  \"origin_iata\": \"origin_iata\",\n  \"schema_version\": 1\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "destination_iata": "destination_iata",
  "earliest_departure_date": "earliest_departure_date",
  "origin_iata": "origin_iata",
  "schema_version": 1
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.chrt.com/cargo_on_flight_integrations/cargoai/search/v1/cargo_on_flight_booking_id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```