Get Label

This API allows querying and getting details of a label by Label ID.

Endpoint Information

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

Request Parameters

URL Parameters

Parameter Name	Parameter Type	Required	Description
`label_id`	Integer	REQUIRED	Label ID

Example Usage

API Request

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

GET {{BASE_URL}}/api/v1/consignment-labels/149495
Content-Type: application/json
APIKEY: {{APIKEY}}

API Response

On a successful request, the API will return a response like this:

{
    "status": true,
    "message": null,
    "data": {
        "id": 149515,
        "consignment": {
            "id": 632182
        },
        "consignmentProvider": {
            "id": 9
        },
        "customer": {
            "id": 1
        },
        "fileName": "label_LPoooK.pdf",
        "fileMimeType": "application/pdf",
        "templateName": "Fedex Origin",
        "templateType": "pdf",
        "providerTrackingCode": "-",
        "labelType": 0
    }
}

Error Responses

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

{
    "status": false,
    "errors": [
        {
            "message": "1494952 id consignment label not found"
        }
    ]
}