Track a Shipment

Get tracking details for a shipment.

/shipments/track/:shipment_id

GET https://api.terminal.africa/v1/shipments/track/:shipment_id

This endpoint allows you to track the most recent status of a shipment.

Path Parameters

Name	Type	Description
shipment_id*	String	Unique reference for shipment.

Headers

Name	Type	Description
Authorization*	String	Set value to Bearer SECRET_KEY

200 Shipment tracking status retrieved successfully.

{
    "status": true,
    "message": "Shipment tracking status retrieved successfully",
    "data": {
        "address_to": {
            "user": "USER-12568655307",
            "city": "Apapa",
            "coordinates": {
                "lat": 6.48,
                "lng": 3.3758384
            },
            "country": "NG",
            "email": "[e-mail]",
            "first_name": "Daniel",
            "is_residential": true,
            "last_name": "Ozeh",
            "line1": "045 Oladimeji street",
            "line2": "",
            "phone": "[phone]",
            "state": "Lagos",
            "zip": "100123",
            "address_id": "AD-80439326931",
            "created_at": "2022-06-09T11:27:47.885Z",
            "updated_at": "2022-06-09T11:27:47.885Z"
        },
        "address_from": {
            "user": "USER-12568655307",
            "city": "Lagos",
            "coordinates": {
                "lat": 6.6112856,
                "lng": 3.3582179
            },
            "country": "NG",
            "email": "[e-mail]",
            "first_name": "Nnamdi",
            "is_residential": true,
            "last_name": "Okoh",
            "line1": "12 Olaiya street, alausa",
            "line2": "",
            "phone": "[phone]",
            "state": "Lagos",
            "zip": "100126",
            "address_id": "AD-77298486083",
            "created_at": "2022-06-10T20:27:14.051Z",
            "updated_at": "2022-06-10T20:27:14.051Z"
        },
        "carrier": {},
        "carrier_tracking_number": "",
        "delivery_arranged": "",
        "delivery_date": "",
        "pickup_date": null,
        "status": "draft",
        "tracking_status": {},
        "events": [],
        "shipment_id": "SH-16380611554"
    }
}