List

GET

/shipping/cargo_on_flight_bookings/list/v1

GET

/shipping/cargo_on_flight_bookings/list/v1

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.shipping.cargoOnFlightBookings.listV1({
        filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
        filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
        filter_status: [
            "draft",
        ],
        page: 1,
        page_size: 1,
        sort_by: "draft_started_at_timestamp",
        sort_order: "asc",
        task_group_id: "task_group_id",
    });
}
main();

{
  "items": [
    {
      "_id": "_id",
      "cargo_on_flight_integration": "air_canada",
      "created_by_org_id": "created_by_org_id",
      "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
      "order_id": "order_id",
      "order_short_id": "order_short_id",
      "schema_version": 1,
      "status": "draft",
      "task_group_id": "task_group_id",
      "airline_cargo_account_id": "airline_cargo_account_id",
      "awb_number": "awb_number",
      "booked_itinerary": {
        "carrier_iata": "carrier_iata",
        "latest_acceptance_utc": null,
        "time_of_availability_utc": null
      },
      "booked_rate": {
        "currency_code": "currency_code",
        "total_amount": 1.1,
        "integration_rate_id": null,
        "rate_name": null
      },
      "cancellation_requested_at_timestamp": "2024-01-15T09:30:00Z",
      "cancelled_at_timestamp": "2024-01-15T09:30:00Z",
      "cargo_dimensions": [
        {
          "height_inches": 1.1,
          "length_inches": 1.1,
          "quantity": 1,
          "weight_per_piece_pounds": 1.1,
          "width_inches": 1.1
        }
      ],
      "cargo_ids": [
        "cargo_ids"
      ],
      "cargo_on_flight_booking_search_id": "cargo_on_flight_booking_search_id",
      "confirmed_at_timestamp": "2024-01-15T09:30:00Z",
      "created_by_user_id": "created_by_user_id",
      "failed_at_timestamp": "2024-01-15T09:30:00Z",
      "flight_leg_ids": [
        "flight_leg_ids"
      ],
      "iata_cass_office_id": "iata_cass_office_id",
      "integration_status": "integration_status",
      "rejected_at_timestamp": "2024-01-15T09:30:00Z",
      "requested_at_timestamp": "2024-01-15T09:30:00Z",
      "special_handling_codes": [
        "ACT"
      ]
    }
  ],
  "total_count": 1
}

Lists a flight task group’s cargo-on-flight bookings, active and history. | authz_personas=[task_group_coordinator_operators] | () -> (CargoOnFlightBookingListRes)

Authentication

AuthorizationBearer

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

Query parameters

task_group_idstringRequired

The task group whose bookings are listed.

filter_statusenumOptional

Filter by status(es).

filter_draft_started_at_timestamp_gtedatetimeOptional

Filter draft_started_at_timestamp >= value.

filter_draft_started_at_timestamp_ltedatetimeOptional

Filter draft_started_at_timestamp <= value.

sort_by"draft_started_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 Bookings List V1request Unprocessable Entity Error