Source: https://developers.woosmap.com/products/stores-api/overview/

> For clean Markdown of any page, append `.md` to the page URL.

> For a complete documentation index, see https://developers.woosmap.com/llms.txt

# Overview



## What is the Stores API?

Stores API lets you manage, query, filter, and search your store and asset data. In Woosmap, each location you manage is called an _asset_ (also referred to as a _store_). Upload your assets using the [Data Management](/products/stores-api/features/data-management/) endpoints, then search them using the query syntax. Results are returned as [GeoJSON](https://datatracker.ietf.org/doc/html/rfc7946), making them easy to display on maps or process in your application.

## Core Capabilities

### Data Management

Manage your store and asset data through a REST API:

- **[Add Assets](/products/stores-api/features/data-management/#add-assets)** - Create new assets in batch via `POST`
- **[Update Assets](/products/stores-api/features/data-management/#update-assets)** - Modify existing assets via `PUT`
- **[Replace Assets](/products/stores-api/features/data-management/#replace-assets)** - Replace all assets atomically
- **[Delete Assets](/products/stores-api/features/data-management/#delete-assets)** - Remove assets individually or in bulk
- **[Get Assets](/products/stores-api/features/data-management/#get-assets)** - Retrieve asset data via `GET`

### Search Endpoints

Two endpoints for querying your data:

**[Search](/products/stores-api/features/search/)** - Query your assets using a syntax that supports filtering by type, tag, name, city, country, custom properties, and more. Combine attribute filters with [geographic parameters](/products/stores-api/features/search/#geographic-search) to narrow results by proximity to a point, along a polyline, or within defined zones.

**[Autocomplete](/products/stores-api/features/autocomplete/)** - Perform full-text search on your assets' localized names. Returns predictions as users type, with highlighted matching substrings for easy front-end rendering.

## Common Patterns

Most implementations follow one of these workflows:

- **Store locator** - Search by user location → Display nearby stores on a map
- **Attribute filtering** - Search by type/tag/properties → Display matching stores
- **Name search** - Autocomplete on user input → Search by store_id for full details
- **Route-based search** - Search along a polyline → Show stores along the way

## Integration Options

Stores API can be integrated in several ways, depending on your project's needs.

- **REST API**: The most flexible option for any backend, mobile, or custom application.
- **Map JS API**: Use the [`StoresService`](/products/map-api/reference/1.4/#woosmap.map.StoresService) class for web apps that combine maps and store search.
- **Store Locator Widget**: A ready-made UI component for displaying stores with built-in search.
- **Mobile SDKs**: Native iOS and Android SDKs for mobile applications.

[Choose the best integration path for your project →](/products/stores-api/guides/integration-path/)

## Get Started

[Make your first Stores API call →](/products/stores-api/tutorials/making-first-request/)