List air waybill messages

GET

/cargo_on_flight_integrations/cargoai/air_waybills/messages/list/v1

GET

/cargo_on_flight_integrations/cargoai/air_waybills/messages/list/v1

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.cargoOnFlightIntegrations.cargoai.listAirWaybillMessagesV1({
        cargo_on_flight_air_waybill_id: "cargo_on_flight_air_waybill_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": [
    {
      "cargoai_air_waybill_message": {
        "_id": "_id",
        "awb_number": "awb_number",
        "cargo_on_flight_air_waybill_id": "cargo_on_flight_air_waybill_id",
        "cargo_on_flight_booking_id": "cargo_on_flight_booking_id",
        "cargo_on_flight_integration": "cargoai",
        "created_at_timestamp": "2024-01-15T09:30:00Z",
        "created_by_org_id": "created_by_org_id",
        "fwb_sent": true,
        "request": {
          "awb_number": "awb_number",
          "awb_status": "PENDING_DELIVERY",
          "consignee": {
            "address": {
              "country": {
                "code": "code"
              },
              "line1": "line1"
            },
            "name": "name"
          },
          "shipper": {
            "address": {
              "country": {
                "code": "code"
              },
              "line1": "line1"
            },
            "name": "name"
          },
          "userCompanyName": "userCompanyName",
          "userEmail": "userEmail"
        },
        "schema_version": 1,
        "send_status": "pending",
        "updated_at_timestamp": "2024-01-15T09:30:00Z"
      },
      "cargoai_air_waybill_message_webhook_events": [
        {
          "_id": "_id",
          "payload": {
            "key": "value"
          },
          "received_at_timestamp": "2024-01-15T09:30:00Z",
          "schema_version": 1
        }
      ]
    }
  ],
  "total_count": 1
}

Lists what was sent to CargoAi for an air waybill and every airline answer received for each send. | authz_personas=[task_group_coordinator_operators] | () -> (CargoOnFlightIntegrationsCargoAiAirWaybillMessageListRes)

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 sends are listed.

filter_created_at_timestamp_gtedatetime or nullOptional

Only sends created at or after this timestamp.

filter_created_at_timestamp_ltedatetime or nullOptional

Only sends created at or before this timestamp.

sort_by"created_at_timestamp" or nullOptional

Field to sort by.

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

Cargoai List Air Waybill Messages V1request Unprocessable Entity Error