Get shop and program summary
GET /shop| Scope | shop:read |
| Customer session token | Accepted with the read scope, for the token’s own customer |
| Rate limit class | read (limits) |
| Idempotency key | Not used |
| MCP tool | charm_get_shop |
Returns the shop’s domain, currency, Charm plan and whether the loyalty program is enabled.
Response 200
Section titled “Response 200”Returns Shop.
| Field | Type | Description |
|---|---|---|
domain | string | The shop’s myshopify.com domain. |
name | string or null | (nullable) |
currency | string or null | The shop’s currency (ISO 4217). (nullable) |
plan | string or null | Charm plan. (nullable) |
program_enabled | boolean | |
program_name | string or null | (nullable) |
points_name | string or null | (nullable) |
{ "domain": "your-store.myshopify.com", "name": "Gold", "currency": "EUR", "plan": "growth", "program_enabled": false, "program_name": "Rewards Club", "points_name": "points"}Example
Section titled “Example”curl -X GET "https://charm.appfleece.app/api/v1/shop" \ -H "Authorization: Bearer chrm_live_..."Errors
Section titled “Errors”unauthorized · invalid_token · token_expired · insufficient_scope · access_required · validation_error · rate_limited
Every error body carries code, message, request_id and a doc_url pointing at the matching entry in the error catalog.