Consignment Events

This API lists all events/movements of a consignment.

Endpoint Information

Property	Value
URL	`{{BASE_URL}}/api/v1/consignments/{consignment_id}/events`
HTTP Method	`GET`
Content Type	`application/json`
Authentication	`APIKEY` header

Request Parameters

URL Parameters

Parameter Name	Parameter Type	Required	Description
`consignment_id`	Integer	REQUIRED	Consignment ID

Optional Pagination URL Query Parameters

Parameter Name	Parameter Type	Required	Description
`page`	Integer	Optional	Page number
`limit`	Integer	Optional	Limit per page

Example Usage

API Request

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

GET {{BASE_URL}}/api/v1/consignments/632280/events?page=1&limit=10
Content-Type: application/json
APIKEY: {{APIKEY}}

API Response

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

{
    "status": true,
    "message": "successful",
    "data": [
        {
            "consignment": {
                "id": 632280
            },
            "status": 1,
            "statusMessage": "Consignment sent to provider",
            "statusDatetime": "2025-02-18T13:21:16+03:00",
            "provider": {
                "id": 1,
                "name": "Ptt"
            },
            "createdAt": "2025-02-18T13:21:16+03:00"
        }
    ],
    "meta": {
        "page": 1,
        "limit": 10,
        "total": 1
    }
}

Error Responses

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

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