get https://www.clickpost.in/api/v1/shipment-security-key
Fetch shipment security key API give the security key for each shipment that you can consume and store corresponding to a shipment in the system.
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.
Important Links
Response
meta [meta parameters]
| Field Name | Data Type | Description |
|---|---|---|
success | Boolean | Indicates the success of the API request |
message | String | SUCCESS in case request was successfully processed by Clickpost, else returns error message. |
status | HTTP Code | The HTTP response status code of the API request |
result [result parameters]
| Field Name | Data Type | Description |
|---|---|---|
waybill | string | The airway bill number of the shipment for which the security key needs to be fetched |
cp_id | num | The carrier partner ID |
security_key | string | The security key |
reference_number | string | The unique reference number of the API response |