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

GetImage - Retrieve shipping documents based on DocumentID

POST
https://api.ltlp.kuehne-nagel.com/api/imaging/image
Imaging
Last modified:2024-11-04 17:38:37
The GetImage API endpoint retrieves a specific shipping document as a Base64-encoded PDF file using the DocumentID obtained from the GetImageList endpoint.

Input Parameters:#

1.
Authentication & Account Information:
UserName, ClientCode, and AuthenticationID verify user identity and permissions.
2.
Document Identification:
DocumentID: Unique identifier for the specific document to be downloaded (obtained from GetImageList).

Output Structure:#

ErrorMessage: Provides details if an error occurs during the request.
Images: An array containing the requested document in Base64-encoded format within the Image field, allowing for direct decoding and rendering as a PDF.
This endpoint enables users to fetch and download the actual content of a specific shipping document.

Request

Body Params application/json
UserName
string 
required
ClientCode
string 
required
AuthenticationID
string 
required
DocumentID
string 
required
Example
{
  "UserName": "string",
  "ClientCode": "string",
  "AuthenticationID": "string",
  "DocumentID": "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/image' \
--header 'Content-Type: application/json' \
--data-raw ''

Responses

🟢200OK
application/json
Image is returned as a Base64 Encoded string
Body
ErrorMessage
string  | null 
optional
Images
array [object {1}] 
optional
Image
string 
optional
Example
{
  "ErrorMessage": "string",
  "Images": [
    {
      "Image": "string"
    }
  ]
}
Previous
GetImageList - Retrieve list of available shipment documents
Next
Invoice - Retrieve a single invoice or pull an entire week of invoices
Built with