# API overview

> The ShopAssist merchant REST API for conversations, leads, analytics, knowledge, catalog push, order reports and privacy requests.

Source: https://shopassist.coec.dk/docs/api · Updated 2026-10-01

The merchant API lets your servers read conversations, leads and analytics, push catalog data, report orders and handle privacy requests.

```text
https://api.shopassist.coec.dk/v1
```

* JSON in and out (`Content-Type: application/json`), `snake_case` fields, timestamps in RFC 3339 UTC.
* Authentication with an [API key](/docs/api/authentication) as a bearer token. Server-to-server only: there is no CORS and no cookie auth, so never call the API from a browser.
* Ids are prefixed, for example `sto_…`, `conv_…`, `lead_…`.
* Every response carries `X-Request-Id`; include it when you contact support.

## Quick example [#example]

```bash
curl https://api.shopassist.coec.dk/v1/stores \
  -H "Authorization: Bearer $SHOPASSIST_API_KEY"
```

## Plan access [#plans]

`stores:read`, `catalog:write`, `orders:report` and `privacy:write` work on every plan. Other scopes need API access on your plan: read scopes from  *(Growth and up)*, write scopes on plans with full API access. See [authentication](/docs/api/authentication#scopes).

## Next [#next]

* [Authentication and scopes](/docs/api/authentication)
* [Errors](/docs/api/errors), [pagination](/docs/api/pagination), [idempotency](/docs/api/idempotency), [rate limits](/docs/api/rate-limits)
* [API reference](/docs/api/reference)
* [Webhooks](/docs/webhooks) for push notifications