post https://serviceability.clickpost.in/api/v3/serviceability_api/
By entering the drop_pincode, the enterprises can determine whether the Pincode is serviceable by any of their active carriers or not.
Important Links
Payload Example
[
{
"order_type": "COD",
"pickup_pincode":"380015",
"service_type": "FORWARD'/ 'RVP'/EXCHANGE",
"drop_pincode": "380001"
}
]
[{
"drop_pincode": "380001"
}]
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 |
optional [optional parameters]
| Field Name | Data Type | Field | Description |
|---|---|---|---|
order_type | enum | Optional | The Order typeCOD or PREPAID |
pickup_pincode | string | Optional | The pickup pincode for which the serviceability needs to be ascertained |
service_type | enum | Mandatory | 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.Enter EXCHANGE in case of exchange order |
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”Pincode 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 |
|---|---|---|---|
serviceable | Boolean | Whether the particular drop pincode is serviceable. Note: If the enterprise has multiple warehouse, then you need to pass the pickup_pincode | "380015" |
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 |