List shops
The shops (connected stores) behind the property, each with its productSpineStoreId, platform and name.
GET /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). Set $PROPERTY_ID first.
productmetrics store list-shops --property-id $PROPERTY_ID --jsonResponse
API response (200):
{
"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 (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.
{
"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. |