v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Retrieve nearby stores

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

get/store-locator/v1/brand/nearbystores

Query parameters

pageinteger

Page number for pagination.

actualDistanceboolean

Flag to enable actual distance calculation based on road network.

site_statusstring

Example:Active

Filter stores by their operational status.

latitudenumber

The latitude of the location to search near.

longitudenumber

The longitude of the location to search near.

distanceinteger

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

sizeinteger

Number of results per page for pagination.

Headers

cap_authorizationstring

Example:eyJpZHYiOlsiTU9CSUxFfDk1OTEzOTkyNDQiXSwiZGV2IjoiMTIzIiwib3JnIjoiS1JJU0hOQVNNQUxMIiwiYWxnIjoiSFMyNTYifQ.eyJpc3MiOiJDQVBJTExBUlkgVEVDSE5PTE9HSUVTIiwib2djIjpbIjUwNTgzfGtyaXNobmEudGlsbDAxIl0sImV4cCI6MTY2NDI2NjQ2OSwiaWF0IjoxNjY0MjYyODY5LCJyb2wiOiJWSUVXIn0.6ZFThZOZ6jQZ4JT-sG3DkiCBfiIxR07kjjqOYr-BJHQ

cap_device_idstring

Example:deviceId

cap_brandstring

Example:brand

cap_mobilestring

Example:identifierValue

Response

Successful response containing the paginated list of nearby stores and related information.

messagestring

A human-readable message indicating the result of the operation.

Example response

{
  "message": "Success"
}