Overview

By entering the pincode, the enterprise can get all the serviceable carriers

The enterprise will be able to know which types of services are available for the particular pick-up or drop pincode. The enterprise can know if COD (Cash on Delivery), PREPAID (payment done in advance)
You can use the serviceability API to trigger order creation/ order manifestation based on the API response

Usecase

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

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
`pincode`	`string`	Mandatory	The PIN code of the location for which you want to check serviceability	10	"380001"
`is_pickup_pincode`	`Boolean`	Mandatory	Set as true if you want to check if the location is serviceable for pick up. Set as false otherwise	5	"true"
`is_rvp`	`Boolean`	Mandatory	Set as true if you want to check if the location is serviceable for reverse pick up. Set as false otherwise	5	"false"

meta [meta parameters]

Field Name	Data Type	Description	Example
`success`	`Boolean`	Indicates the success of the API request	`true`
`message`	`String`	The message from Clickpost. In case of success, it will be "SUCCESS". In case there are no carrier partners that are servicing the pincodes it will be”Pin code not serviceable"	"SUCCESS"
`status`	HTTP Code	The HTTP response status code of the API request	200

result [result parameters]

Field Name	Data Type	Description	Example
`account_type__account_name`	`string`	Account name of the carrier as stored in the Clickpost Dashboard	"SDD_Delhivery"
`account_type__courier_partner__name`	`String`	Name of the carrier partner	`Delhivery`
`pickup_pincode_serviceability__order_type`	`String`	Order Type	`PREPAID`