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
- The enterprise can get all the serviceable drop pin codes for all of the carrier partners combined
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
NOTE
The API will give an array of all serviceable pincodes in response
Query Parameters
Field Name | Data Type | Field | Description | Max Length | Example |
---|---|---|---|---|---|
username | string | Mandatory | Username of the enterprise | 100 | test-enterprise |
key | string | Mandatory | Unique license key provided by Clickpost for the enterprise | 36 | 00000000-0000-0000-0000-000000000000 |
Response
meta
[meta parameters]
Field Name | Data Type | Description | Example |
---|---|---|---|
success | Boolean | Indicates the success of the API request | true |
message | String | SUCCESS in case request was successfully processed by Clickpost, else returns error message. | "SUCCESS" |
status | HTTP Code | The HTTP response status code of the API request | 200 |
result
[result parameters]
Field Name | Data Type | Description | Example |
---|---|---|---|
drop_pincodes | JSON Object | The JSON object which contains the list of pincodes for PREPAID and COD | {"PREPAID": ["380001","380015"], "COD": ["380001","380015"]} |
PREPAID | List | Contains the list of all the pincodes for PREPAID shipments | [ "744112", "744106", "744105", ] |
COD | List | Contains the list of all the pincodes for COD shipments | [ "744112", "744106", "744105", ] |
Updated over 1 year ago