---
title: "Update air waybill fields"
method: PATCH
path: "/integrations/air_waybills/update/v1/{task_group_id}"
tags: ["/integrations/air_waybills"]
---

# Update air waybill fields

`PATCH /integrations/air_waybills/update/v1/{task_group_id}`

Updates fields on an existing CHAMP air waybill. Any editable field can be set — only fields included in the request body are changed. | (ChampAirWaybillClientUpdate1) -> (ChampAirWaybill1)

## Path parameters

- `task_group_id` string, required

## Request body

- ChampAirWaybillClientUpdate1 — Partial update — all fields Optional, exclude_unset. Excludes air_waybill_number, origin, destination (non-editable after creation).
  - `total_consignment_number_of_pieces` integer, nullable
  - `weight` CargojsonWeight — Reusable weight amount + unit pair. Used for: - AirWayBill.weight -> [WEBCARGO] <NetWeight> (gross weight) - Charge.chargeable_weight -> [WEBCARGO] <TotalChargeableWeight> (billing weight) - ChargeItem.gross_weight -> [WEBCARGO] <NetWeight>
    - `amount` number, required
    - `unit` 'KILOGRAM' | 'POUND'
  - `volume` CargojsonVolume — [WEBCARGO] Volume from <NetVolumeMeasure>.
    - `amount` number, required
    - `unit` 'CUBIC_CENTIMETRE' | 'CUBIC_FOOT' | 'CUBIC_INCH' | 'CUBIC_METRE'
  - `charge_items` CargojsonChargeItem[], nullable
    - `numberOfPieces` integer, nullable
    - `rateCombinationPointCityCode` string, nullable
    - `commodityItemNumber` string[], nullable
    - `goodsDescription` string, nullable
    - `grossWeight` CargojsonWeight — Reusable weight amount + unit pair. Used for: - AirWayBill.weight -> [WEBCARGO] <NetWeight> (gross weight) - Charge.chargeable_weight -> [WEBCARGO] <TotalChargeableWeight> (billing weight) - ChargeItem.gross_weight -> [WEBCARGO] <NetWeight>
      - `amount` number, required
      - `unit` 'KILOGRAM' | 'POUND'
    - `consolidation` boolean
    - `harmonisedCommodityCode` string[], nullable
    - `isoCountryCodeOfOriginOfGoods` string, nullable
    - `packaging` CargojsonPackaging[], nullable
      - `numberOfPieces` integer, nullable
      - `weight` CargojsonWeight — Reusable weight amount + unit pair. Used for: - AirWayBill.weight -> [WEBCARGO] <NetWeight> (gross weight) - Charge.chargeable_weight -> [WEBCARGO] <TotalChargeableWeight> (billing weight) - ChargeItem.gross_weight -> [WEBCARGO] <NetWeight>
        - `amount` number, required
        - `unit` 'KILOGRAM' | 'POUND'
      - `volume` CargojsonVolume — [WEBCARGO] Volume from <NetVolumeMeasure>.
        - `amount` number, required
        - `unit` 'CUBIC_CENTIMETRE' | 'CUBIC_FOOT' | 'CUBIC_INCH' | 'CUBIC_METRE'
      - `dimensions` CargojsonDimensions — [WEBCARGO/CUSTOMER] Package dimensions from <Dimension> or customer input.
        - `unit` 'CENTIMETRE' | 'DECIMETRE' | 'FOOT' | 'INCH' | 'METRE' | 'MILLIMETRE' | 'YARD' — Java source calls this LengthUnit; we use DimensionUnit since it describes all three axes (length, width, height) in CargojsonDimensions.
        - `length` integer, required
        - `width` integer, required
        - `height` integer, required
      - `uld` CargojsonULD — [CUSTOMER] Unit Load Device (ULD) container details.
        - `type` string, required
        - `serialNumber` string, required
        - `ownerCode` string, required
        - `loadingIndicator` string, nullable
        - `remarks` string, nullable
        - `weightOfULDContents` CargojsonWeight — Reusable weight amount + unit pair. Used for: - AirWayBill.weight -> [WEBCARGO] <NetWeight> (gross weight) - Charge.chargeable_weight -> [WEBCARGO] <TotalChargeableWeight> (billing weight) - ChargeItem.gross_weight -> [WEBCARGO] <NetWeight>
          - `amount` number, required
          - `unit` 'KILOGRAM' | 'POUND'
      - `shippersLoadAndCount` string, nullable
    - `charges` CargojsonCharge[], nullable
      - `chargeableWeight` CargojsonWeight — Reusable weight amount + unit pair. Used for: - AirWayBill.weight -> [WEBCARGO] <NetWeight> (gross weight) - Charge.chargeable_weight -> [WEBCARGO] <TotalChargeableWeight> (billing weight) - ChargeItem.gross_weight -> [WEBCARGO] <NetWeight>
        - `amount` number, required
        - `unit` 'KILOGRAM' | 'POUND'
      - `rateClassCode` 'BASIC_CHARGE' | 'CLASS_RATE_REDUCTION' | 'CLASS_RATE_SURCHARGE' | 'INTERNATIONAL_PRIORITY_SERVICE_RATE' | 'MINIMUM_CHARGE' | 'NORMAL_RATE' | 'QUANTITY_RATE' | 'RATE_PER_KILOGRAM' | 'SPECIFIC_COMMODITY_RATE' | 'UNIT_LOAD_DEVICE_ADDITIONAL_INFORMATION' | 'UNIT_LOAD_DEVICE_ADDITIONAL_RATE' | 'UNIT_LOAD_DEVIDE_BASIC_CHARGE_OR_RATE' | 'UNIT_LOAD_DEVICE_DISCOUNT' — https://github.com/champ-cargosystems-gmbh/cargojson.champ.aero/blob/master/src/main/java/aero/champ/cargojson/common/RateClassCode.java
      - `rateClassCodeBasis` 'BASIC_CHARGE' | 'CLASS_RATE_REDUCTION' | 'CLASS_RATE_SURCHARGE' | 'INTERNATIONAL_PRIORITY_SERVICE_RATE' | 'MINIMUM_CHARGE' | 'NORMAL_RATE' | 'QUANTITY_RATE' | 'RATE_PER_KILOGRAM' | 'SPECIFIC_COMMODITY_RATE' | 'UNIT_LOAD_DEVICE_ADDITIONAL_INFORMATION' | 'UNIT_LOAD_DEVICE_ADDITIONAL_RATE' | 'UNIT_LOAD_DEVIDE_BASIC_CHARGE_OR_RATE' | 'UNIT_LOAD_DEVICE_DISCOUNT' — https://github.com/champ-cargosystems-gmbh/cargojson.champ.aero/blob/master/src/main/java/aero/champ/cargojson/common/RateClassCode.java
      - `classRatePercentage` number, nullable
      - `uldRateClassType` string, nullable
      - `rateOrCharge` number, nullable
      - `totalChargeAmount` number, nullable
    - `serviceCode` 'AIRPORT_TO_AIRPORT' | 'SERVICE_SHIPMENT' | 'COMPANY_MATERIAL' | 'DOOR_TO_DOOR_SERVICE' | 'AIRPORT_TO_DOOR' | 'FLIGHT_SPECIFIC' | 'DOOR_TO_AIRPORT' | 'COMPANY_MAIL' | 'DIPLOMATIC_MAIL' | 'PRIORITY_SERVICE' | 'UNDOCUMENTED_K' | 'UNDOCUMENTED_L' | 'UNDOCUMENTED_M' | 'UNDOCUMENTED_N' | 'UNDOCUMENTED_O' | 'SMALL_PACKAGE_SERVICE' | 'UNDOCUMENTED_Q' | 'UNDOCUMENTED_R' | 'SUBSTITUTE_TRUCK' | 'CHARTER' | 'UNDOCUMENTED_U' | 'UNDOCUMENTED_V' | 'UNDOCUMENTED_W' | 'EXPRESS_SHIPMENTS' | 'UNDOCUMENTED_Y' | 'UNDOCUMENTED_Z' — https://github.com/champ-cargosystems-gmbh/cargojson.champ.aero/blob/master/src/main/java/aero/champ/cargojson/common/ServiceCode.java
  - `flights` CargojsonFlightIdentity[], nullable
    - `flight` string, required
    - `scheduledDate` string, date, required
    - `scheduledTime` string, time, nullable
  - `iso_currency_code` string, nullable
  - `agent` CargojsonAgent — [WEBCARGO/CONFIG] Forwarder's IATA agent identification. Same identity as `iata` in WebcargoEmbedViewParams and OY party in bookingRecord XML.
    - `name` string, required
    - `place` string, required
    - `accountNumber` string, nullable
    - `iataCargoAgentNumericCode` string, nullable
    - `iataCargoAgentCASSAddress` string, nullable
    - `participantIdentifier` CargojsonParticipantIdentifier — [CONFIG] Identifies a participant in the movement of a shipment.
      - `identifier` 'AIR' | 'APT' | 'AGT' | 'BRK' | 'CAG' | 'CNE' | 'CTM' | 'DCL' | 'DEC' | 'FFW' | 'GHA' | 'PTT' | 'SHP' | 'TRK', required — https://github.com/champ-cargosystems-gmbh/cargojson.champ.aero/blob/master/src/main/java/aero/champ/cargojson/common/ParticipantType.java
      - `code` string, required
      - `airportCityCode` string, required
  - `route` CargojsonRouting[], nullable
    - `carrierCode` string, nullable
    - `destination` string, nullable
  - `shipper` CargojsonAccountContact — [CUSTOMER] Shipper or consignee with address and optional contact info. account_number is the IATA participant code (optional).
    - `accountNumber` string, nullable
    - `address` CargojsonAddress, required — [CUSTOMER] Postal address of shipper or consignee.
      - `name1` string, required
      - `name2` string, nullable
      - `streetAddress1` string, required
      - `streetAddress2` string, nullable
      - `place` string, required
      - `stateProvince` string, nullable
      - `country` string, required
      - `postCode` string, required
    - `contactDetails` CargojsonContactDetail[], nullable
      - `contactIdentifier` string, required
      - `contactNumber` string, required
  - `consignee` CargojsonAccountContact — [CUSTOMER] Shipper or consignee with address and optional contact info. account_number is the IATA participant code (optional).
    - `accountNumber` string, nullable
    - `address` CargojsonAddress, required — [CUSTOMER] Postal address of shipper or consignee.
      - `name1` string, required
      - `name2` string, nullable
      - `streetAddress1` string, required
      - `streetAddress2` string, nullable
      - `place` string, required
      - `stateProvince` string, nullable
      - `country` string, required
      - `postCode` string, required
    - `contactDetails` CargojsonContactDetail[], nullable
      - `contactIdentifier` string, required
      - `contactNumber` string, required
  - `charge_declarations` CargojsonChargeDeclarations — [CUSTOMER/WEBCARGO] Currency from WebCargo <PriceIndicator>, payment conditions from customer's commercial terms.
    - `isoCurrencyCode` string, required
    - `chargeCode` 'ALL_CHARGES_COLLECT' | 'ALL_CHARGES_COLLECT_BY_CREDIT_CARD' | 'ALL_CHARGES_COLLECT_BY_GBL' | 'ALL_CHARGES_PREPAID_CASH' | 'ALL_CHARGES_PREPAID_CREDIT' | 'ALL_CHARGES_PREPAID_BY_CREDIT_CARD' | 'ALL_CHARGES_PREPAID_BY_GBL' | 'DESTINATION_COLLECT_CASH' | 'DESTINATION_COLLECT_CREDIT' | 'DESTINATION_COLLECT_BY_MCO' | 'NO_CHARGE' | 'NO_WEIGHT_CHARGE_OTHER_CHARGES_COLLECT' | 'NO_WEIGHT_CHARGE_OTHER_CHARGES_PREPAID_BY_CREDIT_CARD' | 'NO_WEIGHT_CHARGE_OTHER_CHARGES_PREPAID_BY_GBL' | 'NO_WEIGHT_CHARGE_OTHER_CHARGES_PREPAID_CASH' | 'NO_WEIGHT_CHARGE_OTHER_CHARGES_PREPAID_CREDIT' | 'PARTIAL_COLLECT_CREDIT_PARTIAL_PREPAID_CASH' | 'PARTIAL_COLLECT_CREDIT_PARTIAL_PREPAID_CREDIT' | 'PARTIAL_COLLECT_CREDIT_CARD_PARTIAL_PREPAID_CASH' | 'PARTIAL_COLLECT_CREDIT_CARD_PARTIAL_PREPAID_CREDIT' | 'PARTIAL_PREPAID_CASH_PARTIAL_COLLECT_CASH' | 'PARTIAL_PREPAID_CREDIT_PARTIAL_COLLECT_CASH' | 'PARTIAL_PREPAID_CREDIT_CARD_PARTIAL_COLLECT_CASH' | 'PARTIAL_PREPAID_CREDIT_CARD_PARTIAL_COLLECT_CREDIT' | 'PARTIAL_PREPAID_CREDIT_CARD_PARTIAL_COLLECT_CREDIT_CARD' — https://github.com/champ-cargosystems-gmbh/cargojson.champ.aero/blob/master/src/main/java/aero/champ/cargojson/common/ChargeCode.java
    - `payment_WeightValuation` 'Collect' | 'Prepaid' — Prepaid/Collect indicator.
    - `payment_OtherCharges` 'Collect' | 'Prepaid' — Prepaid/Collect indicator.
    - `declaredValueForCarriage` number, nullable
    - `declaredValueForCustoms` number, nullable
    - `declaredValueForInsurance` number, nullable
  - `density_group` integer, nullable
  - `special_handling_codes` CargojsonSpecialHandlingCode[], nullable
  - `additional_special_handling_codes` string[], nullable
  - `special_service_request` string, nullable
  - `also_notify` CargojsonAccountContact — [CUSTOMER] Shipper or consignee with address and optional contact info. account_number is the IATA participant code (optional).
    - `accountNumber` string, nullable
    - `address` CargojsonAddress, required — [CUSTOMER] Postal address of shipper or consignee.
      - `name1` string, required
      - `name2` string, nullable
      - `streetAddress1` string, required
      - `streetAddress2` string, nullable
      - `place` string, required
      - `stateProvince` string, nullable
      - `country` string, required
      - `postCode` string, required
    - `contactDetails` CargojsonContactDetail[], nullable
      - `contactIdentifier` string, required
      - `contactNumber` string, required
  - `prepaid_charge_summary` CargojsonChargeSummary — [CUSTOMER] Prepaid or collect charge totals. One of prepaid or collect charge summary must be given.
    - `totalWeightCharge` number, nullable
    - `valuationCharge` number, nullable
    - `taxes` number, nullable
    - `totalOtherChargesDueAgent` number, nullable
    - `totalOtherChargesDueCarrier` number, nullable
    - `chargeSummaryTotal` number, required
  - `collect_charge_summary` CargojsonChargeSummary — [CUSTOMER] Prepaid or collect charge totals. One of prepaid or collect charge summary must be given.
    - `totalWeightCharge` number, nullable
    - `valuationCharge` number, nullable
    - `taxes` number, nullable
    - `totalOtherChargesDueAgent` number, nullable
    - `totalOtherChargesDueCarrier` number, nullable
    - `chargeSummaryTotal` number, required
  - `accounting` CargojsonAccounting[], nullable
    - `identifier` 'CreditCardNumber' | 'CreditCardExpiryDate' | 'CreditCardIssuanceName' | 'GeneralInformation' | 'GovernmentBillOfLading' | 'MiscellaneousChargeOrder' | 'ModeOfSettlement' | 'ReturnToOrigin' | 'ShippersReferenceNumber', required — https://github.com/champ-cargosystems-gmbh/cargojson.champ.aero/blob/master/src/main/java/aero/champ/cargojson/common/AccountingInformationIdentifier.java
    - `accountingInformation` string, required
  - `other_charges` CargojsonOtherChargeItem[], nullable
    - `paymentCondition` 'Collect' | 'Prepaid', required — Prepaid/Collect indicator.
    - `otherChargeCode` 'UC' | 'BA' | 'FA' | 'BB' | 'DG' | 'DH' | 'BC' | 'AW' | 'DI' | 'AC' | 'AS' | 'AT' | 'BR' | 'BL' | 'CA' | 'DC' | 'FC' | 'LC' | 'LI' | 'CD' | 'CH' | 'JA' | 'BE' | 'CB' | 'PB' | 'ZC' | 'BF' | 'RA' | 'SA' | 'SB' | 'SF' | 'UD' | 'GA' | 'UB' | 'DB' | 'DF' | 'FB' | 'CG' | 'CE' | 'MY' | 'FE' | 'ZB' | 'TX' | 'GT' | 'EA' | 'KA' | 'PA' | 'UH' | 'VA' | 'WA' | 'LE' | 'HR' | 'BI' | 'CF' | 'IN' | 'UE' | 'FF' | 'KB' | 'LA' | 'CC' | 'BH' | 'MA' | 'MC' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MZ' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MI' | 'MJ' | 'MK' | 'ML' | 'MM' | 'MN' | 'MB' | 'HB' | 'NS' | 'CI' | 'PK' | 'PU' | 'TA' | 'DD' | 'FD' | 'DJ' | 'SE' | 'LF' | 'RD' | 'UF' | 'RC' | 'RB' | 'DK' | 'RF' | 'CJ' | 'LJ' | 'ZA' | 'TB' | 'VB' | 'SC' | 'XB' | 'SP' | 'SS' | 'TC' | 'ST' | 'TD' | 'TE' | 'SI' | 'SR' | 'LH' | 'SO' | 'VC' | 'SD' | 'SU' | 'XC' | 'TR' | 'UG' | 'TV' | 'TI' | 'IA' | 'DV' | 'LG' | 'XD' | 'FI' | 'XE' | 'BM', required — https://github.com/champ-cargosystems-gmbh/cargojson.champ.aero/blob/master/src/main/java/aero/champ/cargojson/common/OtherChargeCode.java Code identifying the type of an individual charge. Value is the 2-letter Cargo-IMP code.
    - `entitlementCode` 'Agent' | 'Carrier', required — https://github.com/champ-cargosystems-gmbh/cargojson.champ.aero/blob/master/src/main/java/aero/champ/cargojson/airwaybill/EntitlementCode.java
    - `chargeAmount` number, required
  - `shippers_certification` string, nullable
  - `other_service_information` string, nullable
  - `charges_collect_in_dest_currency` CargojsonCollectChargesInDestCurrency — [CUSTOMER] Charges Collect expressed in destination currency.
    - `isoCurrencyCode` string, required
    - `currencyConversionRateOfExchange` number, required
    - `chargesInDestinationCurrency` number, required
    - `chargesAtDestination` number, required
    - `totalCollectCharges` number, required
  - `customs_origin_code` string, nullable
  - `commission_info` CargojsonCommissionInfo — [CUSTOMER] Commission information concerning CASS settlement.
    - `amountCASSSettlementFactor` number, nullable
    - `percentageCASSSettlementFactor` number, nullable
  - `sales_incentive` CargojsonSalesIncentive — [CUSTOMER] Sales incentive information.
    - `chargeAmount` number, required
    - `cassIndicator` 'AWB_AS_INVOICE' | 'CANCEL_AWB' | 'CHARGES_CORRECTION_ADIVCE' | 'DEBIT_OR_CREDIT_MEMORANDUM' | 'IDENTIFICATION' | 'LATE_REPORTING_WAYBILLS' | 'NO_COMMISSION_OR_NEGATIVE_SALES_INCENTIVE' | 'ORIGINAL_DATA' | 'REVISED_ADJUSTED_DATA' | 'SERVICE_AWB' | 'TAX_CALCULATION_REQUIRED' | 'VOID_AWB' — https://github.com/champ-cargosystems-gmbh/cargojson.champ.aero/blob/master/src/main/java/aero/champ/cargojson/common/CASSIndicator.java
  - `nominated_handling_party` CargojsonNominatedHandlingParty — [CUSTOMER] Nominated handling party for the shipment.
    - `name` string, required
    - `place` string, required
  - `shipment_reference_information` CargojsonShipmentReferenceInformation — [CUSTOMER] Shipment reference info (supplementary reference for the AWB).
    - `referenceNumber` string, nullable
    - `info` string, nullable
  - `other_participant` CargojsonOtherParticipant[], nullable
    - `name` string, required
    - `officeMessageAddress` CargojsonOfficeMessageAddress — [CONFIG] Office message address for SITA/TTY routing.
      - `airportCityCode` string, required
      - `officeFunctionDesignator` string, required
      - `companyDesignator` string, required
    - `fileReference` string, nullable
    - `participantIdentification` CargojsonParticipantIdentifier — [CONFIG] Identifies a participant in the movement of a shipment.
      - `identifier` 'AIR' | 'APT' | 'AGT' | 'BRK' | 'CAG' | 'CNE' | 'CTM' | 'DCL' | 'DEC' | 'FFW' | 'GHA' | 'PTT' | 'SHP' | 'TRK', required — https://github.com/champ-cargosystems-gmbh/cargojson.champ.aero/blob/master/src/main/java/aero/champ/cargojson/common/ParticipantType.java
      - `code` string, required
      - `airportCityCode` string, required
  - `oci` CargojsonOCI[], nullable
    - `isoCountryCode` string, nullable
    - `informationIdentifier` string, nullable
    - `controlInformation` string, nullable
    - `additionalControlInformation` string, nullable
    - `supplementaryControlInformation` string, nullable

## Response `200`

Successful Response

- ChampAirWaybill1
  - `schemaVersion` 1
  - `_id` string, required
  - `orgId` string, required — Must be a string starting with `org_`
  - `taskGroupId` string, required
  - `webcargoBookingRecordId` string, required
  - `status` 'draft' | 'submitted' | 'accepted' | 'rejected'
  - `airWaybillNumber` string, required
  - `origin` string, required
  - `destination` string, required
  - `totalConsignmentNumberOfPieces` integer, required
  - `weight` CargojsonWeight, required — Reusable weight amount + unit pair. Used for: - AirWayBill.weight -> [WEBCARGO] <NetWeight> (gross weight) - Charge.chargeable_weight -> [WEBCARGO] <TotalChargeableWeight> (billing weight) - ChargeItem.gross_weight -> [WEBCARGO] <NetWeight>
    - `amount` number, required
    - `unit` 'KILOGRAM' | 'POUND'
  - `route` CargojsonRouting[], required
    - `carrierCode` string, nullable
    - `destination` string, nullable
  - `chargeItems` CargojsonChargeItem[], required
    - `numberOfPieces` integer, nullable
    - `rateCombinationPointCityCode` string, nullable
    - `commodityItemNumber` string[], nullable
    - `goodsDescription` string, nullable
    - `grossWeight` CargojsonWeight — Reusable weight amount + unit pair. Used for: - AirWayBill.weight -> [WEBCARGO] <NetWeight> (gross weight) - Charge.chargeable_weight -> [WEBCARGO] <TotalChargeableWeight> (billing weight) - ChargeItem.gross_weight -> [WEBCARGO] <NetWeight>
      - `amount` number, required
      - `unit` 'KILOGRAM' | 'POUND'
    - `consolidation` boolean
    - `harmonisedCommodityCode` string[], nullable
    - `isoCountryCodeOfOriginOfGoods` string, nullable
    - `packaging` CargojsonPackaging[], nullable
      - `numberOfPieces` integer, nullable
      - `weight` CargojsonWeight — Reusable weight amount + unit pair. Used for: - AirWayBill.weight -> [WEBCARGO] <NetWeight> (gross weight) - Charge.chargeable_weight -> [WEBCARGO] <TotalChargeableWeight> (billing weight) - ChargeItem.gross_weight -> [WEBCARGO] <NetWeight>
        - `amount` number, required
        - `unit` 'KILOGRAM' | 'POUND'
      - `volume` CargojsonVolume — [WEBCARGO] Volume from <NetVolumeMeasure>.
        - `amount` number, required
        - `unit` 'CUBIC_CENTIMETRE' | 'CUBIC_FOOT' | 'CUBIC_INCH' | 'CUBIC_METRE'
      - `dimensions` CargojsonDimensions — [WEBCARGO/CUSTOMER] Package dimensions from <Dimension> or customer input.
        - `unit` 'CENTIMETRE' | 'DECIMETRE' | 'FOOT' | 'INCH' | 'METRE' | 'MILLIMETRE' | 'YARD' — Java source calls this LengthUnit; we use DimensionUnit since it describes all three axes (length, width, height) in CargojsonDimensions.
        - `length` integer, required
        - `width` integer, required
        - `height` integer, required
      - `uld` CargojsonULD — [CUSTOMER] Unit Load Device (ULD) container details.
        - `type` string, required
        - `serialNumber` string, required
        - `ownerCode` string, required
        - `loadingIndicator` string, nullable
        - `remarks` string, nullable
        - `weightOfULDContents` CargojsonWeight — Reusable weight amount + unit pair. Used for: - AirWayBill.weight -> [WEBCARGO] <NetWeight> (gross weight) - Charge.chargeable_weight -> [WEBCARGO] <TotalChargeableWeight> (billing weight) - ChargeItem.gross_weight -> [WEBCARGO] <NetWeight>
          - `amount` number, required
          - `unit` 'KILOGRAM' | 'POUND'
      - `shippersLoadAndCount` string, nullable
    - `charges` CargojsonCharge[], nullable
      - `chargeableWeight` CargojsonWeight — Reusable weight amount + unit pair. Used for: - AirWayBill.weight -> [WEBCARGO] <NetWeight> (gross weight) - Charge.chargeable_weight -> [WEBCARGO] <TotalChargeableWeight> (billing weight) - ChargeItem.gross_weight -> [WEBCARGO] <NetWeight>
        - `amount` number, required
        - `unit` 'KILOGRAM' | 'POUND'
      - `rateClassCode` 'BASIC_CHARGE' | 'CLASS_RATE_REDUCTION' | 'CLASS_RATE_SURCHARGE' | 'INTERNATIONAL_PRIORITY_SERVICE_RATE' | 'MINIMUM_CHARGE' | 'NORMAL_RATE' | 'QUANTITY_RATE' | 'RATE_PER_KILOGRAM' | 'SPECIFIC_COMMODITY_RATE' | 'UNIT_LOAD_DEVICE_ADDITIONAL_INFORMATION' | 'UNIT_LOAD_DEVICE_ADDITIONAL_RATE' | 'UNIT_LOAD_DEVIDE_BASIC_CHARGE_OR_RATE' | 'UNIT_LOAD_DEVICE_DISCOUNT' — https://github.com/champ-cargosystems-gmbh/cargojson.champ.aero/blob/master/src/main/java/aero/champ/cargojson/common/RateClassCode.java
      - `rateClassCodeBasis` 'BASIC_CHARGE' | 'CLASS_RATE_REDUCTION' | 'CLASS_RATE_SURCHARGE' | 'INTERNATIONAL_PRIORITY_SERVICE_RATE' | 'MINIMUM_CHARGE' | 'NORMAL_RATE' | 'QUANTITY_RATE' | 'RATE_PER_KILOGRAM' | 'SPECIFIC_COMMODITY_RATE' | 'UNIT_LOAD_DEVICE_ADDITIONAL_INFORMATION' | 'UNIT_LOAD_DEVICE_ADDITIONAL_RATE' | 'UNIT_LOAD_DEVIDE_BASIC_CHARGE_OR_RATE' | 'UNIT_LOAD_DEVICE_DISCOUNT' — https://github.com/champ-cargosystems-gmbh/cargojson.champ.aero/blob/master/src/main/java/aero/champ/cargojson/common/RateClassCode.java
      - `classRatePercentage` number, nullable
      - `uldRateClassType` string, nullable
      - `rateOrCharge` number, nullable
      - `totalChargeAmount` number, nullable
    - `serviceCode` 'AIRPORT_TO_AIRPORT' | 'SERVICE_SHIPMENT' | 'COMPANY_MATERIAL' | 'DOOR_TO_DOOR_SERVICE' | 'AIRPORT_TO_DOOR' | 'FLIGHT_SPECIFIC' | 'DOOR_TO_AIRPORT' | 'COMPANY_MAIL' | 'DIPLOMATIC_MAIL' | 'PRIORITY_SERVICE' | 'UNDOCUMENTED_K' | 'UNDOCUMENTED_L' | 'UNDOCUMENTED_M' | 'UNDOCUMENTED_N' | 'UNDOCUMENTED_O' | 'SMALL_PACKAGE_SERVICE' | 'UNDOCUMENTED_Q' | 'UNDOCUMENTED_R' | 'SUBSTITUTE_TRUCK' | 'CHARTER' | 'UNDOCUMENTED_U' | 'UNDOCUMENTED_V' | 'UNDOCUMENTED_W' | 'EXPRESS_SHIPMENTS' | 'UNDOCUMENTED_Y' | 'UNDOCUMENTED_Z' — https://github.com/champ-cargosystems-gmbh/cargojson.champ.aero/blob/master/src/main/java/aero/champ/cargojson/common/ServiceCode.java
  - `volume` CargojsonVolume — [WEBCARGO] Volume from <NetVolumeMeasure>.
    - `amount` number, required
    - `unit` 'CUBIC_CENTIMETRE' | 'CUBIC_FOOT' | 'CUBIC_INCH' | 'CUBIC_METRE'
  - `flights` CargojsonFlightIdentity[], nullable
    - `flight` string, required
    - `scheduledDate` string, date, required
    - `scheduledTime` string, time, nullable
  - `isoCurrencyCode` string, nullable
  - `agent` CargojsonAgent — [WEBCARGO/CONFIG] Forwarder's IATA agent identification. Same identity as `iata` in WebcargoEmbedViewParams and OY party in bookingRecord XML.
    - `name` string, required
    - `place` string, required
    - `accountNumber` string, nullable
    - `iataCargoAgentNumericCode` string, nullable
    - `iataCargoAgentCASSAddress` string, nullable
    - `participantIdentifier` CargojsonParticipantIdentifier — [CONFIG] Identifies a participant in the movement of a shipment.
      - `identifier` 'AIR' | 'APT' | 'AGT' | 'BRK' | 'CAG' | 'CNE' | 'CTM' | 'DCL' | 'DEC' | 'FFW' | 'GHA' | 'PTT' | 'SHP' | 'TRK', required — https://github.com/champ-cargosystems-gmbh/cargojson.champ.aero/blob/master/src/main/java/aero/champ/cargojson/common/ParticipantType.java
      - `code` string, required
      - `airportCityCode` string, required
  - `shipper` CargojsonAccountContact — [CUSTOMER] Shipper or consignee with address and optional contact info. account_number is the IATA participant code (optional).
    - `accountNumber` string, nullable
    - `address` CargojsonAddress, required — [CUSTOMER] Postal address of shipper or consignee.
      - `name1` string, required
      - `name2` string, nullable
      - `streetAddress1` string, required
      - `streetAddress2` string, nullable
      - `place` string, required
      - `stateProvince` string, nullable
      - `country` string, required
      - `postCode` string, required
    - `contactDetails` CargojsonContactDetail[], nullable
      - `contactIdentifier` string, required
      - `contactNumber` string, required
  - `consignee` CargojsonAccountContact — [CUSTOMER] Shipper or consignee with address and optional contact info. account_number is the IATA participant code (optional).
    - `accountNumber` string, nullable
    - `address` CargojsonAddress, required — [CUSTOMER] Postal address of shipper or consignee.
      - `name1` string, required
      - `name2` string, nullable
      - `streetAddress1` string, required
      - `streetAddress2` string, nullable
      - `place` string, required
      - `stateProvince` string, nullable
      - `country` string, required
      - `postCode` string, required
    - `contactDetails` CargojsonContactDetail[], nullable
      - `contactIdentifier` string, required
      - `contactNumber` string, required
  - `chargeDeclarations` CargojsonChargeDeclarations — [CUSTOMER/WEBCARGO] Currency from WebCargo <PriceIndicator>, payment conditions from customer's commercial terms.
    - `isoCurrencyCode` string, required
    - `chargeCode` 'ALL_CHARGES_COLLECT' | 'ALL_CHARGES_COLLECT_BY_CREDIT_CARD' | 'ALL_CHARGES_COLLECT_BY_GBL' | 'ALL_CHARGES_PREPAID_CASH' | 'ALL_CHARGES_PREPAID_CREDIT' | 'ALL_CHARGES_PREPAID_BY_CREDIT_CARD' | 'ALL_CHARGES_PREPAID_BY_GBL' | 'DESTINATION_COLLECT_CASH' | 'DESTINATION_COLLECT_CREDIT' | 'DESTINATION_COLLECT_BY_MCO' | 'NO_CHARGE' | 'NO_WEIGHT_CHARGE_OTHER_CHARGES_COLLECT' | 'NO_WEIGHT_CHARGE_OTHER_CHARGES_PREPAID_BY_CREDIT_CARD' | 'NO_WEIGHT_CHARGE_OTHER_CHARGES_PREPAID_BY_GBL' | 'NO_WEIGHT_CHARGE_OTHER_CHARGES_PREPAID_CASH' | 'NO_WEIGHT_CHARGE_OTHER_CHARGES_PREPAID_CREDIT' | 'PARTIAL_COLLECT_CREDIT_PARTIAL_PREPAID_CASH' | 'PARTIAL_COLLECT_CREDIT_PARTIAL_PREPAID_CREDIT' | 'PARTIAL_COLLECT_CREDIT_CARD_PARTIAL_PREPAID_CASH' | 'PARTIAL_COLLECT_CREDIT_CARD_PARTIAL_PREPAID_CREDIT' | 'PARTIAL_PREPAID_CASH_PARTIAL_COLLECT_CASH' | 'PARTIAL_PREPAID_CREDIT_PARTIAL_COLLECT_CASH' | 'PARTIAL_PREPAID_CREDIT_CARD_PARTIAL_COLLECT_CASH' | 'PARTIAL_PREPAID_CREDIT_CARD_PARTIAL_COLLECT_CREDIT' | 'PARTIAL_PREPAID_CREDIT_CARD_PARTIAL_COLLECT_CREDIT_CARD' — https://github.com/champ-cargosystems-gmbh/cargojson.champ.aero/blob/master/src/main/java/aero/champ/cargojson/common/ChargeCode.java
    - `payment_WeightValuation` 'Collect' | 'Prepaid' — Prepaid/Collect indicator.
    - `payment_OtherCharges` 'Collect' | 'Prepaid' — Prepaid/Collect indicator.
    - `declaredValueForCarriage` number, nullable
    - `declaredValueForCustoms` number, nullable
    - `declaredValueForInsurance` number, nullable
  - `densityGroup` integer, nullable
  - `specialHandlingCodes` CargojsonSpecialHandlingCode[]
  - `additionalSpecialHandlingCodes` string[]
  - `specialServiceRequest` string, nullable
  - `alsoNotify` CargojsonAccountContact — [CUSTOMER] Shipper or consignee with address and optional contact info. account_number is the IATA participant code (optional).
    - `accountNumber` string, nullable
    - `address` CargojsonAddress, required — [CUSTOMER] Postal address of shipper or consignee.
      - `name1` string, required
      - `name2` string, nullable
      - `streetAddress1` string, required
      - `streetAddress2` string, nullable
      - `place` string, required
      - `stateProvince` string, nullable
      - `country` string, required
      - `postCode` string, required
    - `contactDetails` CargojsonContactDetail[], nullable
      - `contactIdentifier` string, required
      - `contactNumber` string, required
  - `prepaidChargeSummary` CargojsonChargeSummary — [CUSTOMER] Prepaid or collect charge totals. One of prepaid or collect charge summary must be given.
    - `totalWeightCharge` number, nullable
    - `valuationCharge` number, nullable
    - `taxes` number, nullable
    - `totalOtherChargesDueAgent` number, nullable
    - `totalOtherChargesDueCarrier` number, nullable
    - `chargeSummaryTotal` number, required
  - `collectChargeSummary` CargojsonChargeSummary — [CUSTOMER] Prepaid or collect charge totals. One of prepaid or collect charge summary must be given.
    - `totalWeightCharge` number, nullable
    - `valuationCharge` number, nullable
    - `taxes` number, nullable
    - `totalOtherChargesDueAgent` number, nullable
    - `totalOtherChargesDueCarrier` number, nullable
    - `chargeSummaryTotal` number, required
  - `accounting` CargojsonAccounting[]
    - `identifier` 'CreditCardNumber' | 'CreditCardExpiryDate' | 'CreditCardIssuanceName' | 'GeneralInformation' | 'GovernmentBillOfLading' | 'MiscellaneousChargeOrder' | 'ModeOfSettlement' | 'ReturnToOrigin' | 'ShippersReferenceNumber', required — https://github.com/champ-cargosystems-gmbh/cargojson.champ.aero/blob/master/src/main/java/aero/champ/cargojson/common/AccountingInformationIdentifier.java
    - `accountingInformation` string, required
  - `otherCharges` CargojsonOtherChargeItem[]
    - `paymentCondition` 'Collect' | 'Prepaid', required — Prepaid/Collect indicator.
    - `otherChargeCode` 'UC' | 'BA' | 'FA' | 'BB' | 'DG' | 'DH' | 'BC' | 'AW' | 'DI' | 'AC' | 'AS' | 'AT' | 'BR' | 'BL' | 'CA' | 'DC' | 'FC' | 'LC' | 'LI' | 'CD' | 'CH' | 'JA' | 'BE' | 'CB' | 'PB' | 'ZC' | 'BF' | 'RA' | 'SA' | 'SB' | 'SF' | 'UD' | 'GA' | 'UB' | 'DB' | 'DF' | 'FB' | 'CG' | 'CE' | 'MY' | 'FE' | 'ZB' | 'TX' | 'GT' | 'EA' | 'KA' | 'PA' | 'UH' | 'VA' | 'WA' | 'LE' | 'HR' | 'BI' | 'CF' | 'IN' | 'UE' | 'FF' | 'KB' | 'LA' | 'CC' | 'BH' | 'MA' | 'MC' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MZ' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MI' | 'MJ' | 'MK' | 'ML' | 'MM' | 'MN' | 'MB' | 'HB' | 'NS' | 'CI' | 'PK' | 'PU' | 'TA' | 'DD' | 'FD' | 'DJ' | 'SE' | 'LF' | 'RD' | 'UF' | 'RC' | 'RB' | 'DK' | 'RF' | 'CJ' | 'LJ' | 'ZA' | 'TB' | 'VB' | 'SC' | 'XB' | 'SP' | 'SS' | 'TC' | 'ST' | 'TD' | 'TE' | 'SI' | 'SR' | 'LH' | 'SO' | 'VC' | 'SD' | 'SU' | 'XC' | 'TR' | 'UG' | 'TV' | 'TI' | 'IA' | 'DV' | 'LG' | 'XD' | 'FI' | 'XE' | 'BM', required — https://github.com/champ-cargosystems-gmbh/cargojson.champ.aero/blob/master/src/main/java/aero/champ/cargojson/common/OtherChargeCode.java Code identifying the type of an individual charge. Value is the 2-letter Cargo-IMP code.
    - `entitlementCode` 'Agent' | 'Carrier', required — https://github.com/champ-cargosystems-gmbh/cargojson.champ.aero/blob/master/src/main/java/aero/champ/cargojson/airwaybill/EntitlementCode.java
    - `chargeAmount` number, required
  - `shippersCertification` string, nullable
  - `otherServiceInformation` string, nullable
  - `chargesCollectInDestCurrency` CargojsonCollectChargesInDestCurrency — [CUSTOMER] Charges Collect expressed in destination currency.
    - `isoCurrencyCode` string, required
    - `currencyConversionRateOfExchange` number, required
    - `chargesInDestinationCurrency` number, required
    - `chargesAtDestination` number, required
    - `totalCollectCharges` number, required
  - `customsOriginCode` string, nullable
  - `commissionInfo` CargojsonCommissionInfo — [CUSTOMER] Commission information concerning CASS settlement.
    - `amountCASSSettlementFactor` number, nullable
    - `percentageCASSSettlementFactor` number, nullable
  - `salesIncentive` CargojsonSalesIncentive — [CUSTOMER] Sales incentive information.
    - `chargeAmount` number, required
    - `cassIndicator` 'AWB_AS_INVOICE' | 'CANCEL_AWB' | 'CHARGES_CORRECTION_ADIVCE' | 'DEBIT_OR_CREDIT_MEMORANDUM' | 'IDENTIFICATION' | 'LATE_REPORTING_WAYBILLS' | 'NO_COMMISSION_OR_NEGATIVE_SALES_INCENTIVE' | 'ORIGINAL_DATA' | 'REVISED_ADJUSTED_DATA' | 'SERVICE_AWB' | 'TAX_CALCULATION_REQUIRED' | 'VOID_AWB' — https://github.com/champ-cargosystems-gmbh/cargojson.champ.aero/blob/master/src/main/java/aero/champ/cargojson/common/CASSIndicator.java
  - `nominatedHandlingParty` CargojsonNominatedHandlingParty — [CUSTOMER] Nominated handling party for the shipment.
    - `name` string, required
    - `place` string, required
  - `shipmentReferenceInformation` CargojsonShipmentReferenceInformation — [CUSTOMER] Shipment reference info (supplementary reference for the AWB).
    - `referenceNumber` string, nullable
    - `info` string, nullable
  - `otherParticipant` CargojsonOtherParticipant[]
    - `name` string, required
    - `officeMessageAddress` CargojsonOfficeMessageAddress — [CONFIG] Office message address for SITA/TTY routing.
      - `airportCityCode` string, required
      - `officeFunctionDesignator` string, required
      - `companyDesignator` string, required
    - `fileReference` string, nullable
    - `participantIdentification` CargojsonParticipantIdentifier — [CONFIG] Identifies a participant in the movement of a shipment.
      - `identifier` 'AIR' | 'APT' | 'AGT' | 'BRK' | 'CAG' | 'CNE' | 'CTM' | 'DCL' | 'DEC' | 'FFW' | 'GHA' | 'PTT' | 'SHP' | 'TRK', required — https://github.com/champ-cargosystems-gmbh/cargojson.champ.aero/blob/master/src/main/java/aero/champ/cargojson/common/ParticipantType.java
      - `code` string, required
      - `airportCityCode` string, required
  - `oci` CargojsonOCI[]
    - `isoCountryCode` string, nullable
    - `informationIdentifier` string, nullable
    - `controlInformation` string, nullable
    - `additionalControlInformation` string, nullable
    - `supplementaryControlInformation` string, nullable
  - `createdAt` string, date-time, required
  - `updatedAt` string, date-time, required
  - `submittedAt` string, date-time, nullable

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.dev/chrt/apis/chrt-fastapi.md) · [All operations](https://skmtc.dev/chrt/apis/chrt-fastapi/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/chrt/chrt-fastapi/revisions/ea04e157edb3/schema)