API Documentation
Documents
Document Conversion
Personal Earnings Statement
Certificate Of Origin
Dangerous Goods Declaration
International Consignment Note
Bill Of Lading
Get Bill Of Lading Fields
This endpoint returns an object representing the extracted bill-of-lading model fields from a document.
GET
/
v1-preview
/
models
/
bill-of-lading
/
{documentId}
using ABBYY.DocumentAI;
using ABBYY.DocumentAI.Schemas.Components;
var sdk = new DocumentAI(apiKeyAuth: "<YOUR_BEARER_TOKEN_HERE>");
var res = await sdk.Models.BillOfLading.GetExtractedFieldsAsync(documentId: "wh23anb5xjf0ntw5taase5qz");
// handle response
{
"meta": {
"id": "wh23anb5xjf0ntw5taase5qz",
"name": "document.jpg",
"createdAt": "2025-02-07T17:44:06.949Z",
"model": "bill-of-lading",
"status": "Processed",
"pageCount": 10,
"errors": [
{
"message": "Total is required"
}
]
},
"fields": {
"bolNumber": "BOL123456",
"bolDate": "2024-01-15",
"poNumber": "PO345678",
"salesOrderNumber": "SO789012",
"shipmentId": "SHIP456789",
"shipmentDate": "2024-01-16",
"proNumber": "PRO123456",
"vehicleNumber": "TRUCK789",
"sealNumber": "SEAL123456",
"terms": {
"prepaid": true,
"collect": false,
"thirdParty": false
},
"nmfcCode": "12345",
"class": "85",
"portOfLoading": "San Francisco, USA",
"portOfDischarge": "London, UK",
"specialInstructions": "Handle with care, temperature controlled",
"numberOfPackages": 100,
"packageType": "PLT",
"totalWeightNonmetric": 55115.5,
"totalWeightUomNonmetric": "lbs",
"totalWeightMetric": 25000,
"totalWeightUomMetric": "kg",
"hazardousMaterial": true,
"shipper": {
"name": "ACME Corporation",
"address": "123 Business Ave, Suite 100, San Francisco, CA 94105"
},
"carrier": {
"name": "Global Shipping Lines",
"scacCode": "GSLX"
},
"consignee": {
"name": "Global Imports Ltd",
"customerId": "CUST123456",
"address": "456 Commerce Street, London, UK EC2A 4PB"
},
"billTo": {
"name": "Global Imports Ltd",
"address": "456 Commerce Street, London, UK EC2A 4PB"
}
}
}
Authorizations
Our API offers authentication via API keys. You can obtain an API key from https://developer.abbyy.com
Path Parameters
The id of the document
Response
200
application/json
Extracted Bill Of Lading Data Response
Was this page helpful?
using ABBYY.DocumentAI;
using ABBYY.DocumentAI.Schemas.Components;
var sdk = new DocumentAI(apiKeyAuth: "<YOUR_BEARER_TOKEN_HERE>");
var res = await sdk.Models.BillOfLading.GetExtractedFieldsAsync(documentId: "wh23anb5xjf0ntw5taase5qz");
// handle response
{
"meta": {
"id": "wh23anb5xjf0ntw5taase5qz",
"name": "document.jpg",
"createdAt": "2025-02-07T17:44:06.949Z",
"model": "bill-of-lading",
"status": "Processed",
"pageCount": 10,
"errors": [
{
"message": "Total is required"
}
]
},
"fields": {
"bolNumber": "BOL123456",
"bolDate": "2024-01-15",
"poNumber": "PO345678",
"salesOrderNumber": "SO789012",
"shipmentId": "SHIP456789",
"shipmentDate": "2024-01-16",
"proNumber": "PRO123456",
"vehicleNumber": "TRUCK789",
"sealNumber": "SEAL123456",
"terms": {
"prepaid": true,
"collect": false,
"thirdParty": false
},
"nmfcCode": "12345",
"class": "85",
"portOfLoading": "San Francisco, USA",
"portOfDischarge": "London, UK",
"specialInstructions": "Handle with care, temperature controlled",
"numberOfPackages": 100,
"packageType": "PLT",
"totalWeightNonmetric": 55115.5,
"totalWeightUomNonmetric": "lbs",
"totalWeightMetric": 25000,
"totalWeightUomMetric": "kg",
"hazardousMaterial": true,
"shipper": {
"name": "ACME Corporation",
"address": "123 Business Ave, Suite 100, San Francisco, CA 94105"
},
"carrier": {
"name": "Global Shipping Lines",
"scacCode": "GSLX"
},
"consignee": {
"name": "Global Imports Ltd",
"customerId": "CUST123456",
"address": "456 Commerce Street, London, UK EC2A 4PB"
},
"billTo": {
"name": "Global Imports Ltd",
"address": "456 Commerce Street, London, UK EC2A 4PB"
}
}
}
Assistant
Responses are generated using AI and may contain mistakes.