Bulk Serviceability

By entering the carrier partner ID and account code, the enterprise can get all the serviceable drop and pickup pincodes

Overview

By entering the carrier partner ID and account code, the enterprise can get all the serviceable drop and pickup pincodes

The enterprise will be able to know which types of services are available for the particular pick-up and drop pincode. The enterprise can know if COD (Cash on Delivery), PREPAID (payment done in advance) or EXCHANGE (Deliver one good and take one good back to the warehouse) are serviceable or not by the carrier partner
You can use the serviceability API to trigger order creation/ order manifestation based on the API response

This is a standard API which applies to all MPS (Multi-Piece Shipment) and SPS (Single Piece Shipment) orders

This is a standard API which supports all shipments created and transported within

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

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
`carrier_partner_id`	`num`	Mandatory	Partner ID of the desired carrier	4	4
account_code	`string`	Mandatory	Name of the account registered on Clickpost dashboard for carrier partner. Will return a 400 Bad Request response if the given account is inactive or does not exist.	100	Delhivery_Express_B2C

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
`pickup_pincodes`	`JSON Object`	The JSON object which contains the list of pincodes for `PREPAID` and `COD`	{"PREPAID": ["380001","380015"], "COD": ["380001","380015"]}
`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