API
API overview
The ShopAssist merchant REST API for conversations, leads, analytics, knowledge, catalog push, order reports and privacy requests.
The merchant API lets your servers read conversations, leads and analytics, push catalog data, report orders and handle privacy requests.
https://api.shopassist.coec.dk/v1- JSON in and out (
Content-Type: application/json),snake_casefields, timestamps in RFC 3339 UTC. - Authentication with an API key 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
curl https://api.shopassist.coec.dk/v1/stores \
-H "Authorization: Bearer $SHOPASSIST_API_KEY"Plan access
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.
Next
- Authentication and scopes
- Errors, pagination, idempotency, rate limits
- API reference
- Webhooks for push notifications
Last updated on