---
title: "Reads the store: its name, hostname, subdomain, branding and plan."
---

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

Path: Sherpo merchant API › site

`GET /v1/stores/{store}`

## Authentication

- `bearer`, http, header `Authorization`, scopes: `site:read`

## Path parameters

- `store` (`getStore.path.store`; string, required) — The store's id.

## Code samples

### cURL

```bash
curl --request GET \
  --url 'https://api.sherpo.io/merchant/v1/stores/<store>' \
  --header 'Authorization: Bearer <token>'
```

### TypeScript

```typescript
const url = 'https://api.sherpo.io/merchant/v1/stores/<store>';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://api.sherpo.io/merchant/v1/stores/<store>"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

## Responses

### 200

Reads the store: its name, hostname, subdomain, branding and plan.

#### Example

```json
{
  "site": {
    "plan": "string",
    "limits": {
      "pages": 0,
      "menu": 0,
      "internal": 0,
      "external": 0,
      "stylesheet": false,
      "unbranded": false
    },
    "store_limits": {
      "pages": 0,
      "menu": 0,
      "internal": 0,
      "external": 0,
      "stylesheet": true,
      "unbranded": true
    },
    "applies": {
      "pages": 0,
      "menu": 0,
      "internal": 0,
      "external": 0
    },
    "room": {
      "pages": 0,
      "menu": 0,
      "internal": 0,
      "external": 0
    },
    "used": {
      "pages": 0,
      "menu": 0,
      "internal": 0,
      "external": 0
    }
  },
  "plan": {
    "tier": "string",
    "features": {
      "domain": true,
      "learning": true,
      "api": true,
      "self_hosted": true,
      "ai": true
    },
    "marketing_emails": 0,
    "customers": {
      "used": 0,
      "limit": 0,
      "standing": {
        "status": "string",
        "pause_at": null
      }
    },
    "store_marketing_emails": 0,
    "store_customers": {
      "used": 0,
      "limit": 0,
      "standing": {
        "status": "string",
        "pause_at": null
      }
    },
    "standing": {
      "phase": "string",
      "trigger": "string",
      "over": [
        "string"
      ],
      "near": [
        "string"
      ],
      "since": "string",
      "unlocks_pause_at": "string",
      "suspend_at": "string",
      "delete_at": "string",
      "hold_until": "string",
      "upgrade_at": "string"
    }
  },
  "files": {
    "property1": {
      "id": "string",
      "kind": "string",
      "mime": "string",
      "name": "string",
      "bytes": 0,
      "width": 0,
      "height": 0,
      "duration": 0,
      "pages": 0,
      "status": "string",
      "url": "string",
      "resized": [
        {
          "width": 1,
          "avif": "string",
          "webp": "string"
        }
      ],
      "attachment_id": "string",
      "unlocks": [
        {
          "product_id": "string",
          "product_name": "string",
          "tier": {
            "id": "string",
            "name": "string",
            "rank": 0
          }
        }
      ],
      "video": {
        "attachment_id": "string",
        "tracks": [
          {
            "id": "string",
            "label": "string",
            "language": "string",
            "generated": true
          }
        ],
        "outputs": [
          "string"
        ]
      },
      "audio": {
        "waveform": "string",
        "attachment_id": "string",
        "tracks": [
          {
            "id": "string",
            "label": "string",
            "language": "string",
            "generated": true
          }
        ],
        "outputs": [
          "string"
        ]
      }
    },
    "property2": {
      "id": "string",
      "kind": "string",
      "mime": "string",
      "name": "string",
      "bytes": 0,
      "width": 0,
      "height": 0,
      "duration": 0,
      "pages": 0,
      "status": "string",
      "url": "string",
      "resized": [
        {
          "width": 1,
          "avif": "string",
          "webp": "string"
        }
      ],
      "attachment_id": "string",
      "unlocks": [
        {
          "product_id": "string",
          "product_name": "string",
          "tier": {
            "id": "string",
            "name": "string",
            "rank": 0
          }
        }
      ],
      "video": {
        "attachment_id": "string",
        "tracks": [
          {
            "id": "string",
            "label": "string",
            "language": "string",
            "generated": true
          }
        ],
        "outputs": [
          "string"
        ]
      },
      "audio": {
        "waveform": "string",
        "attachment_id": "string",
        "tracks": [
          {
            "id": "string",
            "label": "string",
            "language": "string",
            "generated": true
          }
        ],
        "outputs": [
          "string"
        ]
      }
    }
  },
  "integrations": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "kind": "string",
      "sets_cookies": true,
      "enabled": true,
      "connection_ended_at": "string",
      "config_schema": {
        "property1": true,
        "property2": true
      },
      "secret_set": {
        "property1": true,
        "property2": true
      }
    }
  ],
  "redirects": {
    "items": [
      {
        "id": "string",
        "from_path": "string",
        "to_path": "string",
        "status": 0,
        "enabled": true,
        "live": true,
        "connection_ended_at": "string",
        "created_at": "string"
      }
    ],
    "total": 0
  },
  "notifications": {
    "items": [
      {
        "id": "string",
        "event": "string",
        "target": {
          "kind": "string",
          "id": "string"
        },
        "locale": "string",
        "channel": "string",
        "enabled": true,
        "in_effect": true
      }
    ],
    "total": 0
  },
  "work": {
    "pending": 0,
    "parked": 0
  },
  "locale": "string",
  "tint": "string",
  "tint_dark": "string",
  "delivery_ttl_seconds": 0,
  "refund_revokes_access": true,
  "description": "string",
  "time_zone": "string",
  "currency": "string",
  "settings": {
    "storefront": {
      "external_site": "string",
      "socials": [
        "string"
      ],
      "theme": "string",
      "no_index": true,
      "powered_by": true,
      "animated_background": true,
      "header_hidden": true,
      "footer_hidden": true
    },
    "property1": true,
    "property2": true
  },
  "metadata": {
    "property1": true,
    "property2": true
  },
  "revision": 0,
  "updated_at": "string",
  "id": "string",
  "name": "string",
  "merchant_id": "string",
  "hostname": "string",
  "url": "string",
  "subdomain": "string",
  "hostnames": [
    "string"
  ],
  "swatch": "string",
  "icon": "string"
}
```

- `site` (`getStore.response.200.site`; object, required)
  - `plan` (`getStore.response.200.site.plan`; string, required)
  - `limits` (`getStore.response.200.site.limits`; any of, required) — What the plan alone applies; `store_limits` is the store's own.
    - any of: `object`, `object`, `object`, `object`
  - `store_limits` (`getStore.response.200.site.store_limits`; object, required) — How many of each the store's website applies and what it turns on, staff's raises counted; `room` is what it may hold.
    - `pages` (`getStore.response.200.site.store_limits.pages`; number, required)
    - `menu` (`getStore.response.200.site.store_limits.menu`; number, required)
    - `internal` (`getStore.response.200.site.store_limits.internal`; number, required)
    - `external` (`getStore.response.200.site.store_limits.external`; number, required)
    - `stylesheet` (`getStore.response.200.site.store_limits.stylesheet`; boolean, required)
    - `unbranded` (`getStore.response.200.site.store_limits.unbranded`; boolean, required)
  - `applies` (`getStore.response.200.site.applies`; object, required) — How many of each the store applies now, as its business last told it, else as its limits set.
    - `pages` (`getStore.response.200.site.applies.pages`; number, required)
    - `menu` (`getStore.response.200.site.applies.menu`; number, required)
    - `internal` (`getStore.response.200.site.applies.internal`; number, required)
    - `external` (`getStore.response.200.site.applies.external`; number, required)
  - `room` (`getStore.response.200.site.room`; object, required)
    - `pages` (`getStore.response.200.site.room.pages`; number, required)
    - `menu` (`getStore.response.200.site.room.menu`; number, required)
    - `internal` (`getStore.response.200.site.room.internal`; number, required)
    - `external` (`getStore.response.200.site.room.external`; number, required)
  - `used` (`getStore.response.200.site.used`; object, required)
    - `pages` (`getStore.response.200.site.used.pages`; number, required)
    - `menu` (`getStore.response.200.site.used.menu`; number, required)
    - `internal` (`getStore.response.200.site.used.internal`; number, required)
    - `external` (`getStore.response.200.site.used.external`; number, required)
- `plan` (`getStore.response.200.plan`; object, required)
  - `tier` (`getStore.response.200.plan.tier`; string, required)
  - `features` (`getStore.response.200.plan.features`; object, required)
    - `domain` (`getStore.response.200.plan.features.domain`; boolean, required)
    - `learning` (`getStore.response.200.plan.features.learning`; boolean, required)
    - `api` (`getStore.response.200.plan.features.api`; boolean, required)
    - `self_hosted` (`getStore.response.200.plan.features.self_hosted`; boolean, required)
    - `ai` (`getStore.response.200.plan.features.ai`; boolean, required)
  - `marketing_emails` (`getStore.response.200.plan.marketing_emails`; any of, required) — The plan's own; `store_marketing_emails` is what the store holds.
    - any of: `number`, `number`, `number`
  - `customers` (`getStore.response.200.plan.customers`; any of, required) — Against the plan's own cap; `store_customers` is against the store's.
    - any of: `object`, `null`
  - `store_marketing_emails` (`getStore.response.200.plan.store_marketing_emails`; any of, required) — Marketing emails the store may send a month, staff's raises counted; null is not metered.
    - any of: `number`, `null`
  - `store_customers` (`getStore.response.200.plan.store_customers`; any of, required) — The store's customers against its own cap, staff's raises counted; null without one.
    - any of: `object`, `null`
  - `standing` (`getStore.response.200.plan.standing`; any of, required)
    - any of: `object`, `null`
- `files` (`getStore.response.200.files`; map<object>, required)
- `integrations` (`getStore.response.200.integrations`; array<object>, required)
  - `id` (`getStore.response.200.integrations.id`; string, required)
  - `name` (`getStore.response.200.integrations.name`; string, required)
  - `description` (`getStore.response.200.integrations.description`; any of, required)
    - any of: `string`, `null`
  - `kind` (`getStore.response.200.integrations.kind`; string, required)
  - `sets_cookies` (`getStore.response.200.integrations.sets_cookies`; boolean, required)
  - `enabled` (`getStore.response.200.integrations.enabled`; boolean, required)
  - `connection_ended_at` (`getStore.response.200.integrations.connection_ended_at`; any of, required)
    - any of: `string`, `null`
  - `config_schema` (`getStore.response.200.integrations.config_schema`; map<any of>, required)
  - `secret_set` (`getStore.response.200.integrations.secret_set`; map<boolean>, required)
- `redirects` (`getStore.response.200.redirects`; object, required)
  - `items` (`getStore.response.200.redirects.items`; array<object>, required)
    - `id` (`getStore.response.200.redirects.items.id`; string, required)
    - `from_path` (`getStore.response.200.redirects.items.from_path`; string, required)
    - `to_path` (`getStore.response.200.redirects.items.to_path`; string, required)
    - `status` (`getStore.response.200.redirects.items.status`; number, required)
    - `enabled` (`getStore.response.200.redirects.items.enabled`; boolean, required)
    - `live` (`getStore.response.200.redirects.items.live`; boolean, required) — Resolved: enabled and within the redirects of its kind the plan applies.
    - `connection_ended_at` (`getStore.response.200.redirects.items.connection_ended_at`; any of, required) — When it was turned off because the connection that set it up ended.
      - any of: `string`, `null`
    - `created_at` (`getStore.response.200.redirects.items.created_at`; any of, required)
      - any of: `string`, `null`
  - `total` (`getStore.response.200.redirects.total`; number, required)
- `notifications` (`getStore.response.200.notifications`; object, required)
  - `items` (`getStore.response.200.notifications.items`; array<object>, required)
    - `id` (`getStore.response.200.notifications.items.id`; string, required)
    - `event` (`getStore.response.200.notifications.items.event`; string, required)
    - `target` (`getStore.response.200.notifications.items.target`; any of, required)
      - any of: `object`, `null`
    - `locale` (`getStore.response.200.notifications.items.locale`; string, required)
    - `channel` (`getStore.response.200.notifications.items.channel`; string, required)
    - `enabled` (`getStore.response.200.notifications.items.enabled`; boolean, required)
    - `in_effect` (`getStore.response.200.notifications.items.in_effect`; boolean, required)
  - `total` (`getStore.response.200.notifications.total`; number, required)
- `work` (`getStore.response.200.work`; object, required)
  - `pending` (`getStore.response.200.work.pending`; number, required)
  - `parked` (`getStore.response.200.work.parked`; number, required)
- `locale` (`getStore.response.200.locale`; string, required)
- `tint` (`getStore.response.200.tint`; any of, required)
  - any of: `string`, `null`
- `tint_dark` (`getStore.response.200.tint_dark`; any of, required)
  - any of: `string`, `null`
- `delivery_ttl_seconds` (`getStore.response.200.delivery_ttl_seconds`; number, required)
- `refund_revokes_access` (`getStore.response.200.refund_revokes_access`; boolean, required)
- `description` (`getStore.response.200.description`; any of, required)
  - any of: `string`, `null`
- `time_zone` (`getStore.response.200.time_zone`; string, required)
- `currency` (`getStore.response.200.currency`; any of, required)
  - any of: `string`, `null`
- `settings` (`getStore.response.200.settings`; object, required)
  - `storefront` (`getStore.response.200.settings.storefront`; object, optional)
    - `external_site` (`getStore.response.200.settings.storefront.external_site`; string, optional) — The seller's own site, linked from the header.
      - minLength 1; maxLength 2000
    - `socials` (`getStore.response.200.settings.storefront.socials`; array<string>, optional) — Profile URLs on the networks the footer shows (Instagram, X, YouTube, LinkedIn, TikTok, Twitch, Threads, GitHub, Facebook, Discord, Telegram, Reddit, Bluesky, Slack, and Mastodon on mastodon.social, mastodon.online, fosstodon.org, hachyderm.io, infosec.exchange, techhub.social or a host with a `mastodon` or `mstdn` label), linked from the footer.
      - minLength 1; maxLength 2000
    - `theme` (`getStore.response.200.settings.storefront.theme`; string, optional) — The schemes visitors may pick; absent offers both.
    - `no_index` (`getStore.response.200.settings.storefront.no_index`; boolean, optional)
    - `powered_by` (`getStore.response.200.settings.storefront.powered_by`; boolean, optional)
    - `animated_background` (`getStore.response.200.settings.storefront.animated_background`; boolean, optional) — The dots drifting behind the hero.
    - `header_hidden` (`getStore.response.200.settings.storefront.header_hidden`; boolean, optional) — Whether the site's header and footer are left off its pages.
    - `footer_hidden` (`getStore.response.200.settings.storefront.footer_hidden`; boolean, optional)
- `metadata` (`getStore.response.200.metadata`; map<any of>, required)
- `revision` (`getStore.response.200.revision`; number, required)
- `updated_at` (`getStore.response.200.updated_at`; any of, required)
  - any of: `string`, `null`
- `id` (`getStore.response.200.id`; string, required)
- `name` (`getStore.response.200.name`; string, required)
- `merchant_id` (`getStore.response.200.merchant_id`; string, required)
- `hostname` (`getStore.response.200.hostname`; any of, required)
  - any of: `string`, `null`
- `url` (`getStore.response.200.url`; any of, required) — The store home's absolute URL on its verified hostname, or null before it has one.
  - any of: `string`, `null`
- `subdomain` (`getStore.response.200.subdomain`; any of, required)
  - any of: `string`, `null`
- `hostnames` (`getStore.response.200.hostnames`; array<string>, required)
- `swatch` (`getStore.response.200.swatch`; any of, required)
  - any of: `string`, `null`
- `icon` (`getStore.response.200.icon`; string, required)

### default

A problem; see https://api.sherpo.io/merchant/docs/errors.

#### Example

```json
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "context": {},
  "reached_core": true,
  "core_answer": "string"
}
```

- `type` (`getStore.response.default.type`; string, required)
  - format `uri`
- `title` (`getStore.response.default.title`; string, required)
- `status` (`getStore.response.default.status`; integer, required)
- `detail` (`getStore.response.default.detail`; string, required)
- `code` (`getStore.response.default.code`; string, optional)
- `context` (`getStore.response.default.context`; object, optional)
- `reached_core` (`getStore.response.default.reached_core`; boolean, optional)
- `core_answer` (`getStore.response.default.core_answer`; string, optional)


Source: https://docs.sherpo.io/merchant-api/reference/get-store/index.md
