API ReferenceIntegrationsAir Waybills

Update air waybill fields

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)

Authentication

AuthorizationBearer

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

Path parameters

task_group_idstringRequired

Request

This endpoint expects an object.
total_consignment_number_of_piecesintegerOptional
weightobjectOptional
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>
volumeobjectOptional

[WEBCARGO] Volume from <NetVolumeMeasure>.

charge_itemslist of objectsOptional
flightslist of objectsOptional
iso_currency_codestringOptional
agentobjectOptional

[WEBCARGO/CONFIG] Forwarder’s IATA agent identification. Same identity as iata in WebcargoEmbedViewParams and OY party in bookingRecord XML.

routelist of objectsOptional
shipperobjectOptional

[CUSTOMER] Shipper or consignee with address and optional contact info. account_number is the IATA participant code (optional).

consigneeobjectOptional

[CUSTOMER] Shipper or consignee with address and optional contact info. account_number is the IATA participant code (optional).

charge_declarationsobjectOptional

[CUSTOMER/WEBCARGO] Currency from WebCargo <PriceIndicator>, payment conditions from customer’s commercial terms.

density_groupintegerOptional
special_handling_codeslist of enumsOptional
additional_special_handling_codeslist of stringsOptional
special_service_requeststringOptional
also_notifyobjectOptional

[CUSTOMER] Shipper or consignee with address and optional contact info. account_number is the IATA participant code (optional).

prepaid_charge_summaryobjectOptional

[CUSTOMER] Prepaid or collect charge totals. One of prepaid or collect charge summary must be given.

collect_charge_summaryobjectOptional

[CUSTOMER] Prepaid or collect charge totals. One of prepaid or collect charge summary must be given.

accountinglist of objectsOptional
other_chargeslist of objectsOptional
shippers_certificationstringOptional
other_service_informationstringOptional
charges_collect_in_dest_currencyobjectOptional

[CUSTOMER] Charges Collect expressed in destination currency.

customs_origin_codestringOptional
commission_infoobjectOptional

[CUSTOMER] Commission information concerning CASS settlement.

sales_incentiveobjectOptional

[CUSTOMER] Sales incentive information.

nominated_handling_partyobjectOptional

[CUSTOMER] Nominated handling party for the shipment.

shipment_reference_informationobjectOptional

[CUSTOMER] Shipment reference info (supplementary reference for the AWB).

other_participantlist of objectsOptional
ocilist of objectsOptional

Response

Successful Response
_idstring
orgIdstring

Must be a string starting with org_

taskGroupIdstring
webcargoBookingRecordIdstring
airWaybillNumberstring
originstring
destinationstring
totalConsignmentNumberOfPiecesinteger
weightobject

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>
routelist of objects
chargeItemslist of objects
createdAtdatetime
updatedAtdatetime
schemaVersionintegerDefaults to 1
statusenum
Allowed values:
volumeobject

[WEBCARGO] Volume from <NetVolumeMeasure>.

flightslist of objects
isoCurrencyCodestring
agentobject

[WEBCARGO/CONFIG] Forwarder’s IATA agent identification. Same identity as iata in WebcargoEmbedViewParams and OY party in bookingRecord XML.

shipperobject

[CUSTOMER] Shipper or consignee with address and optional contact info. account_number is the IATA participant code (optional).

consigneeobject

[CUSTOMER] Shipper or consignee with address and optional contact info. account_number is the IATA participant code (optional).

chargeDeclarationsobject

[CUSTOMER/WEBCARGO] Currency from WebCargo <PriceIndicator>, payment conditions from customer’s commercial terms.

densityGroupinteger
specialHandlingCodeslist of enums
additionalSpecialHandlingCodeslist of strings
specialServiceRequeststring
alsoNotifyobject

[CUSTOMER] Shipper or consignee with address and optional contact info. account_number is the IATA participant code (optional).

prepaidChargeSummaryobject

[CUSTOMER] Prepaid or collect charge totals. One of prepaid or collect charge summary must be given.

collectChargeSummaryobject

[CUSTOMER] Prepaid or collect charge totals. One of prepaid or collect charge summary must be given.

accountinglist of objects
otherChargeslist of objects
shippersCertificationstring
otherServiceInformationstring
chargesCollectInDestCurrencyobject

[CUSTOMER] Charges Collect expressed in destination currency.

customsOriginCodestring
commissionInfoobject

[CUSTOMER] Commission information concerning CASS settlement.

salesIncentiveobject

[CUSTOMER] Sales incentive information.

nominatedHandlingPartyobject

[CUSTOMER] Nominated handling party for the shipment.

shipmentReferenceInformationobject

[CUSTOMER] Shipment reference info (supplementary reference for the AWB).

otherParticipantlist of objects
ocilist of objects
submittedAtdatetime

Errors

422
Air Waybills Update V1request Unprocessable Entity Error