Overview

1. Fetch shipment security key API gives the security key for each shipment that you can consume and store corresponding to a shipment in the system.
2. This security key is useful if you have the security feature enabled on Clickpost's tracking page. If the security feature is enabled on your Clickpost tracking page, you need to ensure you consume the shipment security key and pass it in URL param key while rendering the tracking page at your end.

❗

With the security feature enabled, if you do not pass the security key in the tracking page URL for each shipment, the tracking page will not work as expected.

Usecase

This is a standard API which applies to all MPS (Multi-Piece Shipment) and SPS (Single Piece Shipment) orders

Geography

This is a standard API which supports all shipments created and transported within

1. India
2. North America
3. Europe
4. Middle East
5. South East Asia

Query Parameters

Response

meta [meta parameters]

result [result parameters]

API Response

{
    "meta": {
        "status": 200,
        "message": "Success",
        "success": true
    },
    "result": {
        "waybill": "19025410024065",
        "cp_id": 4,
        "security_key": "c020a025-9511-4a46-b1bd-31e87ad64c65",
        "reference_number": "CR61622155"
    }
}