GET
/
v1-preview
/
models
/
sea-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.SeaWaybill.GetExtractedFieldsAsync(documentId: "wh23anb5xjf0ntw5taase5qz");

// handle response
{
  "meta": {
    "id": "wh23anb5xjf0ntw5taase5qz",
    "name": "document.jpg",
    "createdAt": "2025-02-07T17:44:06.949Z",
    "model": "sea-waybill",
    "status": "Processed",
    "pageCount": 10,
    "errors": [
      {
        "message": "Total is required"
      }
    ]
  },
  "fields": {
    "shipper": {
      "accountNumber": "SHIP123456",
      "name": "Global Exports Ltd",
      "address": "123 Business Park, London, UK EC2A 4PB",
      "country": "United Kingdom",
      "stateOrProvince": "England",
      "city": "London",
      "postalCode": "EC2A 4PB",
      "street": "123 Business Park",
      "taxId": "GB123456789"
    },
    "consignee": {
      "accountNumber": "CONS789012",
      "name": "US Imports Inc",
      "address": "456 Trade Street, New York, NY 10001",
      "country": "United States",
      "stateOrProvince": "New York",
      "city": "New York",
      "postalCode": "10001",
      "street": "456 Trade Street",
      "taxId": "US987654321"
    },
    "notifyParty": {
      "name": "US Customs Broker",
      "address": "789 Customs Ave, New York, NY 10002",
      "country": "United States",
      "stateOrProvince": "New York",
      "city": "New York",
      "postalCode": "10002",
      "street": "789 Customs Ave",
      "taxId": "US123456789"
    },
    "carrier": "Ocean Freight Lines",
    "alsoNotifyParty": "US Port Authority",
    "waybillNumber": "SWB-2024-001",
    "scac": "OCFL",
    "icoNumber": [
      "ICO-001",
      "ICO-002"
    ],
    "vesselName": "Ocean Voyager",
    "voyageNumber": "VOY-2024-001",
    "portOfLoading": "Southampton",
    "portOfDischarge": "New York",
    "preCarriedBy": "Truck Transport Ltd",
    "placeOfReceipt": "London",
    "placeOfDelivery": "New York",
    "billOfLadingNumber": "BOL-2024-001",
    "bookingNo": "BK-2024-001",
    "reference": "REF-2024-001",
    "originOfGoods": "United Kingdom",
    "containers": [
      {
        "containerNumber": "CONT-001",
        "sealNumber": "SEAL-001",
        "containerType": "40HC",
        "quantity": 100,
        "quantityUom": "PCS",
        "netWeightKg": 1000,
        "grossWeightKg": 1100,
        "grossWeightLb": 2425,
        "volumeM3": 50,
        "volumeFt3": 1765
      }
    ],
    "lineItems": [
      {
        "marksAndNumbers": "CONT-001",
        "quantity": 100,
        "quantityUom": "PCS",
        "description": "Industrial Machinery",
        "grossWeightKg": 1100,
        "grossWeightLb": 2425,
        "volumeM3": 50,
        "volumeFt3": 1765
      }
    ],
    "totals": {
      "totalQuantity": 100,
      "totalQuantityUom": "PCS",
      "totalWeightKg": 1100,
      "totalVolumeM3": 50,
      "totalNumberOfContainers": 1,
      "totalNetWeightKg": 1000
    },
    "freightAndCharges": {
      "totalPrepaid": 5000,
      "currencyPrepaid": "USD",
      "totalCollect": 1000,
      "currencyCollect": "USD"
    },
    "placeOfIssueOfWaybill": "London",
    "shippedOnBoardDate": "2024-03-15",
    "dateOfWaybill": "2024-03-15"
  }
}

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 Sea 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 a sea waybill

Examples:
{
"shipper": {
"accountNumber": "SHIP123456",
"name": "Global Exports Ltd",
"address": "123 Business Park, London, UK EC2A 4PB",
"country": "United Kingdom",
"stateOrProvince": "England",
"city": "London",
"postalCode": "EC2A 4PB",
"street": "123 Business Park",
"taxId": "GB123456789"
},
"consignee": {
"accountNumber": "CONS789012",
"name": "US Imports Inc",
"address": "456 Trade Street, New York, NY 10001",
"country": "United States",
"stateOrProvince": "New York",
"city": "New York",
"postalCode": "10001",
"street": "456 Trade Street",
"taxId": "US987654321"
},
"notifyParty": {
"name": "US Customs Broker",
"address": "789 Customs Ave, New York, NY 10002",
"country": "United States",
"stateOrProvince": "New York",
"city": "New York",
"postalCode": "10002",
"street": "789 Customs Ave",
"taxId": "US123456789"
},
"carrier": "Ocean Freight Lines",
"alsoNotifyParty": "US Port Authority",
"waybillNumber": "SWB-2024-001",
"scac": "OCFL",
"icoNumber": ["ICO-001", "ICO-002"],
"vesselName": "Ocean Voyager",
"voyageNumber": "VOY-2024-001",
"portOfLoading": "Southampton",
"portOfDischarge": "New York",
"preCarriedBy": "Truck Transport Ltd",
"placeOfReceipt": "London",
"placeOfDelivery": "New York",
"billOfLadingNumber": "BOL-2024-001",
"bookingNo": "BK-2024-001",
"reference": "REF-2024-001",
"originOfGoods": "United Kingdom",
"containers": [
{
"containerNumber": "CONT-001",
"sealNumber": "SEAL-001",
"containerType": "40HC",
"quantity": 100,
"quantityUom": "PCS",
"netWeightKg": 1000,
"grossWeightKg": 1100,
"grossWeightLb": 2425,
"volumeM3": 50,
"volumeFt3": 1765
}
],
"lineItems": [
{
"marksAndNumbers": "CONT-001",
"quantity": 100,
"quantityUom": "PCS",
"description": "Industrial Machinery",
"grossWeightKg": 1100,
"grossWeightLb": 2425,
"volumeM3": 50,
"volumeFt3": 1765
}
],
"totals": {
"totalQuantity": 100,
"totalQuantityUom": "PCS",
"totalWeightKg": 1100,
"totalVolumeM3": 50,
"totalNumberOfContainers": 1,
"totalNetWeightKg": 1000
},
"freightAndCharges": {
"totalPrepaid": 5000,
"currencyPrepaid": "USD",
"totalCollect": 1000,
"currencyCollect": "USD"
},
"placeOfIssueOfWaybill": "London",
"shippedOnBoardDate": "2024-03-15",
"dateOfWaybill": "2024-03-15"
}
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.