Update

PATCH

/shipping/cargo_on_flight_house_air_waybills/update/v1/:cargo_on_flight_house_air_waybill_id

PATCH

/shipping/cargo_on_flight_house_air_waybills/update/v1/:cargo_on_flight_house_air_waybill_id

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.shipping.cargoOnFlightHouseAirWaybills.updateV1("cargo_on_flight_house_air_waybill_id", {});
}
main();

{
  "_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",
    "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"
  },
  "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",
    "airline_response": "airline_response",
    "responded_at_timestamp": "2024-01-15T09:30:00Z",
    "responded_by_user_id": "responded_by_user_id",
    "response_provenance": "airline"
  },
  "slac": 1
}

Updates a house air waybill, all but its number; one already sent is replaced at the airline only when it is sent again. | authz_personas=[task_group_coordinator_operators] | (CargoOnFlightHouseAirWaybillClientUpdate1) -> (CargoOnFlightHouseAirWaybill1)

Authentication

AuthorizationBearer

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

Path parameters

cargo_on_flight_house_air_waybill_idstringRequired

Request

This endpoint expects an object.

charges_declarationobject or nullOptional

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

charges_declaration__set_to_NonebooleanOptionalDefaults to false

destination_iatastring or nullOptionalformat: "^[A-Z]{3}$"

gross_weight_kilogramsdouble or nullOptional

manifest_description_of_goodsstring or nullOptional1-15 characters

number_of_piecesinteger or nullOptional1-9999

origin_iatastring or nullOptionalformat: "^[A-Z]{3}$"

slacinteger or nullOptional1-99999

slac__set_to_NonebooleanOptionalDefaults to false

Response

Successful Response

_idstring

cargo_on_flight_air_waybill_idstring

cargo_on_flight_booking_idstring

created_at_timestampdatetime

created_by_org_idstring

Must be a string starting with org_

destination_iatastring

gross_weight_kilogramsdouble

house_air_waybill_numberstring

manifest_description_of_goodsstring

number_of_piecesinteger

origin_iatastring

schema_versioninteger

task_group_idstring

updated_at_timestampdatetime

charges_declarationobject or nullOptional

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

created_by_user_idstring or nullOptional

Must be a string starting with user_

latest_fhl_messageobject or nullOptional

The latest send of the house in an FHL, and the airline's answer to it.

slacinteger or nullOptional

Errors

422

Cargo on Flight House Air Waybills Update V1request Unprocessable Entity Error