Important Links

Payload Example

[{
    "optional": {
        "length": 10,
        "breadth": 10,
        "height": 10,
        "invoice_value": 999,
        "weight": 10,
        "service_type": "FORWARD"
    },
    "drop_pincode": "380001",
    "pickup_pincode": "380015"
}]

[
{
    "drop_pincode": "380001",
    "pickup_pincode": "380015"
}
]

Request Payload

Mandatory Field

Field Name	Data Type	Field	Description
`drop_pincode`	`num`	Mandatory	The drop pincode for which the serviceability needs to be ascertained
`pickup_pincode`	`num`	Mandatory	The pickup pincode for which the serviceability needs to be ascertained

optional [optional parameters]

Field Name	Data Type	Field	Description
`length`	`float`	Optional	The length of the shipment in centimeter. This field becomes mandatory if enterprise wants to calculate `shipping_charge`
`breadth`	`float`	Optional	The breadth of the shipment in centimeter. This field becomes mandatory if enterprise wants to calculate `shipping_charge`
`height`	`float`	Optional	The height of the shipment in centimeter. This field becomes mandatory if enterprise wants to calculate `shipping_charge`
`invoice_value`	`float`	Optional	The invoice value of the shipment in INR.
`weight`	`float`	Optional	The weight of the shipment in kilograms. This field becomes mandatory if enterprise wants to calculate `shipping_charge`
`cp_id`	`num`	Optional	Carrier Partner ID. This can be found on the dashboard or you can refer it to here. If you pass a cp_id, then the API will return the serviceability of that particular carrier partner
`service_type`	`enum`	Optional	The order type for which serviceability needs to be determined. Enter `FORWARD` if the shipments need to be delivered to the customer from the enterprise's warehouse. Enter `RVP` if the shipment needs to picked up from the customer’s location and delivered to the enterprise’s warehouse

Response

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
`cp_id`	`num`	Carrier Partner ID. This can be found on the dashboard or you can refer it to here	4
`service_type`	`String`	The order type for which serviceability needs to be determined. Forward if the shipments need to be delivered to the customer from the enterprises warehouse. RVP if the shipment needs to picked up from the customer’s location and delivered to the enterprise’s warehouse	`FORWARD`
`account_code`	`num`	Courier partner account name configured on the Clickpost dashboard	`Bluedart Surface`
`account_id`	`num`	The identifier for the particular carrier account	1938

serviceable [serviceable parameters]

Field Name	Data Type	Description	Example
`COD`	`Boolean`	Field indicates whether Cash on Delivery is supported by the particular carrier to the particular pincode	`true`
`PREPAID`	`Boolean`	Field indicates whether Prepaid is supported by the particular carrier to the particular pincode	`true`
`EXCHANGE`	`Boolean`	Field indicates whether Exchange is supported by the particular carrier to the particular pincode	`true`

comitted_sla [comitted_sla parameters]

Field Name	Data Type	Description	Example
`comitted_sla`	`num`	The committed Service Level Agreement that is given the corresponding carrier partner in days	3

shipping_charge [shipping_charge parameters]

Field Name	Data Type	Description	Example
`PREPAID`	`float`	Shipping Charges in INR for Prepaid type shipments for the corresponding pincodes	50.50
`COD`	`float`	Shipping Charges in INR for Cash on Delivery type shipments for the corresponding pincodes	50.50

zone [zone parameters]

Field Name	Data Type	Description	Example
`zone`	`string`	The zone which has been mapped with pincodes on the Clickpost dashboard under the carrier integration section (Pricing)	"North"