Send air waybill

POST

/cargo_on_flight_integrations/cargoai/air_waybills/send/v1/:cargo_on_flight_air_waybill_id

POST

/cargo_on_flight_integrations/cargoai/air_waybills/send/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.sendAirWaybillV1("cargo_on_flight_air_waybill_id", {
        send_fwb: true,
    });
}
main();

{
  "_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",
      "account_number": "account_number",
      "email": "email",
      "fax": "fax",
      "phone": "phone"
    },
    "shipper": {
      "address": {
        "country": {
          "code": "code"
        },
        "line1": "line1"
      },
      "name": "name",
      "account_number": "account_number",
      "email": "email",
      "fax": "fax",
      "phone": "phone"
    },
    "userCompanyName": "userCompanyName",
    "userEmail": "userEmail",
    "agent": {
      "iata": "iata",
      "name": "name",
      "place": "place",
      "accountNumber": "accountNumber",
      "cass": "cass"
    },
    "chargesDeclaration": {
      "charge_code": "charge_code",
      "currency_code": "currency_code",
      "values_for_carriage": 1.1,
      "values_for_custom": 1.1,
      "values_for_insurance": 1.1,
      "weight_or_valuation": "P"
    },
    "customsOrigin": "customsOrigin",
    "execution": {
      "carrier_signature": "carrier_signature",
      "date": "date",
      "place": "place",
      "shipper_signature": "shipper_signature"
    },
    "handling": {
      "otherServiceInformation": "otherServiceInformation",
      "specialHandling": [
        {
          "code": "code"
        }
      ],
      "specialServiceInformation": "specialServiceInformation"
    },
    "hawbs": [
      {
        "gross_weight": {
          "uom": "K",
          "value": 1.1
        },
        "hawb_number": "hawb_number",
        "locations": {
          "port_of_destination": {
            "code": "code"
          },
          "port_of_origin": {
            "code": "code"
          }
        },
        "mawbNumber": "mawbNumber",
        "number_of_pieces": 1
      }
    ],
    "isFhlOnly": true,
    "notify": {
      "address": {
        "country": {
          "code": "code"
        },
        "line1": "line1"
      },
      "name": "name",
      "account_number": "account_number",
      "email": "email",
      "fax": "fax",
      "phone": "phone"
    },
    "oci": {
      "origin_country_code": "origin_country_code",
      "security": {
        "issuer_type": "RA",
        "regulated_agent": "regulated_agent",
        "security_status": "security_status"
      }
    },
    "otherCharges": [
      {
        "charge_amount": 1.1,
        "charge_code": "charge_code",
        "entitlement_code": "A",
        "pc_indicator": "P"
      }
    ],
    "rates": [
      {
        "gross_weight": {
          "uom": "K",
          "value": 1.1
        },
        "number_of_pieces": 1,
        "rate_class_code": "rate_class_code"
      }
    ],
    "routingDetails": [
      {
        "carrier_code": "carrier_code",
        "from_airport_code": "from_airport_code",
        "to_airport_code": "to_airport_code"
      }
    ]
  },
  "schema_version": 1,
  "send_status": "pending",
  "updated_at_timestamp": "2024-01-15T09:30:00Z",
  "cargo_on_flight_house_air_waybill_ids": [
    "cargo_on_flight_house_air_waybill_ids"
  ],
  "pending_until_timestamp": "2024-01-15T09:30:00Z",
  "response_error_message": "response_error_message",
  "response_status_code": 1
}

Sends an air waybill’s FWB and/or the FHL for chosen house air waybills to the airline through CargoAi; the airline answers later. | authz_personas=[task_group_coordinator_operators] | (CargoOnFlightIntegrationsCargoAiSendAirWaybillReq) -> (CargoAiAirWaybillMessage1)

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.

send_fwbbooleanRequired

cargo_on_flight_house_air_waybill_idslist of stringsOptional

Response

Successful Response

_idstring

awb_numberstringformat: "^\d{3}-\d{8}$"

IATA Air Waybill number: 3-digit airline prefix + 8-digit serial, e.g. '020-12345678'.

cargo_on_flight_air_waybill_idstring

cargo_on_flight_booking_idstring

cargo_on_flight_integration"cargoai"

created_at_timestampdatetime

created_by_org_idstring

Must be a string starting with org_

fwb_sentboolean

requestobject

schema_versioninteger

send_statusenum

Allowed values:

updated_at_timestampdatetime

cargo_on_flight_house_air_waybill_idslist of stringsOptional

pending_until_timestampdatetime or nullOptional

response_error_messagestring or nullOptional

response_status_codeinteger or nullOptional

Errors

422

Cargoai Send Air Waybill V1request Unprocessable Entity Error