Skip to main content
GET
/
api
/
v1
/
storefront
/
config
/
resolve
Resolve Shop Config
curl --request GET \
  --url https://api.getscale.ng/api/v1/storefront/config/resolve \
  --header 'X-Shop-API-Key: <x-shop-api-key>'
{
  "status": "success",
  "data": {
    "shopId": "d3b07384-d113-4e4e-9828-4e4e98284e4e",
    "shopName": "Best Shoes",
    "shopLogo": "https://cdn.getscale.ng/logos/shoes.png",
    "shopBanner": "https://cdn.getscale.ng/banners/shoes.png",
    "domain": "myshop.getscale.ng",
    "themeColor": "#22162B",
    "fontFamily": "Inter",
    "templateId": "default",
    "announcementBarText": "Free shipping on orders over ₦5000!",
    "showAnnouncementBar": true,
    "socialLinks": {
      "instagram": "https://instagram.com/bestshoes"
    },
    "checkoutConfig": {
      "guestCheckout": true
    }
  }
}
Resolves a domain name or the active API key origin to retrieve the corresponding shop configuration, dynamic template bindings, custom theme settings, and primary Shop ID. When loading your custom storefront headless frontend (e.g. Next.js, Gatsby, or Vue), you should call this endpoint first. The returned parameters let you dynamically bind theme colors, fonts, checkout variables, and announcement bar settings in real-time.

​
Authorizations

​
X-Shop-API-Key
string
required
Your Publishable Key (pk_live_... or pk_test_...) generated from the Developer settings in your dashboard.

​
Query Parameters

​
domain
string
required
The host name to resolve (e.g. myshop.getscale.ng).
{
  "status": "success",
  "data": {
    "shopId": "d3b07384-d113-4e4e-9828-4e4e98284e4e",
    "shopName": "Best Shoes",
    "shopLogo": "https://cdn.getscale.ng/logos/shoes.png",
    "shopBanner": "https://cdn.getscale.ng/banners/shoes.png",
    "domain": "myshop.getscale.ng",
    "themeColor": "#22162B",
    "fontFamily": "Inter",
    "templateId": "default",
    "announcementBarText": "Free shipping on orders over ₦5000!",
    "showAnnouncementBar": true,
    "socialLinks": {
      "instagram": "https://instagram.com/bestshoes"
    },
    "checkoutConfig": {
      "guestCheckout": true
    }
  }
}