Download Document

This API allows downloading the selected document of a specific consignment as a file.

Endpoint Information

Property	Value
URL	`{{BASE_URL}}/api/v1/consignment-documents/{documentId}/download`
HTTP Method	`GET`
Content Type	`application/json`
Authentication	`APIKEY` header

Parameter Name	Parameter Type	Required	Description
`documentId`	Integer	Required	Document ID

Below is an example HTTP raw request for the API request.

GET {{BASE_URL}}/api/v1/consignment-documents/149495/download
APIKEY: {{APIKEY}}

On a successful request, the API response will provide a file stream with a variable content-type.

If the API request fails, the API will return an error response like this:

{
    "status": false,
    "errors": [
        {
            "message": "Document not found"
        }
    ]
}