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.
accountinglist of objectsOptional
additional_special_handling_codeslist of stringsOptional
agentobjectOptional

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

also_notifyobjectOptional

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

charge_itemslist of objectsOptional
charges_collect_in_dest_currencyobjectOptional

[CUSTOMER] Charges Collect expressed in destination currency.

collect_charge_summaryobjectOptional

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

commission_infoobjectOptional

[CUSTOMER] Commission information concerning CASS settlement.

consigneeobjectOptional

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

customs_origin_codestringOptional
density_groupintegerOptional
flightslist of objectsOptional
iso_currency_codestringOptional
nominated_handling_partyobjectOptional

[CUSTOMER] Nominated handling party for the shipment.

ocilist of objectsOptional
other_chargeslist of objectsOptional
other_participantlist of objectsOptional
other_service_informationstringOptional
prepaid_charge_summaryobjectOptional

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

routelist of objectsOptional
sales_incentiveobjectOptional

[CUSTOMER] Sales incentive information.

shipment_reference_informationobjectOptional

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

shipperobjectOptional

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

shippers_certificationstringOptional
special_handling_codeslist of enumsOptional
special_service_requeststringOptional
total_consignment_number_of_piecesintegerOptional
volumeobjectOptional

[WEBCARGO] Volume from <NetVolumeMeasure>.

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>

Response

Successful Response
_idstring
airWaybillNumberstring
chargeItemslist of objects
createdAtdatetime
destinationstring
orgIdstring

Must be a string starting with org_

originstring
routelist of objects
taskGroupIdstring
totalConsignmentNumberOfPiecesinteger
updatedAtdatetime
webcargoBookingRecordIdstring
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>
accountinglist of objectsOptional
additionalSpecialHandlingCodeslist of stringsOptional
agentobjectOptional

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

alsoNotifyobjectOptional

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

chargeDeclarationsobjectOptional

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

chargesCollectInDestCurrencyobjectOptional

[CUSTOMER] Charges Collect expressed in destination currency.

collectChargeSummaryobjectOptional

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

commissionInfoobjectOptional

[CUSTOMER] Commission information concerning CASS settlement.

consigneeobjectOptional

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

customsOriginCodestringOptional
densityGroupintegerOptional
flightslist of objectsOptional
isoCurrencyCodestringOptional
nominatedHandlingPartyobjectOptional

[CUSTOMER] Nominated handling party for the shipment.

ocilist of objectsOptional
otherChargeslist of objectsOptional
otherParticipantlist of objectsOptional
otherServiceInformationstringOptional
prepaidChargeSummaryobjectOptional

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

salesIncentiveobjectOptional

[CUSTOMER] Sales incentive information.

schemaVersionintegerOptionalDefaults to 1
shipmentReferenceInformationobjectOptional

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

shipperobjectOptional

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

shippersCertificationstringOptional
specialHandlingCodeslist of enumsOptional
specialServiceRequeststringOptional
statusenumOptional
submittedAtdatetimeOptional
volumeobjectOptional

[WEBCARGO] Volume from <NetVolumeMeasure>.

Errors

422
Air Waybills Update V1request Unprocessable Entity Error