GET
/
v1-preview
/
models
/
arrival-notice
/
{documentId}
from abbyy_document_ai import DocumentAi
import os


with DocumentAi(
    api_key_auth=os.getenv("DOCUMENTAI_API_KEY_AUTH", ""),
) as document_ai:

    res = document_ai.models.arrival_notice.get_extracted_fields(document_id="wh23anb5xjf0ntw5taase5qz")

    assert res.arrival_notice is not None

    # Handle response
    print(res.arrival_notice)
{
  "meta": {
    "id": "wh23anb5xjf0ntw5taase5qz",
    "name": "document.jpg",
    "createdAt": "2025-02-07T17:44:06.949Z",
    "model": "arrival-notice",
    "status": "Processed",
    "pageCount": 10,
    "errors": [
      {
        "message": "Total is required"
      }
    ]
  },
  "fields": {
    "shipper": {
      "name": "ACME Corporation",
      "address": "123 Business Ave, Suite 100, San Francisco, CA 94105"
    },
    "consignee": {
      "name": "Global Imports Ltd",
      "address": "456 Commerce Street, London, UK EC2A 4PB"
    },
    "notifyParty": {
      "name": "International Freight Services",
      "address": "789 Logistics Ave, New York, NY 10001"
    },
    "carrier": {
      "name": "Global Shipping Lines",
      "scacCode": "GSLX"
    },
    "billTo": {
      "name": "Global Imports Ltd",
      "address": "456 Commerce Street, London, UK EC2A 4PB"
    },
    "date": "2024-01-15",
    "arrivalDate": "2024-01-20",
    "bolNumber": "BOL123456",
    "houseBolNumber": "HBL789012",
    "purchaseOrderNumber": "PO345678",
    "vesselName": "Global Voyager",
    "voyageNumber": "V123",
    "portOfLoading": "San Francisco, USA",
    "portOfDischarge": "London, UK",
    "terminal": "London Container Terminal, 123 Port Road, London",
    "placeOfReceipt": "San Francisco, USA",
    "placeOfDelivery": "London, UK",
    "containersNotInTable": [
      {
        "containerNumber": "CONT1234567",
        "sealNumber": "SEAL789012",
        "sizeType": "40HC"
      }
    ],
    "containers": [
      {
        "containerNumber": "CONT1234567",
        "sealNumber": "SEAL789012",
        "sealValue": "SEAL789012",
        "sizeType": "40HC",
        "numberOfPackages": 100,
        "weightMetric": 25000,
        "weightUomMetric": "kg",
        "weightNonmetric": 55115.5,
        "weightUomNonmetric": "lbs",
        "volumeMetric": 67.2,
        "volumeUomMetric": "m³",
        "volumeNonmetric": 2372,
        "volumeUomNonmetric": "ft³",
        "arrivalDate": "2024-01-20"
      }
    ],
    "weight": {
      "weightMetric": 25000,
      "weightUomMetric": "kg",
      "weightNonmetric": 55115.5,
      "weightUomNonmetric": "lbs"
    },
    "packages": {
      "numberOfPackages": 100,
      "packageType": "PLT"
    },
    "volume": {
      "volumeMetric": 67.2,
      "volumeUomMetric": "m³",
      "volumeNonmetric": 2372,
      "volumeUomNonmetric": "ft³"
    },
    "amount": {
      "total": 50000,
      "currency": "USD"
    },
    "terms": {
      "prepaid": true,
      "collect": false
    }
  }
}

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

200
application/json

Extracted Arrival Notice Data Response

​
meta
object
required

Represents a document that has been submitted for processing.

Example:
{
  "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 arrival notice

Example:
{
  "shipper": {
    "name": "ACME Corporation",
    "address": "123 Business Ave, Suite 100, San Francisco, CA 94105"
  },
  "consignee": {
    "name": "Global Imports Ltd",
    "address": "456 Commerce Street, London, UK EC2A 4PB"
  },
  "notifyParty": {
    "name": "International Freight Services",
    "address": "789 Logistics Ave, New York, NY 10001"
  },
  "carrier": {
    "name": "Global Shipping Lines",
    "scacCode": "GSLX"
  },
  "billTo": {
    "name": "Global Imports Ltd",
    "address": "456 Commerce Street, London, UK EC2A 4PB"
  },
  "date": "2024-01-15",
  "arrivalDate": "2024-01-20",
  "bolNumber": "BOL123456",
  "houseBolNumber": "HBL789012",
  "purchaseOrderNumber": "PO345678",
  "vesselName": "Global Voyager",
  "voyageNumber": "V123",
  "portOfLoading": "San Francisco, USA",
  "portOfDischarge": "London, UK",
  "terminal": "London Container Terminal, 123 Port Road, London",
  "placeOfReceipt": "San Francisco, USA",
  "placeOfDelivery": "London, UK",
  "containersNotInTable": [
    {
      "containerNumber": "CONT1234567",
      "sealNumber": "SEAL789012",
      "sizeType": "40HC"
    }
  ],
  "containers": [
    {
      "containerNumber": "CONT1234567",
      "sealNumber": "SEAL789012",
      "sealValue": "SEAL789012",
      "sizeType": "40HC",
      "numberOfPackages": 100,
      "weightMetric": 25000,
      "weightUomMetric": "kg",
      "weightNonmetric": 55115.5,
      "weightUomNonmetric": "lbs",
      "volumeMetric": 67.2,
      "volumeUomMetric": "m³",
      "volumeNonmetric": 2372,
      "volumeUomNonmetric": "ft³",
      "arrivalDate": "2024-01-20"
    }
  ],
  "weight": {
    "weightMetric": 25000,
    "weightUomMetric": "kg",
    "weightNonmetric": 55115.5,
    "weightUomNonmetric": "lbs"
  },
  "packages": {
    "numberOfPackages": 100,
    "packageType": "PLT"
  },
  "volume": {
    "volumeMetric": 67.2,
    "volumeUomMetric": "m³",
    "volumeNonmetric": 2372,
    "volumeUomNonmetric": "ft³"
  },
  "amount": { "total": 50000, "currency": "USD" },
  "terms": { "prepaid": true, "collect": false }
}
​
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.

Was this page helpful?