Fetch Daily Shipments Created Count

With help of this API enterprises can get the count of shipments created/registered on the Clickpost platform date-wise to track the performance on a daily bases.

Suggest Edits

Overview

  1. Fetch Daily Shipments Count API gives the count of shipments created/registered on the Clickpost platform date-wise.
  2. You can request a start and end date and the API will give date wise shipment count for each date including the start and end date.
  3. The API will give date-wise AWBs generated ["manifestation" key in API response] via Clickpost and AWBs registered ["tracking" key in API response] to track via Clickpost.

📘

Since this API runs on top of the data generated offline, please make request for shipments created till D-2 date every day, i.e. If you are making a request to fetch shipments count today

[Example: 9th March 2022], set the end date as D-2 [i.e. 7th March 2022]

Run in Postman API Reference

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 TypeFieldDescriptionMax LengthExample
keystringMandatoryUnique license key provided by Clickpost for the enterprise00000000-0000-0000-0000-000000000000
start_datedateMandatoryStart date in YYYY-MM-DD format2022-11-01
end_datedateMandatoryEnd date in YYYY-MM-DD format2022-11-30

Response

meta [meta parameters]

Field NameData TypeDescriptionExample
successBooleanIndicates the success of the API requesttrue
messageStringThe message from Clickpost. In case of success it will be "SUCCESS". In case that there are no carrier partners that are servicing the pincodes it will be”Pin code not serviceable""SUCCESS"
statusHTTP CodeThe HTTP response status code of the API request200

result [result parameters]

Field NameData TypeDescriptionExample
dateJSON ObjectThe count of Manifestation and Tracking on that date"2022-01-03": {
"manifestation": 5,
"tracking": 5
}
manifestationnumCount of Manifestation orders created1200
trackingnumCount of tracking orders created5000

📘

The number of manifestation will not always be equal to tracking, since enterprise could have AWBs that they have enabled just for tracking

❗️

The maximum difference between start date and end date can not be more than 6 months

API Response

{
    "meta": {
        "status": 200,
        "success": true,
        "message": "Success"
    },
    "result": {
        "2022-01-01": {},
        "2022-01-02": {},
        "2022-01-03": {
            "manifestation": 5,
            "tracking": 5
        },
        "2022-01-04": {
            "manifestation": 19,
            "tracking": 19
        },
        "2022-01-05": {
            "manifestation": 23,
            "tracking": 23
        },
        "2022-01-06": {
            "manifestation": 3,
            "tracking": 6
        },
        "2022-01-07": {
            "manifestation": 24,
            "tracking": 28
        },
        "2022-01-08": {
            "manifestation": 9,
            "tracking": 9
        },
        "2022-01-09": {},
        "2022-01-10": {
            "manifestation": 18,
            "tracking": 19
        },
        "2022-01-11": {
            "manifestation": 8,
            "tracking": 8
        },
        "2022-01-12": {
            "manifestation": 6,
            "tracking": 6
        },
        "2022-01-13": {
            "manifestation": 5,
            "tracking": 6
        },
        "2022-01-14": {
            "manifestation": 2,
            "tracking": 4
        },
        "2022-01-15": {},
        "2022-01-16": {},
        "2022-01-17": {},
        "2022-01-18": {
            "manifestation": 4,
            "tracking": 4
        },
        "2022-01-19": {
            "manifestation": 21,
            "tracking": 19
        },
        "2022-01-20": {
            "manifestation": 9,
            "tracking": 9
        },
        "2022-01-21": {
            "manifestation": 3,
            "tracking": 3
        },
        "2022-01-22": {
            "manifestation": 5,
            "tracking": 5
        },
        "2022-01-23": {},
        "2022-01-24": {
            "manifestation": 13,
            "tracking": 13
        },
        "2022-01-25": {
            "manifestation": 15,
            "tracking": 16
        },
        "2022-01-26": {},
        "2022-01-27": {
            "manifestation": 5,
            "tracking": 6
        },
        "2022-01-28": {
            "manifestation": 5,
            "tracking": 5
        },
        "2022-01-29": {},
        "2022-01-30": {},
        "2022-01-31": {
            "manifestation": 5,
            "tracking": 6
        }
    }
}

Updated over 1 year ago