Fetch Proof of Delivery

The API takes the waybill/AWB as input and returns the proof of delivery in PDF format as an URL

Suggest Edits

Overview

By entering the carrier partner ID and the AWB number, the enterprise can get the proof of delivery in PDF format

  1. Use POD API to eliminate fraud deliveries from your supply chain

  2. Use POD PDF as a reference for further escalations

  3. Use POD PDF as proof for reconciliation with the carrier partner

Run in Postman API Reference

Carriers who have POD integrated

Visit https://carriers.clickpost.ai/ and apply the filter : Services --> Proof of Delivery [POD]

📘

NOTE

  • The API will gives the S3 URL of the POD PDF
  • We have updated our base url from www.clickpost.in to api.clickpost.in, please note that we are supporting backward compatibility but we would recomment you to move to api.clickpost.in

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

Field NameData TypeFieldDescriptionExample
keystringMandatoryUnique license key provided by Clickpost for the enterprise00000000-0000-0000-0000-000000000000
waybillstringMandatoryThe Air Waybill number of shipment for which Proof of Delivery needs to be retrieved89185728612
cp_idnumMandatoryPartner ID of the desired carrier4

Response

meta [meta parameters]

Field NameData TypeDescriptionExample
successBooleanIndicates the success of the API requesttrue
messageStringSUCCESS in case request was successfully processed by Clickpost, else returns error message."SUCCESS"
statusHTTP CodeThe HTTP response status code of the API request200

result [result parameters]

Field NameData TypeDescriptionExample
pod_urlStringThe URL of the Proof Of Delivery PDF<https://pyck-res-bucket.s3.amazonaws.com:443/DELHIVERY/2019-03-01/258731.pdf>

Updated 3 months ago