List

GET

/shipping/cargo_on_flight_booking_searches/list/v1

GET

/shipping/cargo_on_flight_booking_searches/list/v1

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.shipping.cargoOnFlightBookingSearches.listV1({
        cargo_on_flight_booking_id: "cargo_on_flight_booking_id",
        filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
        filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
        page: 1,
        page_size: 1,
        sort_by: "created_at_timestamp",
        sort_order: "asc",
    });
}
main();

{
  "items": [
    {
      "_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",
          "latest_acceptance_utc": null,
          "not_bookable_reason": null,
          "time_of_availability_utc": null
        }
      ]
    }
  ],
  "total_count": 1
}

Lists a cargo-on-flight booking’s searches with their results. | authz_personas=[task_group_coordinator_operators] | () -> (CargoOnFlightBookingSearchListRes)

Authentication

AuthorizationBearer

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

Query parameters

cargo_on_flight_booking_idstringRequired

The booking whose searches are listed.

filter_created_at_timestamp_gtedatetimeOptional

Filter created_at_timestamp >= value.

filter_created_at_timestamp_ltedatetimeOptional

Filter created_at_timestamp <= value.

sort_by"created_at_timestamp"Optional

Field to sort by.

sort_orderenumOptional

Sort order.

Allowed values:

pageintegerOptional>=1Defaults to 1

page_sizeintegerOptional1-100Defaults to 20

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Cargo on Flight Booking Searches List V1request Unprocessable Entity Error