CLclickpost

Pincode Serviceability Check

The API takes the pincode and returns an array of all the serviceable carrier partners

get/api/v1/pincode_search_overall/

Request

  • Base URL
    https://serviceability.clickpost.in
  • URL
    https://serviceability.clickpost.in/api/v1/pincode_search_overall/
  • Auth
    none required

Query parameters

usernamestring required

Enter the username of the Clickpost dashboard

keystring required

Enter the API key given to you by the Clickpost team

pincodestring required

The PIN code of the location for which you want to check serviceability

is_pickup_pincodeboolean required

Set as true if you want to check if the location is serviceable for pick up. Set as false otherwise

is_rvpstring required

Set as true if you want to check if the location is serviceable for reverse pick up. Set as false otherwise

Response

200

OR
OR

Example response

{
  "meta": {
    "success": true,
    "message": "SUCCESS",
    "status": 200
  },
  "result": [
    {
      "account_type__account_name": "Symphony_Delhivery",
      "account_type__courier_partner__name": "Delhivery",
      "pickup_pincode_serviceability__order_type": "PREPAID"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.