Skip to main content
GET
/
v1-preview
/
models
/
air-waybill
/
{documentId}
Csharp (SDK)
using ABBYY.DocumentAI;
using ABBYY.DocumentAI.Schemas.Components;

var sdk = new DocumentAI(apiKeyAuth: "<YOUR_BEARER_TOKEN_HERE>");

var res = await sdk.Models.AirWaybill.GetExtractedFieldsAsync(documentId: "wh23anb5xjf0ntw5taase5qz");

// handle response
{
  "meta": {
    "id": "wh23anb5xjf0ntw5taase5qz",
    "name": "document.jpg",
    "createdAt": "2025-02-07T17:44:06.949Z",
    "model": "air-waybill",
    "status": "Processed",
    "pageCount": 10,
    "errors": [
      {
        "message": "Total is required"
      }
    ]
  },
  "fields": {
    "description": "Air Waybill",
    "commodityItemNo": "123456",
    "shipper": {
      "accountNumber": "123456",
      "name": "ACME Corporation",
      "address": "123 Business Ave, Suite 100",
      "city": "San Francisco",
      "country": "USA",
      "stateOrProvince": "CA",
      "postalCode": "94105",
      "street": "123 Business Ave, Suite 100",
      "taxId": "12-3456789"
    },
    "consignee": {
      "accountNumber": "789012",
      "name": "Global Imports Ltd",
      "address": "456 Commerce Street",
      "country": "UK",
      "stateOrProvince": "London",
      "city": "London",
      "postalCode": "EC2A 4PB",
      "street": "456 Commerce Street",
      "taxId": "GB123456789"
    },
    "carriersAgent": {
      "accountNumber": "345678",
      "iataCode": "12345678",
      "name": "International Freight Services",
      "address": "789 Logistics Ave",
      "country": "USA",
      "stateOrProvince": "NY",
      "city": "New York",
      "postalCode": "10001",
      "street": "789 Logistics Ave",
      "taxId": "12-3456789"
    },
    "airline": {
      "name": "Global Airways",
      "address": "321 Aviation Blvd",
      "country": "USA",
      "stateOrProvince": "TX",
      "city": "Dallas",
      "postalCode": "75201",
      "street": "321 Aviation Blvd"
    },
    "airWaybillNumber": {
      "mawbNumber": "12345678901",
      "hawbNumber": "123456789"
    },
    "airWaybillDate": "2024-01-15",
    "airportOfDeparture": {
      "airportCode": "SFO",
      "city": "San Francisco",
      "country": "USA",
      "name": "San Francisco International Airport"
    },
    "airportOfDestination": {
      "airportCode": "LHR",
      "city": "London",
      "country": "UK",
      "name": "London Heathrow Airport"
    },
    "flightAndDate": [
      {
        "flight": "GA123",
        "flightDate": "2024-01-16"
      }
    ],
    "declaredValueForCarriage": 50000,
    "declaredValueForCustoms": 50000,
    "amountOfInsurance": 55000,
    "currency": "USD",
    "lineItems": [
      {
        "quantity": 10,
        "quantityUom": "pieces",
        "grossWeightKg": 100,
        "grossWeightLb": 220.46,
        "rateClass": "M",
        "commodityItemNo": "1234",
        "chargeableWeight": 100,
        "rateOrCharge": 5,
        "total": 500,
        "length": 50,
        "width": 40,
        "height": 30,
        "dimensionsUom": "cm",
        "description": "Electronics"
      }
    ],
    "dimensions": [
      {
        "length": 50,
        "width": 40,
        "height": 30,
        "dimensionsUom": "cm"
      }
    ],
    "totals": {
      "totalQuantity": 10,
      "totalQuantityUom": "pieces",
      "totalWeight": 100,
      "totalWeightUom": "kg",
      "totalChargeableWeight": 100,
      "rateOrCharge": 5,
      "total": 500,
      "volume": 0.06,
      "volumeUom": "m³"
    },
    "charges": {
      "weightCharges": 500,
      "valuationCharges": 50,
      "tax": 50,
      "pickupCharge": 25,
      "freightAdvance": 0,
      "totalPrepaid": 625,
      "totalCollect": 0,
      "otherCharges": [
        25,
        24
      ],
      "totalOtherCharges": 49
    }
  }
}

Authorizations

Authorization
string
header
required

Our API offers authentication via API keys. You can obtain an API key from https://developer.abbyy.com

Path Parameters

documentId
string
required

The id of the document

Response

Extracted Air Waybill Data Response

meta
object
required

Represents a document that has been submitted for processing.

Examples:
{
"id": "wh23anb5xjf0ntw5taase5qz",
"name": "document.jpg",
"createdAt": "2025-02-07T17:44:06.949Z",
"model": "image-to-text",
"status": "Processed",
"pageCount": 10,
"errors": [{ "message": "Total is required" }]
}
fields
object

Fields extracted from an air waybill

Examples:
{
"description": "Air Waybill",
"commodityItemNo": "123456",
"shipper": {
"accountNumber": "123456",
"name": "ACME Corporation",
"address": "123 Business Ave, Suite 100",
"city": "San Francisco",
"country": "USA",
"stateOrProvince": "CA",
"postalCode": "94105",
"street": "123 Business Ave, Suite 100",
"taxId": "12-3456789"
},
"consignee": {
"accountNumber": "789012",
"name": "Global Imports Ltd",
"address": "456 Commerce Street",
"country": "UK",
"stateOrProvince": "London",
"city": "London",
"postalCode": "EC2A 4PB",
"street": "456 Commerce Street",
"taxId": "GB123456789"
},
"carriersAgent": {
"accountNumber": "345678",
"iataCode": "12345678",
"name": "International Freight Services",
"address": "789 Logistics Ave",
"country": "USA",
"stateOrProvince": "NY",
"city": "New York",
"postalCode": "10001",
"street": "789 Logistics Ave",
"taxId": "12-3456789"
},
"airline": {
"name": "Global Airways",
"address": "321 Aviation Blvd",
"country": "USA",
"stateOrProvince": "TX",
"city": "Dallas",
"postalCode": "75201",
"street": "321 Aviation Blvd"
},
"airWaybillNumber": {
"mawbNumber": "12345678901",
"hawbNumber": "123456789"
},
"airWaybillDate": "2024-01-15",
"airportOfDeparture": {
"airportCode": "SFO",
"city": "San Francisco",
"country": "USA",
"name": "San Francisco International Airport"
},
"airportOfDestination": {
"airportCode": "LHR",
"city": "London",
"country": "UK",
"name": "London Heathrow Airport"
},
"flightAndDate": [
{
"flight": "GA123",
"flightDate": "2024-01-16"
}
],
"declaredValueForCarriage": 50000,
"declaredValueForCustoms": 50000,
"amountOfInsurance": 55000,
"currency": "USD",
"lineItems": [
{
"quantity": 10,
"quantityUom": "pieces",
"grossWeightKg": 100,
"grossWeightLb": 220.46,
"rateClass": "M",
"commodityItemNo": "1234",
"chargeableWeight": 100,
"rateOrCharge": 5,
"total": 500,
"length": 50,
"width": 40,
"height": 30,
"dimensionsUom": "cm",
"description": "Electronics"
}
],
"dimensions": [
{
"length": 50,
"width": 40,
"height": 30,
"dimensionsUom": "cm"
}
],
"totals": {
"totalQuantity": 10,
"totalQuantityUom": "pieces",
"totalWeight": 100,
"totalWeightUom": "kg",
"totalChargeableWeight": 100,
"rateOrCharge": 5,
"total": 500,
"volume": 0.06,
"volumeUom": "m³"
},
"charges": {
"weightCharges": 500,
"valuationCharges": 50,
"tax": 50,
"pickupCharge": 25,
"freightAdvance": 0,
"totalPrepaid": 625,
"totalCollect": 0,
"otherCharges": [25, 24],
"totalOtherCharges": 49
}
}
validationErrors
object[]

An array of validation errors that occurred while processing the document. These typically do not prevent field extraction, but rather indicate issues extracting key fields.

I