Air waybill

Air Waybill (AWB), which is a complex document used in air cargo transportation, KIE can be used to automate several business processes. Here are five use cases where KIE can automate tasks related to AWBs:

Models

We recommend using the model alias air-waybill-extraction to the model name field as it always refers to the most recent version of the model.

ModelRelease dateDescription
air-waybill-extraction-4.1.6 beta2024-06-11An extractor model for air waybill (AWB)

Sample document

air-waybill.png
air_waybill.png

Usecase examples

  1. Automatic data entry and system updates

    Extract shipment details (e.g., sender, receiver, cargo description, weight, dimensions) from AWBs and automatically input them into ERP systems or Transportation Management Systems (TMS). This saves time spent on manual data entry and reduces errors.

  2. Customs declaration automation

    Automatically extract customs-related information (e.g., cargo description, transportation details, country codes) from AWBs to generate export/import declarations. This can streamline the customs filing process by pre-filling required fields and generating the necessary documents.

  3. Freight and insurance claim automation

    Extract financial data, such as shipping costs and insurance amounts, from AWBs to automatically generate invoices or insurance claims. This can speed up billing and claims processes, ensuring accurate and timely processing.

  4. Cargo tracking and status updates

    Extract tracking numbers or flight information from AWBs and automatically update cargo tracking systems. This can provide real-time updates to customers on the location and expected delivery of their cargo by integrating with tracking services.

  5. Document auditing and compliance checks

    Extract required fields like signatures, dates, and carrier information to automate the auditing process, ensuring that AWBs meet legal and regulatory requirements. This helps quickly identify missing or incorrect information, ensuring compliance with industry standards.

API reference

POST
/document-ai/extraction
/document-ai/extraction

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

multipart/form-dataRequired

document
Required
file

The document file to be processed. Supported file formats are listed here.

model
Required
string

An parameter that specifices the model version to be used. Available models can be found at the top of this document. The model alias, which is typically the model name without the version number, always refers to the most recent version of the model. Therefore, it's recommended to use the model alias instead of the model name unless you want to use a specific feature of the available model.

import requests
 
api_key = "UPSTAGE_API_KEY"  # ex: up_xxxYYYzzzAAAbbbCCC
filename = "YOUR_FILE_NAME"  # ex: ./image.png
 
url = "https://api.upstage.ai/v1/document-ai/extraction"
headers = {"Authorization": f"Bearer {api_key}"}
 
files = {"document": open(filename, "rb")}
data = {"model": "air-waybill-extraction"}
response = requests.post(url, headers=headers, files=files, data=data)
 
print(response.json())
 

Success

{
  "mimeType": "multipart/form-data",
  "documentType": "air-waybill-extraction",
  "fields": [
    {
      "key": "date",
      "type": "date",
      "value": "2023-09-15",
      "confidence": 0.98,
      "id": 1,
      "refinedValue": "September 15, 2023"
    },
    {
      "key": "total",
      "type": "monetary_usd",
      "value": "150.00",
      "confidence": 0.95,
      "id": 2,
      "properties": [
        {
          "key": "subtotal",
          "value": "100.00",
          "confidence": 0.95
        }
      ]
    }
  ],
  "stored": true,
  "modelVersion": "air-waybill-extraction",
  "apiVersion": "1.1",
  "numBilledPages": 2,
  "metadata": {
    "pageSize": "A4",
    "totalPages": 2
  }
}

Field descriptions

FieldDescriptionExample value
document_information.document_nameDocument NameAir Waybill
document_information.air_waybill_numberHouse Air Waybill NumberEQEWSA202301001
document_information.master_air_waybill_numberMaster Air Waybill Number999-21234530
document_information.executed_dateDate of Issue07-Nov-2018
document_information.executed_placePlace of IssueSAN FRANCISCO
document_information.signatory_nameIssuing Agent's Name (Name of the signatory at the bottom of the document)Lucy Park
shipping_information.shipper_nameShipper's Name (The person or company sending the goods)AHTWO CO.,LTD.
shipping_information.shipper_addressShipper's AddressAMPEL PHAREM VILLAGE, VIHEA LOUNG COMMUNE, PUNHEA LUE DISTRICT, KANDAL, PROVINCE, CAMBODIA.
shipping_information.shipper_phone_numberShipper's Telephone Number+82-31-777-8878
shipping_information.shipper_fax_numberShipper's Fax Number07011232231
shipping_information.consignee_nameConsignee's Name (The person or company receiving the goods)AHWON CORPORATION
shipping_information.consignee_addressConsignee's Address7-9, JE1 SANDAN-RO, DUMA-MYEON, GYERYONG-SI, CHUNGCHEONGNAM-DO, KOREA
shipping_information.consignee_phone_numberConsignee's Telephone Number+82-31-777-1234
shipping_information.consignee_fax_numberConsignee's Fax Number07011232231
shipping_information.notify_party_nameNotify Party's Name (The contact for notification upon cargo arrival)SAME AS CONSIGNEE
shipping_information.notify_party_addressNotify Party's Address7-9, JE1 SANDAN-RO, DUMA-MYEON, GYERYONG-SI, CHUNGCHEONGNAM-DO, KOREA
shipping_information.notify_party_phone_numberNotify Party's Telephone Number+82-31-777-1234
shipping_information.notify_party_fax_numberNotify Party's Fax Number07011232231
shipping_information.airport_of_departureAirport of Departure NameJFK INT'L AIRPORT
shipping_information.to_port_1Transit Airport Code 1ICN
shipping_information.by_carrier_1Transit Airline Code 1ASIANA AIRLINES
shipping_information.to_port_2Transit Airport Code 2RIX
shipping_information.by_carrier_2Transit Airline Code 2AY
shipping_information.to_port_3Transit Airport Code 3MAA
shipping_information.by_carrier_3Transit Airline Code 3TG
shipping_information.airport_of_destinationAirport of Destination NameINCHEON AIRPORT,KOREA
shipping_information.requested_flightFlight Number of the CarrierTG657
shipping_information.requested_dateDeparture Date of the CarrierSEP.05.2018
shipping_information.currencyCurrency UnitUSD
shipping_information.chgs_codeRate of Exchange CodeCC
shipping_information.weight_prepaidPrepaid Air Freightx
shipping_information.weight_collectCollect Air Freightx
shipping_information.other_prepaidPrepaid Other Chargesx
shipping_information.other_collectCollect Other Chargesx
shipping_information.declared_value_for_carriageTotal Prepaid ChargesN.V.D.
shipping_information.declared_value_for_customsCustoms Value for CarriageAS PER INV.
shipping_information.amount_of_insuranceAmount of InsuranceNIL
shipping_information.handling_informationCargo InformationDOCUMENT ATTACHED
shipping_information.weight_prepaid_amountPrepaid Air Freight by AirlineAS ARRANGED
shipping_information.weight_collect_amountCollect Air Freight by AirlineAS ARRANGED
shipping_information.agent_prepaid_amountPrepaid Air Freight by AgentAS ARRANGED
shipping_information.agent_collect_amountCollect Air Freight by AgentAS ARRANGED
shipping_information.carrier_prepaid_amountPrepaid Air Freight by CarrierAS ARRANGED
shipping_information.carrier_collect_amountCollect Air Freight by CarrierAS ARRANGED
shipping_information.total_prepaid_amountTotal Prepaid Air FreightAS ARRANGED
shipping_information.total_collect_amountTotal Collect Air FreightAS ARRANGED
shipping_information.freight_payment_methodMethod of Payment for Air FreightFREIGHT PREPAID
cargo_information.number_of_pieces_receiptTotal Number of Items Received for the Shipment2
cargo_information.gross_weightTotal Weight494.0
cargo_information.gross_weigh_unit_codeTotal Weight UnitK
cargo_information.rate_classWeight Unit CodeQ
cargo_information.chargeable_weightChargeable Weight500.0
cargo_information.unit_rateFreight RateAS ARRANGED
cargo_information.total_rateFreight Amount75,900
cargo_information.dimensionDimensions of Cargo156x216x121x1
cargo_information.markMark InformationSHIPPING MARK: P/N: NR640-SINGAL
cargo_information.description_of_goodsGeneral Description of Goods/CargoPLASTIC O RING INV# 9900134712 PO# 210324-01 DETAILS AS PER ATTACHED SHIPPER'sCOMMERCIAL INVOICE ITN# : X20211229557144

On this page