Report Request Tracking: Get request status
Using this API, you can get the status of the "Report request" that was triggered in the first step (Report Request API) and can get the report's URL
Overview
With help of this API, Enterprise can get the latest status of the "Report Request" created through the "Report Request API" and can get the "Report URL" from which CSV file can be downloaded
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
- India
- North America
- Europe
- Middle East
- South East Asia
Important Links
NOTE
The difference between Start Time and End Time cannot be more that 24 hours.
Query Parameters
Query Parameters to be passed directly in the URL.
| Field Name | Data Type | Field | Description | Max Length | Example |
|---|---|---|---|---|---|
key | String | Mandatory | Unique license key provided by Clickpost for the enterprise | 100 | "00000000-0000-0000-0000-000000000000" |
report_reference_number | String | Mandatory | The reference number for the report which was received in the response of "Report Request API" (first step). |
Response
meta [meta parameters]
| Field Name | Data Type | Description | Example |
|---|---|---|---|
success | Boolean | Indicates the success of the API request | true |
message | String | The message from clickpost. In case of success it will be "SUCCESS". In case that there are no courier partners that are servicing the pincodes it will be”Pin code not serviceable" | "SUCCESS" |
status | HTTP Code | The HTTP response status code of the API request | 200 |
result [result parameters]
| Field Name | Data Type | Description | Example |
|---|---|---|---|
report_name | String | The Name of the requested report | TRACKORDER DASHBOARD_REPORT |
s3_link | String | The URL where you can download the Report | "https://clickpost-reports-bucket.s3.amazonaws.com/DOWNLOAD/TRACKING/180611_1667545779.3474863.csv?AWSAccessKeyId=AKIAJPHMJUW5YRJQWS7A&Signature=azSJOPPRGGCfBVPbKSvfoBDuMBw%3D&Expires=1667632185 " |
report_created_at | String | The date and time when the report was requested. The date and time is in UTC | "2022-11-04 07:09" |
report_status | String | The status of the report | "SUCCESS" |
Updated over 1 year ago