API ReferenceIntegrationsAir Waybills

Create air waybill

Creates a CHAMP air waybill pre-populated from the stored WebCargo booking record. The booking must be synced first via the webcargo_bookings sync route. Returns 409 if an air waybill already exists for this task group. | (AirWaybillCreateReq) -> (ChampAirWaybill1)

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
task_group_idstringRequired

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 objects
additionalSpecialHandlingCodeslist of strings
agentobject

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

alsoNotifyobject

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

chargesCollectInDestCurrencyobject

[CUSTOMER] Charges Collect expressed in destination currency.

collectChargeSummaryobject

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

commissionInfoobject

[CUSTOMER] Commission information concerning CASS settlement.

consigneeobject

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

customsOriginCodestring
densityGroupinteger
flightslist of objects
isoCurrencyCodestring
nominatedHandlingPartyobject

[CUSTOMER] Nominated handling party for the shipment.

ocilist of objects
otherChargeslist of objects
otherParticipantlist of objects
otherServiceInformationstring
prepaidChargeSummaryobject

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

salesIncentiveobject

[CUSTOMER] Sales incentive information.

schemaVersionintegerDefaults to 1
shipmentReferenceInformationobject

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

shipperobject

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

shippersCertificationstring
specialHandlingCodeslist of enums
specialServiceRequeststring
statusenum
submittedAtdatetime
volumeobject

[WEBCARGO] Volume from <NetVolumeMeasure>.

Errors

422
Air Waybills Create V1request Unprocessable Entity Error