> ## Documentation Index
> Fetch the complete documentation index at: https://996f455-productmetrics.manicule.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.
> For every page in one file, fetch https://996f455-productmetrics.manicule.dev/docs/llms-full.txt (large).
> To search and read these docs as tools, connect the MCP server at https://996f455-productmetrics.manicule.dev/docs/api/mcp.
> Every agent surface: https://996f455-productmetrics.manicule.dev/docs/.well-known/llms-manifest.json

# List shops (/docs/api/store-data/store-list-shops)

<!-- agent-signals: reading_time_min: 2 · est_tokens: 1015 · updated: 2026-11-16 -->
Related: [Get analytics status](/docs/api/store-data/analytics-get-status.md), [Query the lake](/docs/api/store-data/data-query.md), [Get an insight card](/docs/api/store-data/insights-get.md), [Get inventory state](/docs/api/store-data/inventory-get-state.md), [Check orders are available](/docs/api/store-data/orders-get-availability.md), [Get an order](/docs/api/store-data/orders-get.md)

> The shops (connected stores) behind the property, each with its productSpineStoreId, platform and name.

`GET https://prod-backend.productmetrics.io/api/public/v1/properties/{propertyId}/business-health/shops`

**Scope** `read` · **Access** Read only · **Operation id** `store.list_shops`

## Try it

`productmetrics` runs after `productmetrics login`; curl needs `PM_TOKEN` (see [Authentication](/docs/api/overview#authentication)). Set `$PROPERTY_ID` first.



**productmetrics CLI:**

```bash
productmetrics store list-shops --property-id $PROPERTY_ID --json
```

**curl:**

```bash
curl "https://prod-backend.productmetrics.io/api/public/v1/properties/$PROPERTY_ID/business-health/shops" \
  -H "Authorization: Bearer $PM_TOKEN"
```

## Response

API response (200):

```json
{
  "data": {
    "shops": [
      {
        "productSpineStoreId": "6f1c2a7e-3b4d-4e8f-9a01-2c3d4e5f6a7b",
        "platform": "lightspeed_c_series",
        "name": "Example Store"
      }
    ]
  },
  "request_id": "req_01JCSA4AMSATZDJ0KMNC0S4YGS"
}
```

**CLI output:** `productmetrics store list-shops --json` prints `{ "ok": true, "data": …, "request_id": "…" }` with the same `data`.

## Before you call

Pass one as `product_spine_store_id` to the store.get_health\_\* operations to read that shop instead of the first. Needs Pro: without it the call answers 402 subscription_required.

## Path parameters

| Name         | Type          | Description                                                                                                         |
| ------------ | ------------- | ------------------------------------------------------------------------------------------------------------------- |
| `propertyId` | string (uuid) | The property id, from `productmetrics whoami` or [`properties.list`](/docs/api/account/properties-list) (`property_id`). |

## Query parameters

| Name         | Type   | Required | Description                                                                     |
| ------------ | ------ | -------- | ------------------------------------------------------------------------------- |
| `feed_scope` | string | No       | Which feed of the property: a feed id, or `all` for the property-wide settings. |

## Errors

A failure answers with its HTTP status and `{ error: { code, message, details? }, request_id }`. Branch on `code` (stable, lower_snake); show `message` to the person. The CLI prints the same `error` with `"ok": false`.

```json
{
  "error": {
    "code": "insufficient_scope",
    "message": "This operation needs the read scope; connect again and allow it.",
    "details": {
      "required_scope": "read"
    }
  },
  "request_id": "req_01JP8FMH10ECZW9JB29XGR6PMD"
}
```

| Status | Code                    | When                                                                                                                      |
| ------ | ----------------------- | ------------------------------------------------------------------------------------------------------------------------- |
| 400    | `invalid_request`       | A path, query or body value does not match this page. `details.issues` lists each `location`, `path` and `message`.       |
| 401    | `invalid_token`         | The token is missing, expired or revoked: sign in again (`productmetrics login`). The `WWW-Authenticate` header says why. |
| 402    | `subscription_required` | Needs Pro: without it the call answers 402 subscription_required.                                                         |
| 403    | `insufficient_scope`    | The token lacks the `read` scope (`details.required_scope`): sign in again and allow it.                                  |
| 404    | `not_found`             | An id in the path does not exist, or the signed-in person cannot open it.                                                 |
| 429    | `rate_limited`          | More than 600 requests a minute for this person: wait the `Retry-After` seconds (60) and retry.                           |

[All Store data and insights operations](/docs/api/store-data)
