List

GET

/shipping/cargo_on_flight_air_waybills/list/v1

GET

/shipping/cargo_on_flight_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.cargoOnFlightAirWaybills.listV1({
        filter_cargo_on_flight_booking_id: "filter_cargo_on_flight_booking_id",
        page: 1,
        page_size: 1,
        sort_by: "created_at_timestamp",
        sort_order: "asc",
        task_group_id: "task_group_id",
    });
}
main();

{
  "items": [
    {
      "_id": "_id",
      "cargo_on_flight_booking_id": "cargo_on_flight_booking_id",
      "carriers_execution": {
        "authorisation_signature": "authorisation_signature",
        "executed_on_date": "executed_on_date",
        "place": "place"
      },
      "charges_declaration": {
        "charge_code": "CA",
        "currency_code": "currency_code"
      },
      "consignee": {
        "address_line_1": "address_line_1",
        "city_name": "city_name",
        "country_code": "country_code",
        "name": "name"
      },
      "created_at_timestamp": "2024-01-15T09:30:00Z",
      "created_by_org_id": "created_by_org_id",
      "iata_cass_office_id": "iata_cass_office_id",
      "order_id": "order_id",
      "schema_version": 1,
      "shipper": {
        "address_line_1": "address_line_1",
        "city_name": "city_name",
        "country_code": "country_code",
        "name": "name"
      },
      "shippers_certification": "shippers_certification",
      "task_group_id": "task_group_id",
      "updated_at_timestamp": "2024-01-15T09:30:00Z",
      "also_notify": {
        "address_line_1": "address_line_1",
        "city_name": "city_name",
        "country_code": "country_code",
        "name": "name"
      },
      "consignment_security_declaration": {
        "country_code": "country_code",
        "regulated_entity_category": "regulated_agent",
        "regulated_entity_identifier": "regulated_entity_identifier",
        "security_status": "SPX"
      },
      "created_by_user_id": "created_by_user_id",
      "customs_origin_code": "customs_origin_code",
      "issuing_agent_name": "issuing_agent_name",
      "latest_fwb_message": {
        "cargo_on_flight_integration": "air_canada",
        "sent_at_timestamp": "2024-01-15T09:30:00Z",
        "status": "sent"
      },
      "other_charges": [
        {
          "charge_amount": 1.1,
          "entitlement": "due_agent",
          "other_charge_code": "other_charge_code",
          "payment_condition": "prepaid"
        }
      ],
      "other_service_information": "other_service_information",
      "rate_lines": [
        {
          "gross_weight_kilograms": 1.1,
          "nature_and_quantity_of_goods": "nature_and_quantity_of_goods",
          "number_of_pieces": 1,
          "rate_class_code": "B"
        }
      ],
      "special_service_request": "special_service_request"
    }
  ],
  "total_count": 1
}

Lists a flight task group’s air waybills, one per cargo-on-flight booking. | authz_personas=[task_group_coordinator_operators] | () -> (CargoOnFlightAirWaybillListRes)

Authentication

AuthorizationBearer

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

Query parameters

task_group_idstringRequired

The task group whose air waybills are listed.

filter_cargo_on_flight_booking_idstring or nullOptional

Filter by booking.

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 Air Waybills List V1request Unprocessable Entity Error