---
title: "Reads the store's 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 merchant API › site

`GET /v1/stores/{store}/settings`

## Authentication

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

## Path parameters

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

## Code samples

### cURL

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

### TypeScript

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

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

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

print(response.text)
```

## Responses

### 200

Reads the store's settings.

#### Example

```json
{
  "hostnames": [
    "string"
  ],
  "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"
}
```

- `hostnames` (`getSettings.response.200.hostnames`; array<string>, required)
- `locale` (`getSettings.response.200.locale`; string, required)
- `tint` (`getSettings.response.200.tint`; any of, required)
  - any of: `string`, `null`
- `tint_dark` (`getSettings.response.200.tint_dark`; any of, required)
  - any of: `string`, `null`
- `delivery_ttl_seconds` (`getSettings.response.200.delivery_ttl_seconds`; number, required)
- `refund_revokes_access` (`getSettings.response.200.refund_revokes_access`; boolean, required)
- `description` (`getSettings.response.200.description`; any of, required)
  - any of: `string`, `null`
- `time_zone` (`getSettings.response.200.time_zone`; string, required)
- `currency` (`getSettings.response.200.currency`; any of, required)
  - any of: `string`, `null`
- `settings` (`getSettings.response.200.settings`; object, required)
  - `storefront` (`getSettings.response.200.settings.storefront`; object, optional)
    - `external_site` (`getSettings.response.200.settings.storefront.external_site`; string, optional) — The seller's own site, linked from the header.
      - minLength 1; maxLength 2000
    - `socials` (`getSettings.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` (`getSettings.response.200.settings.storefront.theme`; string, optional) — The schemes visitors may pick; absent offers both.
    - `no_index` (`getSettings.response.200.settings.storefront.no_index`; boolean, optional)
    - `powered_by` (`getSettings.response.200.settings.storefront.powered_by`; boolean, optional)
    - `animated_background` (`getSettings.response.200.settings.storefront.animated_background`; boolean, optional) — The dots drifting behind the hero.
    - `header_hidden` (`getSettings.response.200.settings.storefront.header_hidden`; boolean, optional) — Whether the site's header and footer are left off its pages.
    - `footer_hidden` (`getSettings.response.200.settings.storefront.footer_hidden`; boolean, optional)
- `metadata` (`getSettings.response.200.metadata`; map<any of>, required)
- `revision` (`getSettings.response.200.revision`; number, required)
- `updated_at` (`getSettings.response.200.updated_at`; any of, required)
  - any of: `string`, `null`

### 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` (`getSettings.response.default.type`; string, required)
  - format `uri`
- `title` (`getSettings.response.default.title`; string, required)
- `status` (`getSettings.response.default.status`; integer, required)
- `detail` (`getSettings.response.default.detail`; string, required)
- `code` (`getSettings.response.default.code`; string, optional)
- `context` (`getSettings.response.default.context`; object, optional)
- `reached_core` (`getSettings.response.default.reached_core`; boolean, optional)
- `core_answer` (`getSettings.response.default.core_answer`; string, optional)


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