Kuehne + Nagel LTL+
  1. Document Retrieval
Kuehne + Nagel LTL+
  • Overview
    • Introduction
    • Acceptable Use Policy
    • Getting Started
    • Full Integration API Workflow
    • Support & Feedback
  • Accessorials
    • Accessorial - Retrieve all accessorial charge codes
      GET
  • BillOfLading
    • BOL - Create a bill of lading PDF
      POST
  • Quoting
    • RateQuote - Submit a quote request
      POST
    • RateQuote - Submit a quote request for multiple points
      POST
  • Document Retrieval
    • GetImageList - Retrieve list of available shipment documents
      POST
    • GetImage - Retrieve shipping documents based on DocumentID
      POST
  • Invoice
    • Invoice - Retrieve a single invoice or pull an entire week of invoices
      POST
  • Shipment Tracking
    • HTML Tracking Link Generation
    • TrackingList - Get a list of shipment tracking information
      POST
    • TrackingDetails - Retrieve all the tracking details related to a shipment
      POST
  • Load Tendering
    • LoadTender - Tender a shipment
      POST
    • LoadTender - Tender a shipment
      POST
  • Transit
    • Transit - Receive transit time for a shipment lane.
      POST
  • Orders
    • Order
      POST
    • OrderDetails
      POST
  1. Document Retrieval

GetImageList - Retrieve list of available shipment documents

POST
https://api.ltlp.kuehne-nagel.com/api/imaging/imagelist
Imaging
Last modified:2024-11-20 15:11:02
The GetImageList API endpoint allows users to retrieve a list of available shipping documents for download based on specified invoice details.

Input Parameters:#

1.
Authentication & Account Information:
UserName, ClientCode, and AuthenticationID are used to validate the user and account.
2.
Document Retrieval Criteria:
CarrierCode specifies the carrier associated with the documents.
InvoiceNumber identifies the specific invoice for which documents are requested.
BalanceDue can be provided to specify if the invoice is a balance due. Valid values are B or blank

Output Structure:#

ErrorMessage: Provides error details if the request fails.
Images: An array containing the available documents, with each entry including:
DocumentID: Unique identifier for the document.
DocumentDescription: Description of the document type.
ClientCode: Code associated with the client requesting the document.

Available Document Types:#

Document Description
Bill Of Lading
Delivery Receipt (Proof Of Delivery)
Electronic Invoice
Letter of Authority
Manual Invoice
Other Documentation
Weight Inspection
This endpoint returns a list of downloadable document details, facilitating easy access to relevant shipping records.

Request

Body Params application/json
UserName
string 
required
ClientCode
string 
required
AuthenticationID
string 
required
CarrierCode
string 
required
InvoiceNumber
string 
required
BalanceDue
string 
required
Example
{
  "UserName": "string",
  "ClientCode": "string",
  "AuthenticationID": "string",
  "CarrierCode": "string",
  "InvoiceNumber": "string",
  "BalanceDue": "string"
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.ltlp.kuehne-nagel.com/api/imaging/imagelist' \
--header 'Content-Type: application/json' \
--data-raw ''

Responses

🟢200OK
application/json
OK
Body
ErrorMessage
string  | null 
optional
Images
array [object {3}] 
optional
DocumentID
string 
required
DocumentDescription
string 
required
ClientCode
string 
required
Example
{
  "ErrorMessage": "string",
  "Images": [
    {
      "DocumentID": "string",
      "DocumentDescription": "string",
      "ClientCode": "string"
    }
  ]
}
Previous
RateQuote - Submit a quote request for multiple points
Next
GetImage - Retrieve shipping documents based on DocumentID
Built with