API Documentation

Locate nearby stores

get
https://crm-nightly-new.cc.capillarytech.com/store-locator/v1/brand/nearbystores

This endpoint retrieves a paginated list of stores near a given location, with optional filters for site status and actual distance calculation.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer

Page number for pagination.

boolean

Flag to enable actual distance calculation based on road network.

string

Filter stores by their operational status.

number

The latitude of the location to search near.

number

The longitude of the location to search near.

integer

Maximum distance (in meters) from the given location to search within.

integer

Number of results per page for pagination.

Headers
string
string
string
string
Responses

400

Bad Request - The request was malformed or parameters were invalid.

401

Unauthorized - Authentication credentials were missing or invalid.

403

Forbidden - The authenticated user does not have the necessary permissions.

404

Not Found - The requested resource could not be found.

500

Internal Server Error - An unexpected error occurred on the server.

Updated about 2 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago