GetImage - Retrieve shipping documents based on DocumentID

POST

https://api.ltlp.kuehne-nagel.com/api/imaging/image

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:

Authentication & Account Information:

UserName, ClientCode, and AuthenticationID verify user identity and permissions.

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

Example

{
    "UserName": "string",
    "ClientCode": "string",
    "AuthenticationID": "string",
    "DocumentID": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.ltlp.kuehne-nagel.com/api/imaging/image' \
--header 'Content-Type: application/json' \
--data-raw '{
    "UserName": "string",
    "ClientCode": "string",
    "AuthenticationID": "string",
    "DocumentID": "string"
}'

Responses

🟢200OK

application/json

Image is returned as a Base64 Encoded string

Body

Example

{
    "ErrorMessage": "string",
    "Images": [
        {
            "Image": "string"
        }
    ]
}

GetImageList - Retrieve list of available shipment documents

Invoice - Retrieve a single invoice or pull an entire week of invoices