Void

POST

/orgs/air_waybill_stock_numbers/void/v1

POST

/orgs/air_waybill_stock_numbers/void/v1

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.orgs.airWaybillStockNumbers.voidV1({
        awb_numbers: [
            "awb_numbers",
        ],
    });
}
main();

[
  {
    "_id": "_id",
    "awb_number": "awb_number",
    "created_at_timestamp": "2024-01-15T09:30:00Z",
    "created_by_user_id": "created_by_user_id",
    "owned_by_org_id": "owned_by_org_id",
    "schema_version": 1,
    "status": "available",
    "status_changed_at_timestamp": "2024-01-15T09:30:00Z",
    "cargo_on_flight_booking_id": "cargo_on_flight_booking_id",
    "status_changed_by_user_id": "status_changed_by_user_id",
    "status_note": "status_note"
  }
]

Voids available AWB numbers of the caller’s organization’s AWB stock, e.g. spoiled or returned to the airline. | authz: min_org_role=operator | (AirWaybillStockNumbersVoidReq) -> (list[AirWaybillStockNumber1])

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

awb_numberslist of stringsRequired

status_notestringOptional>=1 character

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’.

created_at_timestampdatetime

created_by_user_idstring

Must be a string starting with user_

owned_by_org_idstring

Must be a string starting with org_

schema_versioninteger

statusenum

Allowed values:

status_changed_at_timestampdatetime

cargo_on_flight_booking_idstringOptional

status_changed_by_user_idstringOptional

Must be a string starting with user_

status_notestringOptional

Errors

422

Air Waybill Stock Numbers Void V1request Unprocessable Entity Error