GetImage - Retrieve shipping documents based on DocumentID
POST/imaging/imageLast modified: 19 days ago
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, andAuthenticationIDverify 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
Imagefield, 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
No schema defined
Example
Not configured
Request samples
Responses
OK(200)
HTTP Code: 200
Content Type : JSONapplication/json
Image is returned as a Base64 Encoded string
Data Schema
ErrorMessage
string | null
optional
Images
array [object {1}]
optional
Image
string
optional
Example
{
"ErrorMessage": "string",
"Images": [
{
"Image": "string"
}
]
}