This API allows downloading the selected label of a specific consignment as a file.
| Property | Value |
|---|---|
| URL | {{BASE_URL}}/api/v1/consignment-labels/{label_id}/download |
| HTTP Method | GET |
| Content Type | application/json |
| Authentication | APIKEY header |
| Parameter Name | Parameter Type | Required | Description |
|---|---|---|---|
label_id |
Integer | Required | Label ID |
Below is an example HTTP raw request for the API request.
GET {{BASE_URL}}/api/v1/consignment-labels/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": "Label not found"
}
]
}