Reporting APIs

Overview

There are 2 APIs which needs to be used to fetch all shipment updates from Clickpost on a daily bases

Steps to Retrieve the Report

The Reports API is an asynchronous API wherein first a POST request needs to be sent to which will return a unique report reference number, post which the enterprise needs to hit the GET API and enter the report_reference_number to get the s3_link of the requested report

1. Step 1: Hit the POST Report Request API

1. Step 2: Hit the GET Report Request Tracking

Best practices:

1. Request for shipment updates received daily
2. Fetch the file using GET API and create the shipments in your data warehouse which are not present in your system but present in the file. For shipments present in your system, update their status as per the Clickpost Unified Status in the file.