Skip to main content
GET
/
brands
/
api
/
v1
/
public
/
brands
/
{brand_id}
/
locator
Find stores carrying a brand
curl --request GET \
  --url https://www.closient.com/brands/api/v1/public/brands/{brand_id}/locator
{
  "brand": {
    "id": "<string>",
    "name": "<string>",
    "website": "",
    "logo_url": "<string>"
  },
  "stores": [
    {
      "id": "<string>",
      "name": "<string>",
      "address": "<string>",
      "lat": 0,
      "lon": 0,
      "distance_km": 1,
      "product_count": 1,
      "retailer_name": "",
      "phone": "",
      "website": ""
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.closient.com/llms.txt

Use this file to discover all available pages before exploring further.

Path Parameters

​
brand_id
string<shortuuid>
required

Brand short id (22-char shortuuid).

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Query Parameters

​
lat
number
required

Latitude of the search centre in decimal degrees, WGS 84 / EPSG:4326. Typically obtained from the browser's navigator.geolocation API or a geocoded user query.

Required range: -90 <= x <= 90
​
lon
number
required

Longitude of the search centre in decimal degrees, WGS 84 / EPSG:4326.

Required range: -180 <= x <= 180
​
radius
number
default:50

Search radius in kilometres. Locations farther than this from (lat, lon) are excluded.

​
limit
integer
default:20

Maximum number of stores to return (1-100). Results are pre-sorted by distance ascending.

Required range: 1 <= x <= 100
​
product_id
string | null

Optional product short id to filter stores by. When set, only stores carrying that specific product are returned.

Response

200 - application/json

OK

Top-level payload for the brand locator endpoint.

​
brand
BrandSummaryOut · object
required

Identity of the brand the widget is rendering. Lets the widget render branding without a second request.

Example:
{
  "id": "2sP1Y9pZ4xQ6rNvHwT3kBe",
  "logo_url": "https://cdn.closient.com/brands/acme/logo.png",
  "name": "Acme Beverages",
  "website": "https://acme.example.com"
}
​
stores
StoreLocatorOut · object[]
required

Physical stores within radius km of (lat, lon) that carry at least one of the brand's products, sorted by ascending great-circle distance. Empty list when no stores match.