Terminal Shipping API
  • Introduction
  • Example Book Shipment Flow
  • Ship with Code
  • Authentication
  • Errors
  • Libraries & Plugins
  • API ENDPOINTS
  • Addresses
    • Create Address
    • Get Addresses
    • Get Address
    • Update Address
    • Validate Address
    • Set Default Sender Address
    • Get Default Sender Address
  • Carriers
    • Get Carriers
    • Get Carrier
    • Enable Carrier
    • Enable Multiple Carriers
    • Disable Carrier
    • Disable Multiple Carriers
    • Drop-off Locations
  • Claims
    • Get Claims
    • Get Claim
    • File Claim
  • HS Codes
    • Get HSCodes
    • Get HSCode Chapters
    • Get HSCode Categories
    • Get HSCode Details
    • Search HSCodes
  • Insurance
    • Get Insurance
    • Get Insurances List
    • Get Insurance Premium
    • Get Insurance Premium Using Parcel Value
    • Purchase Insurance
  • Packaging
    • Create Packaging
    • Update Packaging
    • Get Packaging
    • Terminal Default Packaging
    • Get Specific Packaging
  • Parcels
    • Create Parcel
    • Update Parcel
    • Get Parcels
    • Get Parcel
  • Rates
    • Get Rates for Shipment
    • Get Quotes for Shipment
    • Get Rates for Multi-Parcel Shipment
    • Get Rates
    • Get Rate
  • Simplified HS Codes
    • Get Simplified HSCodes
    • Get Simplified HSCode Chapters
    • Get Simplified HSCode Categories
    • Get Simplified HSCode Details
    • Search Simplified HSCodes
  • Shipments
    • Create Shipment
    • Create Quick Shipment
    • Update Shipment
    • Get Shipments
    • Get Shipments v2
    • Get Shipment
    • Track a Shipment
    • Cancel Shipment
    • Delete Shipment
    • Duplicate Shipment
    • Arrange Pickup & Delivery for Shipment
  • Transactions
    • Get Transactions
    • Get Transaction
  • Users
    • Get User
    • Get Wallet Info
    • Get Wallet Balance
    • Get User Carriers
  • Webhooks
    • Create Webhook
    • Delete Webhook
    • Disable Webhook
    • Enable Webhook
    • Get Webhooks
    • Get Webhook
  • MISCALLANEOUS
    • Carriers Available
    • Carrier Object
    • Cities
    • Countries
    • File Claim Object
    • Parcel Item
    • Quick Shipments
      • Parcel
      • Pickup / Delivery Address
    • Shipment Events
    • Shipment Extras
    • States
    • Webhook Events
      • Handling Webhook Events
    • Volumetric Weight
Powered by GitBook
On this page

Was this helpful?

  1. Shipments

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

{
    "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": "danielozeh@gmail.com",
            "first_name": "Daniel",
            "is_residential": true,
            "last_name": "Ozeh",
            "line1": "045 Oladimeji street",
            "line2": "",
            "phone": "+2348134277988",
            "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": "nnamdi@terminal.africa",
            "first_name": "Nnamdi",
            "is_residential": true,
            "last_name": "Okoh",
            "line1": "12 Olaiya street, alausa",
            "line2": "",
            "phone": "+2348122689641",
            "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"
    }
}

PreviousGet ShipmentNextCancel Shipment

Last updated 2 years ago

Was this helpful?