Get

GET

/shipping/cargo_on_flight_booking_searches/v1/:cargo_on_flight_booking_search_id

GET

/shipping/cargo_on_flight_booking_searches/v1/:cargo_on_flight_booking_search_id

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.shipping.cargoOnFlightBookingSearches.getV1("cargo_on_flight_booking_search_id", {
        filter_aircraft_body_type: "widebody",
        filter_awb_required: true,
        filter_bookable: true,
        filter_currency_code: "filter_currency_code",
        sort_by: "departure",
        sort_order: "asc",
    });
}
main();

{
  "_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",
  "airline_cargo_account_id": "airline_cargo_account_id",
  "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"
    }
  ]
}

Retrieves a cargo-on-flight booking search with its results, optionally filtered and sorted. | authz_personas=[task_group_coordinator_operators] | () -> (CargoOnFlightBookingSearch1)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

cargo_on_flight_booking_search_idstringRequired

Query parameters

filter_bookablebooleanOptional

Filter results the integration accepts through its API.

filter_awb_requiredbooleanOptional

Filter results that need the user's own AWB.

filter_aircraft_body_typeenumOptional

Filter results whose every flown leg is on this body type.

Allowed values:

filter_currency_codestringOptionalformat: "^[A-Z]{3}$"

Keep only rates in this currency, and results with one.

sort_byenumOptional

Field to sort results by; price needs filter_currency_code.

Allowed values:

sort_orderenumOptional

Sort order.

Allowed values:

Response

Successful Response

_idstring

cargo_on_flight_booking_idstring

cargo_on_flight_integrationenum

Allowed values:

created_at_timestampdatetime

created_by_org_idstring

Must be a string starting with org_

destination_iatastring

earliest_departure_datestringformat: "date"

integration_search_idstring

origin_iatastring

schema_versioninteger

search_completedboolean

updated_at_timestampdatetime

airline_cargo_account_idstringOptional

created_by_user_idstringOptional

Must be a string starting with user_

iata_cass_office_idstringOptional

offset_daysintegerOptionalDefaults to 5

resultslist of objectsOptional

Errors

422

Cargo on Flight Booking Searches Get V1request Unprocessable Entity Error