Get Serviceable Stores

For a given delivery location, returns the list of active pickup stores (dark store/physical store) that are serviceable for the given drop location.

Prerequisites

  • The enterprise must be subscribed to the service.
  • The following configuration must be present in the ClickPost system:
    • Store Master Configuration
    • Store ↔ Courier Mapping
    • Serviceable boundaries defined per store-courier (for lat/long based config)
    • Serviceable pincodes uploaded per store-courier (for pincode based config)
    • To include ETA for the serviceable courier(s) of the store(s) in the response, corresponding ETA configuration must be set up — boundary-based ETA for lat/long configs and pincode-based ETA uploaded for pincode configs.

Note: Contact the ClickPost team for assistance with setup and service enablement.

Note

  • Stores that are not operational (i.e., outside their configured operating hours) will be excluded from the API response.

Allowed HTTP Methods

  • POST

URL

<baseURL>/api/v1/quickcom/get_serviceable_stores

baseURL - https://hld.clickpost.in

Headers

{
    "Content-Type": "application/json"
}

URL Query Parameters

ParameterTypeRequiredDescription
keystringYesClickPost API key used for authentication.

Sample API cURL

curl --location --request POST '<baseURL>/api/v1/quickcom/get_serviceable_stores?key=<API_KEY>' \
--header 'Content-Type: application/json' \
--data '{
    "drop_lat": 28.704134,
    "drop_long": 77.102512,
    "drop_pincode": "560102"
  }'

Request Payload

Field NameData TypeFieldDescription
drop_latdoubleConditional MandatoryThe latitude of the drop location
drop_longdoubleConditional MandatoryThe longitude of the drop location
drop_pincodestringConditional MandatoryThe pincode of the drop location

Either drop_lat and drop_long, or drop_pincode must be provided. Both options may also be supplied together.

Sample Request Payload

{
	"drop_lat": 28.704134,
	"drop_long": 77.102512,
	"drop_pincode": "560102"
}

Response JSON Format

Field NameData TypeDescriptionValue Constraints
metaJSON ObjectMetadata about the request, such as status codes and messages describing success or errors. Refer Possible Meta Statuses section below.cannot be null
resultJSON ArrayThe list of serviceable_store objects. Empty if no serviceable stores found.can be null or string if meta.success is false

meta object fields

Field NameData TypeDescriptionValue Constraints
messagestringHuman-readable message indicating success or describing the error.can be null or empty
statusintegerStatus code representing the result of the request (may include standard HTTP status codes).cannot be null
successbooleanIndicates whether the request was processed successfully (true) or not (false).cannot be null

serviceable_store object fields

Field NameData TypeDescriptionValue Constraints
store_idstringID of the pickup store as configured in the pickup store master configuration.cannot be null
store_namestringName of the pickup store as configured in the pickup store master configuration.can be null or empty
serviceable_accountsJSON ArrayThe list of serviceable_account objects.cannot be null

serviceable_account object fields

Field NameData TypeDescriptionValue Constraints
cp_namestringThe name of the carrier partner.cannot be null
cp_idintegerID of the courier partner mapped to the pickup store. Refer here to see the cp_id of ClickPost integrated couriers.cannot be null
account_codestringThe name of the configured courier partner account on the ClickPost Dashboard. Combination of cp_id + account_code identifies a unique courier partner account mapped to the pickup store for the enterprise.cannot be null
configured_etaintegerETA (estimated delivery time in minutes) of the courier configured by the enterprise. null if no eta is configured in the Clickpost system.can be null

Possible Meta Statuses

HTTP Status Codemeta.statusmeta.message
200200Request is executed successfully
4004001Invalid request json
4004002Request for invalid entity
4004003Invalid or missing query parameter
4004005User is not subscribed to the service
4014013Invalid API key
403403Access is not allowed
4044007API Not Found
500500Something went wrong in Clickpost server

Example Responses

Sample Success Response

{
  "meta": {
    "success": true,
    "message": "Request is executed successfully",
    "status": 200
  },
  "result": [
    {
      "store_id": "STORE001",
      "store_name": "Store XYZ",
      "serviceable_accounts": [
        {
          "cp_name": "Shadowfax Now Slot HLD",
          "cp_id": 220,
          "account_code": "Shadowfax_Now_HLD_1",
          "configured_eta": 25
        },
        {
          "cp_name": "Delhivery HLD",
          "cp_id": 180,
          "account_code": "Delhivery_HLD_4",
          "configured_eta": null
        }
      ]
    }
  ]
}

Sample Error Response

{
  "result": "Either drop_pincode or both drop_lat and drop_long must be provided",
  "meta": {
    "status": 4001,
    "success": false,
    "message": "Request for invalid entity"
  }
}
{
  "result": "drop_lat and drop_long must be provided together",
  "meta": {
    "status": 4001,
    "success": false,
    "message": "Request for invalid entity"
  }
}


Did this page help you?