> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Storerocket plugin

> Storerocket is a store locator. This plugin reads the token profile and projects, manages locations with opening hours, filters and custom fields through the create, PATCH, PUT and DELETE contracts, and schedules holiday special-hours rules with idempotency keys.

Use **Storerocket** through Corsair: one client, typed API calls.

Tokens are created at storerocket.io/app/api-tokens and authenticate with the Bearer scheme; the docs say not to use an X-API-Key header or a token in the URL. Token permissions select what works: location:read for reads, location:create, location:update and location:delete for writes, and location operations also require the project's API access (Business plan). The shared limit is 1,000 requests per minute; a 429 carries Retry-After and this plugin waits it out. Location POST, PATCH and PUT have no idempotency contract (the docs warn a retried POST can create a second location), so only reads are replayed on a 5xx; special-hours POST and PATCH accept an Idempotency-Key header. Location list reads paginate with page and limit (1 to 100) and return links.next plus meta totals; keep the same filters and include flags on every page. List filters use bracket notation (city\[eq]=Seattle) and only the documented field/operator combinations are accepted. The legacy V1 location and lead API is not covered; this plugin builds against the current v2 contract.

**What you get:**

* 13 typed API operations

## Setup

**1. Install**

```bash npm theme={null}
npm install corsair @corsair-dev/storerocket better-sqlite3
npm install --save-dev @types/better-sqlite3
```

```bash yarn theme={null}
yarn add corsair @corsair-dev/storerocket better-sqlite3
yarn add --dev @types/better-sqlite3
```

```bash pnpm theme={null}
pnpm install corsair @corsair-dev/storerocket better-sqlite3
pnpm install --save-dev @types/better-sqlite3
```

```bash bun theme={null}
bun add corsair @corsair-dev/storerocket better-sqlite3
bun add --dev @types/better-sqlite3
```

**2. Add the plugin**

```ts corsair.ts theme={null}
import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { storerocket } from '@corsair-dev/storerocket';

export const corsair = createCorsair({
	plugins: [
		storerocket(),
	],
	database: new Database('corsair.db'),
	kek: process.env.CORSAIR_KEK!,
	multiTenancy: true,
	hub: {
		projectApiKey: process.env.CORSAIR_API_KEY!,
		signingSecret: process.env.CORSAIR_SIGNING_SECRET!,
	},
});
```

With `multiTenancy: true`, scope calls with `corsair.withTenant(id)`. See [Quick start](https://docs.corsair.dev/quick-start.md) for KEK + Hub keys, and [Multi-tenancy](https://docs.corsair.dev/concepts/multi-tenancy.md) for account isolation.

**3. Choose authentication**

> [tab] API Key (Recommended)
>
> Store the Storerocket API key before the first call: `pnpm corsair setup --plugin=storerocket --tenant=acme api_key=<your-key>` (leave out `--tenant` without `multiTenancy`), or pass it as `key` in the plugin options. With Hub, each tenant enters their own key on the connect page. See [API key auth](https://docs.corsair.dev/concepts/api-key).
>
> ```ts theme={null}
> storerocket()
> ```
>
> More: [API Key](https://docs.corsair.dev/concepts/api-key)

**4. Connect a tenant**

Mint a connect link and send the tenant to it. Hub hosts the page and delivers the result to your app — see [Connect / OAuth](https://docs.corsair.dev/management/connect).

```ts theme={null}
const { connectUrl } = await corsair.manage.connect.createLink({
	plugin: 'storerocket',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl
```

## Example API calls

**List locations of a project**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.storerocket.api.locations.list({});
```

**Create a location with a full week of hours**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.storerocket.api.locations.create({});
```

See the full list on the [API](https://docs.corsair.dev/plugins/storerocket/api.md) page.

## What's next

> [card] [API reference](https://docs.corsair.dev/plugins/storerocket/api.md)
>
> Every `storerocket.api.*` operation with input and output types.

> [card] [Connect / OAuth](https://docs.corsair.dev/management/connect)
>
> createLink, Hub delivery, and tenant connect flows.

> [card] [Use with agents](https://docs.corsair.dev/mcp-adapters/mcp-adapters)
>
> Expose this plugin's operations as MCP tools.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.