Skip to content

Get shop and program summary

GET /shop
Scopeshop:read
Customer session tokenAccepted with the read scope, for the token’s own customer
Rate limit classread (limits)
Idempotency keyNot used
MCP toolcharm_get_shop

Returns the shop’s domain, currency, Charm plan and whether the loyalty program is enabled.

Returns Shop.

FieldTypeDescription
domainstringThe shop’s myshopify.com domain.
namestring or null(nullable)
currencystring or nullThe shop’s currency (ISO 4217). (nullable)
planstring or nullCharm plan. (nullable)
program_enabledboolean
program_namestring or null(nullable)
points_namestring or null(nullable)
{
"domain": "your-store.myshopify.com",
"name": "Gold",
"currency": "EUR",
"plan": "growth",
"program_enabled": false,
"program_name": "Rewards Club",
"points_name": "points"
}
Terminal window
curl -X GET "https://charm.appfleece.app/api/v1/shop" \
-H "Authorization: Bearer chrm_live_..."

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.