This endpoint returns an object representing the extracted packing-list model fields from a document.
using ABBYY.DocumentAI;
using ABBYY.DocumentAI.Schemas.Components;
var sdk = new DocumentAI(apiKeyAuth: "<YOUR_BEARER_TOKEN_HERE>");
var res = await sdk.Models.PackingList.GetExtractedFieldsAsync(documentId: "wh23anb5xjf0ntw5taase5qz");
// handle response
{
"meta": {
"id": "wh23anb5xjf0ntw5taase5qz",
"name": "document.jpg",
"createdAt": "2025-02-07T17:44:06.949Z",
"model": "packing-list",
"status": "Processed",
"pageCount": 10,
"errors": [
{
"message": "Total is required"
}
]
},
"fields": {
"shipper": {
"name": "Global Exports Ltd",
"address": "123 Business Park, London, UK EC2A 4PB",
"taxId": "GB123456789",
"iban": "GB29NWBK60161331926819",
"bankAccount": "12345678",
"bankCode": "NWBK"
},
"consignee": {
"name": "US Imports Inc",
"address": "456 Trade Street, New York, NY 10001"
},
"buyer": {
"name": "US Retail Corp",
"address": "789 Shopping Mall, New York, NY 10002"
},
"billTo": {
"name": "US Imports Inc",
"address": "456 Trade Street, New York, NY 10001"
},
"packingListNumber": "PL-2024-001",
"packingListDate": "2024-03-15",
"invoiceNumber": "INV-2024-001",
"invoiceDate": "2024-03-15",
"purchaseOrder": [
{
"number": "PO-2024-001",
"date": "2024-03-01"
}
],
"billOfLadingNumber": "BOL-2024-001",
"countryOfOrigin": "GB",
"countryOfFinalDestination": "US",
"modeOfTransportation": "SEA/OCEAN",
"shippingDate": "2024-03-20",
"incoterm": "CIF",
"lineItems": [
{
"position": 1,
"articleNumber": "ART-001",
"orderNumber": "PO-2024-001",
"invoiceNumber": "INV-2024-001",
"countryOfOrigin": "GB",
"containerNumber": "CONT-001",
"description": "Industrial Machinery",
"quantity": 5,
"unitOfMeasurement": "PCS",
"packageQuantity": 2,
"packageUnitOfMeasurement": "BOX",
"netWeight": 1000,
"netWeightUnitOfMeasurement": "KG",
"grossWeight": 1100,
"grossWeightUnitOfMeasurement": "KG",
"volume": 2.5,
"volumeUnitOfMeasurement": "M3",
"dimensions": "100x50x50",
"dimensionsUnitOfMeasurement": "CM",
"length": 100,
"width": 50,
"height": 50
}
],
"totalQuantity": {
"amount": 10,
"unitOfMeasurement": "PCS"
},
"totalPackages": {
"amount": 4,
"unitOfMeasurement": "BOX"
},
"totalNetWeight": {
"amount": 2000,
"unitOfMeasurement": "KG"
},
"totalGrossWeight": {
"amount": 2200,
"unitOfMeasurement": "KG"
},
"totalVolume": {
"amount": 5,
"unitOfMeasurement": "M3"
},
"totalDimensions": {
"amount": 200,
"unitOfMeasurement": "CM"
}
}
}
Our API offers authentication via API keys. You can obtain an API key from https://developer.abbyy.com
The id of the document
Extracted Packing List 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.PackingList.GetExtractedFieldsAsync(documentId: "wh23anb5xjf0ntw5taase5qz");
// handle response
{
"meta": {
"id": "wh23anb5xjf0ntw5taase5qz",
"name": "document.jpg",
"createdAt": "2025-02-07T17:44:06.949Z",
"model": "packing-list",
"status": "Processed",
"pageCount": 10,
"errors": [
{
"message": "Total is required"
}
]
},
"fields": {
"shipper": {
"name": "Global Exports Ltd",
"address": "123 Business Park, London, UK EC2A 4PB",
"taxId": "GB123456789",
"iban": "GB29NWBK60161331926819",
"bankAccount": "12345678",
"bankCode": "NWBK"
},
"consignee": {
"name": "US Imports Inc",
"address": "456 Trade Street, New York, NY 10001"
},
"buyer": {
"name": "US Retail Corp",
"address": "789 Shopping Mall, New York, NY 10002"
},
"billTo": {
"name": "US Imports Inc",
"address": "456 Trade Street, New York, NY 10001"
},
"packingListNumber": "PL-2024-001",
"packingListDate": "2024-03-15",
"invoiceNumber": "INV-2024-001",
"invoiceDate": "2024-03-15",
"purchaseOrder": [
{
"number": "PO-2024-001",
"date": "2024-03-01"
}
],
"billOfLadingNumber": "BOL-2024-001",
"countryOfOrigin": "GB",
"countryOfFinalDestination": "US",
"modeOfTransportation": "SEA/OCEAN",
"shippingDate": "2024-03-20",
"incoterm": "CIF",
"lineItems": [
{
"position": 1,
"articleNumber": "ART-001",
"orderNumber": "PO-2024-001",
"invoiceNumber": "INV-2024-001",
"countryOfOrigin": "GB",
"containerNumber": "CONT-001",
"description": "Industrial Machinery",
"quantity": 5,
"unitOfMeasurement": "PCS",
"packageQuantity": 2,
"packageUnitOfMeasurement": "BOX",
"netWeight": 1000,
"netWeightUnitOfMeasurement": "KG",
"grossWeight": 1100,
"grossWeightUnitOfMeasurement": "KG",
"volume": 2.5,
"volumeUnitOfMeasurement": "M3",
"dimensions": "100x50x50",
"dimensionsUnitOfMeasurement": "CM",
"length": 100,
"width": 50,
"height": 50
}
],
"totalQuantity": {
"amount": 10,
"unitOfMeasurement": "PCS"
},
"totalPackages": {
"amount": 4,
"unitOfMeasurement": "BOX"
},
"totalNetWeight": {
"amount": 2000,
"unitOfMeasurement": "KG"
},
"totalGrossWeight": {
"amount": 2200,
"unitOfMeasurement": "KG"
},
"totalVolume": {
"amount": 5,
"unitOfMeasurement": "M3"
},
"totalDimensions": {
"amount": 200,
"unitOfMeasurement": "CM"
}
}
}
This endpoint returns an object representing the extracted packing-list model fields from a document.
using ABBYY.DocumentAI;
using ABBYY.DocumentAI.Schemas.Components;
var sdk = new DocumentAI(apiKeyAuth: "<YOUR_BEARER_TOKEN_HERE>");
var res = await sdk.Models.PackingList.GetExtractedFieldsAsync(documentId: "wh23anb5xjf0ntw5taase5qz");
// handle response
{
"meta": {
"id": "wh23anb5xjf0ntw5taase5qz",
"name": "document.jpg",
"createdAt": "2025-02-07T17:44:06.949Z",
"model": "packing-list",
"status": "Processed",
"pageCount": 10,
"errors": [
{
"message": "Total is required"
}
]
},
"fields": {
"shipper": {
"name": "Global Exports Ltd",
"address": "123 Business Park, London, UK EC2A 4PB",
"taxId": "GB123456789",
"iban": "GB29NWBK60161331926819",
"bankAccount": "12345678",
"bankCode": "NWBK"
},
"consignee": {
"name": "US Imports Inc",
"address": "456 Trade Street, New York, NY 10001"
},
"buyer": {
"name": "US Retail Corp",
"address": "789 Shopping Mall, New York, NY 10002"
},
"billTo": {
"name": "US Imports Inc",
"address": "456 Trade Street, New York, NY 10001"
},
"packingListNumber": "PL-2024-001",
"packingListDate": "2024-03-15",
"invoiceNumber": "INV-2024-001",
"invoiceDate": "2024-03-15",
"purchaseOrder": [
{
"number": "PO-2024-001",
"date": "2024-03-01"
}
],
"billOfLadingNumber": "BOL-2024-001",
"countryOfOrigin": "GB",
"countryOfFinalDestination": "US",
"modeOfTransportation": "SEA/OCEAN",
"shippingDate": "2024-03-20",
"incoterm": "CIF",
"lineItems": [
{
"position": 1,
"articleNumber": "ART-001",
"orderNumber": "PO-2024-001",
"invoiceNumber": "INV-2024-001",
"countryOfOrigin": "GB",
"containerNumber": "CONT-001",
"description": "Industrial Machinery",
"quantity": 5,
"unitOfMeasurement": "PCS",
"packageQuantity": 2,
"packageUnitOfMeasurement": "BOX",
"netWeight": 1000,
"netWeightUnitOfMeasurement": "KG",
"grossWeight": 1100,
"grossWeightUnitOfMeasurement": "KG",
"volume": 2.5,
"volumeUnitOfMeasurement": "M3",
"dimensions": "100x50x50",
"dimensionsUnitOfMeasurement": "CM",
"length": 100,
"width": 50,
"height": 50
}
],
"totalQuantity": {
"amount": 10,
"unitOfMeasurement": "PCS"
},
"totalPackages": {
"amount": 4,
"unitOfMeasurement": "BOX"
},
"totalNetWeight": {
"amount": 2000,
"unitOfMeasurement": "KG"
},
"totalGrossWeight": {
"amount": 2200,
"unitOfMeasurement": "KG"
},
"totalVolume": {
"amount": 5,
"unitOfMeasurement": "M3"
},
"totalDimensions": {
"amount": 200,
"unitOfMeasurement": "CM"
}
}
}
Our API offers authentication via API keys. You can obtain an API key from https://developer.abbyy.com
The id of the document
Extracted Packing List 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.PackingList.GetExtractedFieldsAsync(documentId: "wh23anb5xjf0ntw5taase5qz");
// handle response
{
"meta": {
"id": "wh23anb5xjf0ntw5taase5qz",
"name": "document.jpg",
"createdAt": "2025-02-07T17:44:06.949Z",
"model": "packing-list",
"status": "Processed",
"pageCount": 10,
"errors": [
{
"message": "Total is required"
}
]
},
"fields": {
"shipper": {
"name": "Global Exports Ltd",
"address": "123 Business Park, London, UK EC2A 4PB",
"taxId": "GB123456789",
"iban": "GB29NWBK60161331926819",
"bankAccount": "12345678",
"bankCode": "NWBK"
},
"consignee": {
"name": "US Imports Inc",
"address": "456 Trade Street, New York, NY 10001"
},
"buyer": {
"name": "US Retail Corp",
"address": "789 Shopping Mall, New York, NY 10002"
},
"billTo": {
"name": "US Imports Inc",
"address": "456 Trade Street, New York, NY 10001"
},
"packingListNumber": "PL-2024-001",
"packingListDate": "2024-03-15",
"invoiceNumber": "INV-2024-001",
"invoiceDate": "2024-03-15",
"purchaseOrder": [
{
"number": "PO-2024-001",
"date": "2024-03-01"
}
],
"billOfLadingNumber": "BOL-2024-001",
"countryOfOrigin": "GB",
"countryOfFinalDestination": "US",
"modeOfTransportation": "SEA/OCEAN",
"shippingDate": "2024-03-20",
"incoterm": "CIF",
"lineItems": [
{
"position": 1,
"articleNumber": "ART-001",
"orderNumber": "PO-2024-001",
"invoiceNumber": "INV-2024-001",
"countryOfOrigin": "GB",
"containerNumber": "CONT-001",
"description": "Industrial Machinery",
"quantity": 5,
"unitOfMeasurement": "PCS",
"packageQuantity": 2,
"packageUnitOfMeasurement": "BOX",
"netWeight": 1000,
"netWeightUnitOfMeasurement": "KG",
"grossWeight": 1100,
"grossWeightUnitOfMeasurement": "KG",
"volume": 2.5,
"volumeUnitOfMeasurement": "M3",
"dimensions": "100x50x50",
"dimensionsUnitOfMeasurement": "CM",
"length": 100,
"width": 50,
"height": 50
}
],
"totalQuantity": {
"amount": 10,
"unitOfMeasurement": "PCS"
},
"totalPackages": {
"amount": 4,
"unitOfMeasurement": "BOX"
},
"totalNetWeight": {
"amount": 2000,
"unitOfMeasurement": "KG"
},
"totalGrossWeight": {
"amount": 2200,
"unitOfMeasurement": "KG"
},
"totalVolume": {
"amount": 5,
"unitOfMeasurement": "M3"
},
"totalDimensions": {
"amount": 200,
"unitOfMeasurement": "CM"
}
}
}