Fetch Drop pincodes

By entering the username and key, the enterprise can get all the serviceable drop pincodes, the enterprise can get all the serviceable drop pin codes for all of the carrier partners combined

Overview

By entering the username and key, the enterprise can get all the serviceable drop pincodes

  1. The enterprise can get all the serviceable drop pin codes for all of the carrier partners combined

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

πŸ“˜

NOTE

The API will give an array of all serviceable pincodes in response

Query Parameters

Field NameData TypeFieldDescriptionMax LengthExample
username stringMandatoryUsername of the enterprise100test-enterprise
keystringMandatoryUnique license key provided by Clickpost for the enterprise3600000000-0000-0000-0000-000000000000

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
drop_pincodesJSON ObjectThe JSON object which contains the list of pincodes for PREPAID and COD{"PREPAID": ["380001","380015"],
"COD": ["380001","380015"]}
PREPAIDListContains the list of all the pincodes for PREPAID shipments[
"744112",
"744106",
"744105",
]
CODListContains the list of all the pincodes for COD shipments[
"744112",
"744106",
"744105",
]