List

GET

/shipping/cargo_on_flight_house_air_waybills/list/v1

GET

/shipping/cargo_on_flight_house_air_waybills/list/v1

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.shipping.cargoOnFlightHouseAirWaybills.listV1({
        cargo_on_flight_air_waybill_id: "cargo_on_flight_air_waybill_id",
        page: 1,
        page_size: 1,
        sort_by: "created_at_timestamp",
        sort_order: "asc",
    });
}
main();

{
  "items": [
    {
      "_id": "_id",
      "cargo_on_flight_air_waybill_id": "cargo_on_flight_air_waybill_id",
      "cargo_on_flight_booking_id": "cargo_on_flight_booking_id",
      "created_at_timestamp": "2024-01-15T09:30:00Z",
      "created_by_org_id": "created_by_org_id",
      "destination_iata": "destination_iata",
      "gross_weight_kilograms": 1.1,
      "house_air_waybill_number": "house_air_waybill_number",
      "manifest_description_of_goods": "manifest_description_of_goods",
      "number_of_pieces": 1,
      "origin_iata": "origin_iata",
      "schema_version": 1,
      "task_group_id": "task_group_id",
      "updated_at_timestamp": "2024-01-15T09:30:00Z",
      "charges_declaration": {
        "charge_code": "CA",
        "currency_code": "currency_code"
      },
      "created_by_user_id": "created_by_user_id",
      "latest_fhl_message": {
        "cargo_on_flight_integration": "air_canada",
        "sent_at_timestamp": "2024-01-15T09:30:00Z",
        "status": "sent"
      },
      "slac": 1
    }
  ],
  "total_count": 1
}

Lists the house air waybills consolidated under an air waybill. | authz_personas=[task_group_coordinator_operators] | () -> (CargoOnFlightHouseAirWaybillListRes)

Authentication

AuthorizationBearer

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

Query parameters

cargo_on_flight_air_waybill_idstringRequired

The air waybill whose houses are listed.

sort_byenum or nullOptional

Field to sort by.

Allowed values:

sort_orderenum or nullOptional

Sort order.

Allowed values:

pageinteger or nullOptional>=1Defaults to 1

page_sizeinteger or nullOptional1-100Defaults to 20

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Cargo on Flight House Air Waybills List V1request Unprocessable Entity Error