GetImageList - Retrieve list of available shipment documents

The GetImageList API endpoint allows users to retrieve a list of available shipping documents for download based on specified invoice details.

Input Parameters:

Authentication & Account Information:

UserName, ClientCode, and AuthenticationID are used to validate the user and account.

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 Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

application/json

Body

Example

{
    "ErrorMessage": "string",
    "Images": [
        {
            "DocumentID": "string",
            "DocumentDescription": "string",
            "ClientCode": "string"
        }
    ]
}

GetImageList - Retrieve list of available shipment documents

Input Parameters:#

Output Structure:#

Available Document Types:#

Request

Request Code Samples

Responses

Input Parameters:

Output Structure:

Available Document Types: