---
title: "Reads the store's own domain, if it has one: where it stands, the DNS records it needs, and whether the store's plan includes a domain."
---

> 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}/domain`

## Authentication

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

## Path parameters

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

## Code samples

### cURL

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

### TypeScript

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

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

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

print(response.text)
```

## Responses

### 200

Reads the store's own domain, if it has one: where it stands, the DNS records it needs, and whether the store's plan includes a domain.

#### Example

```json
{
  "included": true,
  "available": true,
  "target": "string",
  "domain": {
    "id": "string",
    "hostname": "string",
    "status": "string",
    "failure": "string",
    "records": [
      {
        "type": "CNAME",
        "name": "string",
        "value": "string"
      }
    ],
    "verified_at": "string",
    "checked_at": "string",
    "created_at": "string"
  }
}
```

- `included` (`getDomain.response.200.included`; boolean, required)
- `available` (`getDomain.response.200.available`; boolean, required)
- `target` (`getDomain.response.200.target`; any of, required)
  - any of: `string`, `null`
- `domain` (`getDomain.response.200.domain`; any of, required)
  - any of: `object`, `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` (`getDomain.response.default.type`; string, required)
  - format `uri`
- `title` (`getDomain.response.default.title`; string, required)
- `status` (`getDomain.response.default.status`; integer, required)
- `detail` (`getDomain.response.default.detail`; string, required)
- `code` (`getDomain.response.default.code`; string, optional)
- `context` (`getDomain.response.default.context`; object, optional)
- `reached_core` (`getDomain.response.default.reached_core`; boolean, optional)
- `core_answer` (`getDomain.response.default.core_answer`; string, optional)


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