​
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.arrival_notice.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.arrival_notice.get_extracted_fields(
          document_id=doc_id
      )
      processed = res.arrival_notice.meta.status == "Processed"

  print(res.arrival_notice.fields)

​
Extracted Fields

Field NameDescription
Document InformationInformation about the arrival notice.
  NumberThe arrival notice number.
  DateThe date of the arrival notice.
ShipperInformation about the sender of the goods.
  NameThe shipper’s name.
  AddressThe shipper’s address.
ConsigneeInformation about the recipient of the goods.
  NameThe consignee’s name.
  AddressThe consignee’s address.
Notify partyInformation about the company to be notified.
  NameThe name of the company to be notified of the arrival.
  AddressThe address of the company to be notified.
CarrierInformation about the carrier.
  NameThe carrier’s name.
  SCAC CodeThe Standard Carrier Alpha Code.
Bill toInformation about the recipient of the invoice.
  NameThe name of the invoice recipient.
  AddressThe address of the invoice recipient.
Arrival DateThe arrival date of the shipment.
BoL NumberThe number of the bill of lading.
House BoL NumberThe number of the house bill of lading.
Purchase Order NumberThe number of the purchase order.
Vessel NameThe name of the ship.
Voyage NumberThe number of the voyage.
Port of LoadingThe port where the goods are to be loaded.
Port of DischargeThe port where the goods are to be discharged.
TerminalThe terminal at the port of discharge.
Place of ReceiptThe place of receipt of the goods.
Place of DeliveryThe place of delivery of the goods.
Containers not in TableInformation about containers not listed in the table.
  Container NumberThe number of the container.
  Seal NumberThe number of the seal.
  Size/TypeThe size and type of the container.
ContainersInformation about containers in the table.
  Container NumberThe number of the container.
  Seal NumberThe number of the seal.
  Size/TypeThe size and type of the container.
  Weight MetricThe weight in metric units.
  Weight NonmetricThe weight in non-metric units.
  Weight UoM MetricThe unit of measure for metric weight.
  Weight UoM NonmetricThe unit of measure for non-metric weight.
  Volume MetricThe volume in metric units.
  Volume NonmetricThe volume in non-metric units.
  Volume UoM MetricThe unit of measure for metric volume.
  Volume UoM NonmetricThe unit of measure for non-metric volume.
  Number of PackagesThe number of packages in the container.
WeightInformation about the total weight.
  Weight MetricThe total weight in metric units.
  Weight NonmetricThe total weight in non-metric units.
  Weight UoM MetricThe unit of measure for total metric weight.
  Weight UoM NonmetricThe unit of measure for total non-metric weight.
VolumeInformation about the total volume.
  Volume MetricThe total volume in metric units.
  Volume NonmetricThe total volume in non-metric units.
  Volume UoM MetricThe unit of measure for total metric volume.
  Volume UoM NonmetricThe unit of measure for total non-metric volume.
PackagesInformation about the total number of packages.
  Number of PackagesThe total number of packages.
AmountInformation about the total amount.
  TotalThe total price of the goods.
  CurrencyThe currency of the arrival notice.
TermsInformation about payment terms.
  PrepaidThe freight payment terms. Specifies which party is liable for paying the freight bill.
  CollectThis is a checkmark field and can have one of the following values: Prepaid - the transport expenses are charged to the shipper or Collect - the transport expenses are charged to the consignee.

​
Validation Rules

RuleDescription
Check or calculate Total WeightIf there is one container, copies the weight values from the container to the total weight fields. If there are multiple containers, checks if the total weight matches the sum of container weights and prompts for correction if needed.
Copy weight UoMCopies weight units of measure between container and total weight fields, prompting for selection if multiple values exist.
Check or calculate Total VolumeIf there is one container, copies the volume values from the container to the total volume fields. If there are multiple containers, checks if the total volume matches the sum of container volumes and prompts for correction if needed.
Copy volume UoMCopies volume units of measure between container and total volume fields, prompting for selection if multiple values exist.
Check or calculate Total PackagesIf there is one container, copies the number of packages from the container to the total packages field. If there are multiple containers, checks if the total packages matches the sum of container packages and prompts for correction if needed.

​
Supported Languages

CountriesLanguages
GlobalEnglish