---
title: "Reads the store: its name, branding and settings."
---

> 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 customer API › store

`GET /v1/stores/{store}`

## Authentication

Requires one of the following:

- `bearer`, http, header `Authorization`
- `publishableKey`, apiKey, in header, header `Publishable-Key`

## Path parameters

- `store` (`getStore.path.store`; string, required) — A hostname of the store.

## Query parameters

- `preview` (`getStore.query.preview`; string, optional)
  - minLength 1; maxLength 128

## Code samples

### cURL

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

### TypeScript

```typescript
const url = 'https://api.sherpo.io/customer/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/customer/v1/stores/<store>"

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

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

print(response.text)
```

## Responses

### 200

Reads the store: its name, branding and settings.

#### Example

```json
{
  "id": "string",
  "name": "string",
  "locale": "string",
  "currency": "string",
  "hostname": "string",
  "served_hostname": "string",
  "served_hostnames": [
    "string"
  ],
  "unlocks_paused": true,
  "mcp_endpoint": "string",
  "description": "string",
  "tint": "string",
  "tint_dark": "string",
  "favicon": "string",
  "apple_touch_icon": "string",
  "icon_96": "string",
  "icon_192": "string",
  "icon_512": "string",
  "icon": "string",
  "placeholder_icon": "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
    }
  },
  "body": {
    "tracks": [
      {
        "id": "string",
        "label": "string",
        "language": "string",
        "generated": true
      }
    ],
    "outputs": [
      "string"
    ],
    "access": "string",
    "id": "string",
    "role": "string",
    "delivery": "string",
    "preview_only": true,
    "from_body": true,
    "position": 0,
    "asset": {
      "id": "string",
      "name": "string",
      "title": "string",
      "ext": "string",
      "description": "string",
      "mime": "string",
      "bytes": 0,
      "enforcement": "string",
      "locator": "string",
      "metadata": {
        "width": 0,
        "height": 0,
        "duration": 0,
        "pages": 0
      },
      "status": "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"
        ]
      }
    }
  },
  "maps": [
    {
      "latitude": 0,
      "longitude": 0,
      "light": {
        "url": "string",
        "width": 0,
        "height": 0,
        "resized": [
          {
            "width": 1,
            "avif": "string",
            "webp": "string"
          }
        ]
      },
      "dark": {
        "url": "string",
        "width": 0,
        "height": 0,
        "resized": [
          {
            "width": 1,
            "avif": "string",
            "webp": "string"
          }
        ]
      },
      "attribution": "string",
      "attribution_url": "string"
    }
  ],
  "stylesheet": {
    "tracks": [
      {
        "id": "string",
        "label": "string",
        "language": "string",
        "generated": true
      }
    ],
    "outputs": [
      "string"
    ],
    "access": "string",
    "id": "string",
    "role": "string",
    "delivery": "string",
    "preview_only": true,
    "from_body": true,
    "position": 0,
    "asset": {
      "id": "string",
      "name": "string",
      "title": "string",
      "ext": "string",
      "description": "string",
      "mime": "string",
      "bytes": 0,
      "enforcement": "string",
      "locator": "string",
      "metadata": {
        "width": 0,
        "height": 0,
        "duration": 0,
        "pages": 0
      },
      "status": "string"
    }
  },
  "integrations": [
    {
      "id": "string",
      "name": "string",
      "kind": "string",
      "sets_cookies": true,
      "script": [
        {
          "src": "string",
          "id": "string",
          "defer": true,
          "async": true,
          "inner_html": "string",
          "attributes": {
            "property1": "string",
            "property2": "string"
          }
        }
      ]
    }
  ],
  "cookie_consent": true,
  "categories": [
    {
      "id": "string",
      "label": "string",
      "discountable": true,
      "subscribable": true,
      "reviewable": true,
      "repeatable": true,
      "aside_size": "string"
    }
  ],
  "currencies": {
    "property1": 0,
    "property2": 0
  },
  "updated_at": "string"
}
```

- `id` (`getStore.response.200.id`; string, required)
- `name` (`getStore.response.200.name`; string, required)
- `locale` (`getStore.response.200.locale`; string, required)
- `currency` (`getStore.response.200.currency`; any of, required)
  - any of: `string`, `null`
- `hostname` (`getStore.response.200.hostname`; any of, required)
  - any of: `string`, `null`
- `served_hostname` (`getStore.response.200.served_hostname`; any of, required)
  - any of: `string`, `null`
- `served_hostnames` (`getStore.response.200.served_hostnames`; array<string>, required)
- `unlocks_paused` (`getStore.response.200.unlocks_paused`; boolean, required)
- `mcp_endpoint` (`getStore.response.200.mcp_endpoint`; any of, required)
  - any of: `string`, `null`
- `description` (`getStore.response.200.description`; any of, required)
  - any of: `string`, `null`
- `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`
- `favicon` (`getStore.response.200.favicon`; string, required)
- `apple_touch_icon` (`getStore.response.200.apple_touch_icon`; string, required)
- `icon_96` (`getStore.response.200.icon_96`; any of, required)
  - any of: `string`, `null`
- `icon_192` (`getStore.response.200.icon_192`; string, required)
- `icon_512` (`getStore.response.200.icon_512`; string, required)
- `icon` (`getStore.response.200.icon`; string, required)
- `placeholder_icon` (`getStore.response.200.placeholder_icon`; string, required)
- `settings` (`getStore.response.200.settings`; object, required)
  - `storefront` (`getStore.response.200.settings.storefront`; object, required)
    - `external_site` (`getStore.response.200.settings.storefront.external_site`; any of, required)
      - any of: `string`, `null`
    - `socials` (`getStore.response.200.settings.storefront.socials`; array<string>, required)
    - `theme` (`getStore.response.200.settings.storefront.theme`; string, required)
    - `no_index` (`getStore.response.200.settings.storefront.no_index`; boolean, required)
    - `powered_by` (`getStore.response.200.settings.storefront.powered_by`; boolean, required)
    - `animated_background` (`getStore.response.200.settings.storefront.animated_background`; boolean, required)
    - `header_hidden` (`getStore.response.200.settings.storefront.header_hidden`; boolean, required)
    - `footer_hidden` (`getStore.response.200.settings.storefront.footer_hidden`; boolean, required)
- `body` (`getStore.response.200.body`; any of, required)
  - any of: `object`, `null`
- `files` (`getStore.response.200.files`; map<object>, required)
- `maps` (`getStore.response.200.maps`; array<object>, required) — The maps the body's map blocks show, matched to a block by `latitude` and `longitude`; none while the body is kept from the reader.
  - `latitude` (`getStore.response.200.maps.latitude`; number, required)
  - `longitude` (`getStore.response.200.maps.longitude`; number, required)
  - `light` (`getStore.response.200.maps.light`; object, required) — For a light page.
    - `url` (`getStore.response.200.maps.light.url`; string, required) — A lasting URL to the image.
    - `width` (`getStore.response.200.maps.light.width`; number, required) — Its size in pixels.
    - `height` (`getStore.response.200.maps.light.height`; number, required)
    - `resized` (`getStore.response.200.maps.light.resized`; any of, optional) — Its smaller copies, narrowest first; null until made.
      - any of: `array<object>`, `null`
  - `dark` (`getStore.response.200.maps.dark`; object, required) — For a dark page.
    - `url` (`getStore.response.200.maps.dark.url`; string, required) — A lasting URL to the image.
    - `width` (`getStore.response.200.maps.dark.width`; number, required) — Its size in pixels.
    - `height` (`getStore.response.200.maps.dark.height`; number, required)
    - `resized` (`getStore.response.200.maps.dark.resized`; any of, optional) — Its smaller copies, narrowest first; null until made.
      - any of: `array<object>`, `null`
  - `attribution` (`getStore.response.200.maps.attribution`; string, required) — The credit shown over the map, linking `attribution_url`.
  - `attribution_url` (`getStore.response.200.maps.attribution_url`; string, required)
- `stylesheet` (`getStore.response.200.stylesheet`; any of, required)
  - any of: `object`, `null`
- `integrations` (`getStore.response.200.integrations`; array<object>, required)
  - `id` (`getStore.response.200.integrations.id`; string, required)
  - `name` (`getStore.response.200.integrations.name`; string, required)
  - `kind` (`getStore.response.200.integrations.kind`; string, required)
  - `sets_cookies` (`getStore.response.200.integrations.sets_cookies`; boolean, required)
  - `script` (`getStore.response.200.integrations.script`; array<object>, required)
    - `src` (`getStore.response.200.integrations.script.src`; any of, required)
      - any of: `string`, `null`
    - `id` (`getStore.response.200.integrations.script.id`; any of, required)
      - any of: `string`, `null`
    - `defer` (`getStore.response.200.integrations.script.defer`; boolean, required)
    - `async` (`getStore.response.200.integrations.script.async`; boolean, required)
    - `inner_html` (`getStore.response.200.integrations.script.inner_html`; any of, required)
      - any of: `string`, `null`
    - `attributes` (`getStore.response.200.integrations.script.attributes`; map<string>, required) — Any other string attribute on the tag.
- `cookie_consent` (`getStore.response.200.cookie_consent`; boolean, required)
- `categories` (`getStore.response.200.categories`; array<object>, required)
  - `id` (`getStore.response.200.categories.id`; string, required)
  - `label` (`getStore.response.200.categories.label`; string, required)
  - `discountable` (`getStore.response.200.categories.discountable`; boolean, required)
  - `subscribable` (`getStore.response.200.categories.subscribable`; boolean, required)
  - `reviewable` (`getStore.response.200.categories.reviewable`; boolean, required)
  - `repeatable` (`getStore.response.200.categories.repeatable`; boolean, required) — Bought again and again: a coffee, a donation, an invoice, a seat, a slot.
  - `aside_size` (`getStore.response.200.categories.aside_size`; string, required)
- `currencies` (`getStore.response.200.currencies`; map<number>, required)
- `updated_at` (`getStore.response.200.updated_at`; any of, required)
  - any of: `string`, `null`

### default

A problem; see https://api.sherpo.io/customer/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/customer-api/reference/get-store/index.md
