Cancel

POST

/shipping/cargo_on_flight_bookings/cancel/v1/:cargo_on_flight_booking_id

POST

/shipping/cargo_on_flight_bookings/cancel/v1/:cargo_on_flight_booking_id

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

{
  "_id": "_id",
  "cargo_on_flight_integration": "cargoai",
  "created_by_org_id": "created_by_org_id",
  "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
  "order_id": "order_id",
  "order_short_id": "order_short_id",
  "schema_version": 1,
  "status": "draft",
  "task_group_id": "task_group_id",
  "awb_number": "awb_number",
  "booked_itinerary": {
    "carrier_iata": "carrier_iata",
    "latest_acceptance_utc": "2024-01-15T09:30:00Z",
    "legs": [
      {
        "carrier_iata": "carrier_iata",
        "destination_iata": "destination_iata",
        "flight_number": "flight_number",
        "origin_iata": "origin_iata",
        "scheduled_arrival_utc": "2024-01-15T09:30:00Z",
        "scheduled_departure_utc": "2024-01-15T09:30:00Z",
        "surface_transport": true
      }
    ],
    "time_of_availability_utc": "2024-01-15T09:30:00Z"
  },
  "booked_rate": {
    "currency_code": "currency_code",
    "total_amount": 1.1,
    "integration_rate_id": "integration_rate_id",
    "rate_name": "rate_name"
  },
  "cancellation_requested_at_timestamp": "2024-01-15T09:30:00Z",
  "cancelled_at_timestamp": "2024-01-15T09:30:00Z",
  "cargo_dimensions": [
    {
      "height_inches": 1.1,
      "length_inches": 1.1,
      "quantity": 1,
      "weight_per_piece_pounds": 1.1,
      "width_inches": 1.1,
      "stackable": true,
      "turnable": true
    }
  ],
  "cargo_ids": [
    "cargo_ids"
  ],
  "cargo_on_flight_booking_search_id": "cargo_on_flight_booking_search_id",
  "confirmed_at_timestamp": "2024-01-15T09:30:00Z",
  "created_by_user_id": "created_by_user_id",
  "failed_at_timestamp": "2024-01-15T09:30:00Z",
  "flight_leg_ids": [
    "flight_leg_ids"
  ],
  "iata_cass_office_id": "iata_cass_office_id",
  "integration_status": "integration_status",
  "rejected_at_timestamp": "2024-01-15T09:30:00Z",
  "requested_at_timestamp": "2024-01-15T09:30:00Z"
}

Cancels a MANUAL booking, removing the flights it created from the task group and its AWB from its cargos; an integration booking is cancelled through its integration. | authz_personas=[task_group_coordinator_operators] | () -> (CargoOnFlightBooking1)

Authentication

AuthorizationBearer

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

Path parameters

cargo_on_flight_booking_idstringRequired

Response

Successful Response

_idstring

cargo_on_flight_integrationenum

Allowed values:

created_by_org_idstring

Must be a string starting with org_

draft_started_at_timestampdatetime

order_idstring

order_short_idstring

schema_versioninteger

statusenum

task_group_idstring

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

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

booked_itineraryobjectOptional

The itinerary of the search result a booking was placed on.

booked_rateobjectOptional

A price quoted for a shipment: one of a search result's rates, or the price a MANUAL booking was quoted.

cancellation_requested_at_timestampdatetimeOptional

cancelled_at_timestampdatetimeOptional

cargo_dimensionslist of objectsOptional

cargo_idslist of stringsOptional

cargo_on_flight_booking_search_idstringOptional

confirmed_at_timestampdatetimeOptional

created_by_user_idstringOptional

Must be a string starting with user_

failed_at_timestampdatetimeOptional

flight_leg_idslist of stringsOptional

iata_cass_office_idstringOptional

integration_statusstringOptional

rejected_at_timestampdatetimeOptional

requested_at_timestampdatetimeOptional

Errors

422

Cargo on Flight Bookings Cancel V1request Unprocessable Entity Error