Create

POST

/shipping/cargo_on_flight_air_waybills/create/v1

POST

/shipping/cargo_on_flight_air_waybills/create/v1

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.shipping.cargoOnFlightAirWaybills.createV1({
        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",
        },
        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",
            },
        ],
        schema_version: 1,
        shipper: {
            address_line_1: "address_line_1",
            city_name: "city_name",
            country_code: "country_code",
            name: "name",
        },
        shippers_certification: "shippers_certification",
    });
}
main();

{
  "_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": "cargoai",
    "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",
      "chargeable_weight_kilograms": 1.1,
      "commodity_item_number": "commodity_item_number",
      "dimensions": [
        {
          "height_inches": 1.1,
          "length_inches": 1.1,
          "number_of_pieces": 1,
          "width_inches": 1.1
        }
      ],
      "harmonized_commodity_codes": [
        "harmonized_commodity_codes"
      ],
      "rate_or_charge": 1.1,
      "total_charge_amount": 1.1,
      "uld_numbers": [
        "uld_numbers"
      ],
      "volume_cubic_meters": 1.1
    }
  ],
  "special_service_request": "special_service_request"
}

Creates the air waybill for a confirmed cargo-on-flight booking: the parties, rating, charges, and security declaration sent to the airline as an FWB. | authz_personas=[task_group_coordinator_operators] | (CargoOnFlightAirWaybillClientCreate1) -> (CargoOnFlightAirWaybill1)

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

cargo_on_flight_booking_idstringRequired

carriers_executionobjectRequired

When, where, and by whom the AWB was executed for the carrier (usually the agent).

charges_declarationobjectRequired

Currency, payment, and declared values, for the master or a house air waybill.

consigneeobjectRequired

A shipper, consignee, or also-notify party.

rate_lineslist of objectsRequired

schema_versionintegerRequired

shipperobjectRequired

A shipper, consignee, or also-notify party.

shippers_certificationstringRequired1-20 characters

also_notifyobject or nullOptional

A shipper, consignee, or also-notify party.

consignment_security_declarationobject or nullOptional

The OCI consignment security declaration (e-CSD).

customs_origin_codestring or nullOptionalformat: "^[A-Z0-9]{1,2}$"

iata_cass_office_idstring or nullOptional

issuing_agent_namestring or nullOptional1-35 characters

other_chargeslist of objectsOptional

other_service_informationstring or nullOptional<=65 characters

special_service_requeststring or nullOptional<=65 characters

Response

Successful Response

_idstring

cargo_on_flight_booking_idstring

carriers_executionobject

When, where, and by whom the AWB was executed for the carrier (usually the agent).

charges_declarationobject

Currency, payment, and declared values, for the master or a house air waybill.

consigneeobject

A shipper, consignee, or also-notify party.

created_at_timestampdatetime

created_by_org_idstring

Must be a string starting with org_

iata_cass_office_idstring

order_idstring

schema_versioninteger

shipperobject

A shipper, consignee, or also-notify party.

shippers_certificationstring

task_group_idstring

updated_at_timestampdatetime

also_notifyobject or nullOptional

A shipper, consignee, or also-notify party.

consignment_security_declarationobject or nullOptional

The OCI consignment security declaration (e-CSD).

created_by_user_idstring or nullOptional

Must be a string starting with user_

customs_origin_codestring or nullOptional

issuing_agent_namestring or nullOptional1-35 characters

latest_fwb_messageobject or nullOptional

The latest send of the FWB, and the airline's answer to it.

other_chargeslist of objectsOptional

other_service_informationstring or nullOptional

rate_lineslist of objectsOptional

special_service_requeststring or nullOptional

Errors

422

Cargo on Flight Air Waybills Create V1request Unprocessable Entity Error