Simulate airline response

POST

/cargo_on_flight_integrations/cargoai/air_waybills/simulate_airline_response/v1/:cargo_on_flight_air_waybill_id

POST

/cargo_on_flight_integrations/cargoai/air_waybills/simulate_airline_response/v1/:cargo_on_flight_air_waybill_id

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.cargoOnFlightIntegrations.cargoai.simulateAirlineResponseV1("cargo_on_flight_air_waybill_id", {});
}
main();

{
  "cargo_on_flight_air_waybill": {
    "_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",
      "declared_value_for_carriage": 1.1,
      "declared_value_for_customs": 1.1,
      "declared_value_for_insurance": 1.1,
      "payment_other_charges": "prepaid",
      "payment_weight_valuation": "prepaid"
    },
    "consignee": {
      "address_line_1": "address_line_1",
      "city_name": "city_name",
      "country_code": "country_code",
      "name": "name",
      "account_number": "account_number",
      "address_line_2": "address_line_2",
      "city_iata": "city_iata",
      "email_address": "email_address",
      "fax_number": "fax_number",
      "phone_number": "phone_number",
      "postal_code": "postal_code",
      "state_province": "state_province"
    },
    "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",
      "account_number": "account_number",
      "address_line_2": "address_line_2",
      "city_iata": "city_iata",
      "email_address": "email_address",
      "fax_number": "fax_number",
      "phone_number": "phone_number",
      "postal_code": "postal_code",
      "state_province": "state_province"
    },
    "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",
      "account_number": "account_number",
      "address_line_2": "address_line_2",
      "city_iata": "city_iata",
      "email_address": "email_address",
      "fax_number": "fax_number",
      "phone_number": "phone_number",
      "postal_code": "postal_code",
      "state_province": "state_province"
    },
    "consignment_security_declaration": {
      "country_code": "country_code",
      "regulated_entity_category": "regulated_agent",
      "regulated_entity_identifier": "regulated_entity_identifier",
      "security_status": "SPX",
      "expiry_mmyy": "expiry_mmyy",
      "screened_at_timestamp": "2024-01-15T09:30:00Z",
      "screener_name": "screener_name",
      "screening_exemption": "SMUS",
      "screening_methods": [
        "PHS"
      ]
    },
    "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",
      "airline_response": "airline_response",
      "responded_at_timestamp": "2024-01-15T09:30:00Z",
      "responded_by_user_id": "responded_by_user_id",
      "response_provenance": "airline"
    },
    "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"
  },
  "cargo_on_flight_house_air_waybills": [
    {
      "_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
    }
  ]
}

For demos and testing: answers a sent FWB and/or the FHLs of chosen house air waybills as the airline would, accepted or rejected, for a demo AWB (prefix 000) whose Mock Airline never answers. | authz_personas=[task_group_coordinator_operators] | (CargoOnFlightIntegrationsCargoAiSimulateAirlineResponseReq) -> (CargoOnFlightIntegrationsCargoAiSimulateAirlineResponseRes)

Authentication

AuthorizationBearer

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

Path parameters

cargo_on_flight_air_waybill_idstringRequired

Request

This endpoint expects an object.

airline_responsestringOptional>=1 characterDefaults to Simulated airline answer for a demo AWB

fwb_statusenum or nullOptional

Allowed values:

houseslist of objectsOptional

Response

Successful Response

cargo_on_flight_air_waybillobject

cargo_on_flight_house_air_waybillslist of objectsOptional

Errors

422

Cargoai Simulate Airline Response V1request Unprocessable Entity Error