Report Request

Using this API, Enterprise can create a request to fetch all the shipment updates received for a day in Clickpost.

Overview

With help of this API, Enterprise can raise a request to get status updates for all the shipments present in Clickpost dashboard. Enterprise will get 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.

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

Important Links

🚧

NOTE

The difference between Start Time and End Time cannot be more that 24 hours. The API will only return shipments whose latest tracking scan falls within the specified time range.

❗️

NOTE

The start time and end time are in UTC.

URL Parameters

Query Parameters to be passed directly in the URL.

Field NameData TypeFieldDescriptionMax LengthExample
keyStringMandatoryUnique license key100Provided by Clickpost team

Request Payload

Field NameData TypeFieldDescriptionMax LengthExample
filters > updated_at_start_timestringMandatoryStart date timestamp in UTC (e.g., "2021-08-01 00:00:00")"2022-11-01 00:00:00"
filters > updated_at_end_timestringMandatoryEnd date timestamp in UTC (e.g., "2021-08-01 23:59:00")
NOTE: The difference between start time and end time cannot be more than 24 hours.
"2022-11-01 23:59:00"
report_name stringMandatoryAcceptable values -
  1. TRACK_ORDER_DASHBOARD_REPORT: to fetch shipment level data
    2.RETURN_TRACK_ORDER_DASHBOARD_REPORT: to fetch return/exchange information data
"TRACK_ORDER_DASHBOARD_REPORT"
fieldsStringMandatoryFor
  1. TRACK_ORDER_DASHBOARD_REPORT: Add Field Ids in the list to get only data of specific fields. E.g.,: ["1", "21". "42"] Possible values of Field Ids listed here -- https://docs.clickpost.ai/docs/complete-list-of-fields-available-in-reporting-api List can be empty too. An empty list returns the CSV file with default fields.
  2. RETURN_TRACK_ORDER_DASHBOARD_REPORT: Add field IDs in the list to get only data of specific fields. List of field IDs is available here: https://docs.clickpost.ai/docs/complete-list-of-fields-available-in-return_track_order_dashboard_report. PII data is not available by default in reporting APIs. Request access for them from your Clickpost relationship manager.
"fields": ["1", "21". "42"]

Response

meta [meta parameters]

Field NameData TypeDescriptionExample
successBooleanIndicates the success of the API requesttrue
messageStringThe success/failure result"SUCCESS"
statusHTTP CodeThe HTTP response status code of the API request200

result [result parameters]

Field NameData TypeDescriptionExample
report_nameStringThe Name of the requested reportTRACKORDER
DASHBOARD_REPORT
report_reference_numberStringThe reference number for the report. This will be used in the GET API to download the report1324902
report_created_atStringThe date and time when the report was requested. The date and time is in UTC"2022-11-04 07:09"

Did this page help you?