Skip to main content

​
Usage

Copy the code block, replace YOUR_API_KEY with your API key, then process documents quickly.
from abbyy_document_ai import DocumentAi

with DocumentAi(api_key_auth=YOUR_API_KEY) as document_ai:
  res = document_ai.models.bill_of_lading.begin_field_extraction(input_source={
    "url": "https://example.com/document.pdf",
  })

  assert res.documents is not None
  doc_id = res.documents[0].id

  processed = False
  while not processed:
      time.sleep(3)  # Wait 3 seconds between checks
      res = document_ai.models.bill_of_lading.get_extracted_fields(
          document_id=doc_id
      )
      processed = res.bill_of_lading.meta.status == "Processed"

  print(res.bill_of_lading.fields)

​
Extracted Fields

Field NameDescription
BoL NumberBill of lading number.
BoL DateThe date on which the bill of lading was made.
PO NumberThe purchase order number.
Sales Order NumberThe sales order number.
Shipment IDThe shipment identifier.
Shipment DateThe date of the shipment.
Pro NumberA shipment identifier assigned by the carrier.
Vehicle NumberThe number of the transport vehicle or carriage.
Seal NumberThe seal number.
TermsThe freight payment terms. Can be Prepaid, Collect, or Third Party.
NMFC CodeNational Motor Freight Classification shipment identifier.
ClassNational Motor Freight Classification shipment class.
Port of LoadingThe origin of the shipment.
Port of DischargeThe destination of the shipment.
Pickup DateThe date on which the shipment is handed over.
Estimated Time of Arrival (ETA)The estimated time of arrival.
Special InstructionsSpecial handling instructions for the carrier.
Number of PackagesThe total number of packages.
Package TypeThe package type (e.g., “Pallet” or “PLT”).
Total Weight NonmetricThe total weight in non-metric units.
Total Weight UoM NonmetricThe non-metric unit of measurement for weight.
Total Weight MetricThe total weight in metric units.
Total Weight UoM MetricThe metric unit of measurement for weight.
Hazardous MaterialIndicates if the shipment contains hazardous materials.
Emergency Contact InfoContact information for hazardous material emergencies.
ShipperInformation about the shipper.
  NameThe shipper’s name.
  AddressThe shipper’s address.
ConsigneeInformation about the consignee.
  NameThe consignee’s name.
  AddressThe consignee’s address.
CarrierInformation about the carrier.
  NameThe carrier’s name.
  SCAC CodeThe Standard Carrier Alpha Code.
Bill toInformation about the carrier.
  NameInformation about the organization or business unit responsible for paying the freight fees (if different from both the shipper and the consignee).
  Address

​
Validation Rules

RuleDescription
Check CheckmarksDefines the field value using the possible values for Terms/Prepaid, Terms/Collect, Terms/ThirdParty (if checked on the bill), as well as Terms/PrepaidWordOrDefault if the Prepaid payment type is set by default or specified as a word, and Terms/CollectWordOrDefault if the Collect payment type is set by default or specified as a word.

​
Supported Languages

CountriesLanguages
GlobalEnglish
⌘I