canonical: https://jentic.com/apis/swaggerhub.ferguson-api/api-locations

# Ferguson Api API Locations

Ferguson's Location API for exchanging location data with internal Ecommerce platforms and 3rd party companies. &nbsp;&nbsp; > Fetch summary list of locations via pagination: <details> <summary>Click to see example response</summary> </details> --- --- > Fetches details for a specific location based on id and application scope: For external users, this endpoint features a refined response. <detail. The API exposes 3 endpoints secured with oauth2 authentication.

## For AI agents

Programmatically getlocations, getlocationbyid. Covers 3 operations with oauth2 authentication.

## Scope

Does not handle payments, communications, or crm - use for maps and geolocation only.

## Capabilities

- getLocations
- getLocationById
- getLatLong
- Query and filter API Locations records by parameters
- Monitor API Locations operational status and events

## Use cases

### Maps and Geolocation Operations

Use the API Locations to perform maps geolocation operations programmatically. The API provides 3 endpoints covering core functionality including getlocations, getlocationbyid, getlatlong.

Example prompt: Call GET /v2/locations to getlocations

### Automated Location Summary Management

Automate location summary operations by combining multiple API Locations endpoints. Agents can getlocationbyid and then getlatlong in a single workflow.

Example prompt: Call GET /v2/locations/{locationId} to getlocationbyid, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call API Locations endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle oauth2 tokens manually.

Example prompt: Search Jentic for 'getlocations', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | /v2/locations | getLocations |
| GET | /v2/locations/{locationId} | getLocationById |
| GET | /v2/locations/geocode/{outputFormat} | getLatLong |

## Key resources

- **Location Summary** — Fetches a summary of location data via pagination using query parameters.
- **Location Detail** — Returns specific location information for just one location id.
- **Geocode** — Converts an address into geographic coordinates. (Can also do reverse geocoding)

## Why Jentic

- **Setup:** Wiring the API Locations endpoint by hand means running Ferguson's OAuth 2.0 client credentials exchange, choosing between the UAT and production hosts, and refreshing the token yourself. Through Jentic you install once, import API Locations from the API Directory, store the client credentials once, and your agent calls it.
- **Permission scoping:** API Locations puts the location id in the URL path (/v2/locations/{locationId}), so a rule can pin your agent to one location: it can read that location and nothing else. You choose the operations it may call, so listing all locations or geocoding is not included unless you add it.
- **Credential handling:** Your Ferguson client credentials are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'look up a branch location' or 'geocode an address', and Jentic returns the matching API Locations operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Here** — Alternative maps geolocation API
- **Tomtom** — Alternative maps geolocation API
- **Googleapis** — Complementary maps geolocation API

## FAQ

### What authentication does the API Locations use?

The API Locations uses OAuth 2.0 for authorization. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I getlocations with the API Locations?

Yes. Use the GET /v2/locations endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the API Locations?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I getlocations through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'getlocations'. Jentic returns the matching API Locations operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the API Locations have?

The API Locations exposes 3 endpoints covering location summary, location detail, geocode operations.

### Can I limit what my agent is allowed to do with the API Locations?

Yes. Because you self-host Jentic One, your own rules decide which API Locations operations and credentials the agent may use. Since the location id sits in the URL path (GET /v2/locations/{locationId}), you can pin the agent to a single location so it reads that one and nothing else. You also choose which operations it may call, so listing every location via GET /v2/locations or geocoding an address via the geocode endpoint stays off limits unless you add it.