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>'import requests
url = "https://api.getscale.ng/api/v1/storefront/config/resolve"
headers = {"X-Shop-API-Key": "<x-shop-api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Shop-API-Key': '<x-shop-api-key>'}};
fetch('https://api.getscale.ng/api/v1/storefront/config/resolve', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.getscale.ng/api/v1/storefront/config/resolve",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Shop-API-Key: <x-shop-api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.getscale.ng/api/v1/storefront/config/resolve"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Shop-API-Key", "<x-shop-api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.getscale.ng/api/v1/storefront/config/resolve")
.header("X-Shop-API-Key", "<x-shop-api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getscale.ng/api/v1/storefront/config/resolve")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Shop-API-Key"] = '<x-shop-api-key>'
response = http.request(request)
puts response.read_body{
"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
}
}
}
{
"message": "FORM_VALIDATION_ERROR",
"code": 400,
"validationErrors": [
{
"path": [
"domain"
],
"message": "Domain is required when origin headers cannot be resolved"
}
]
}
Shop Identity
Resolve Shop Config
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>'import requests
url = "https://api.getscale.ng/api/v1/storefront/config/resolve"
headers = {"X-Shop-API-Key": "<x-shop-api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Shop-API-Key': '<x-shop-api-key>'}};
fetch('https://api.getscale.ng/api/v1/storefront/config/resolve', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.getscale.ng/api/v1/storefront/config/resolve",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Shop-API-Key: <x-shop-api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.getscale.ng/api/v1/storefront/config/resolve"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Shop-API-Key", "<x-shop-api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.getscale.ng/api/v1/storefront/config/resolve")
.header("X-Shop-API-Key", "<x-shop-api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getscale.ng/api/v1/storefront/config/resolve")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Shop-API-Key"] = '<x-shop-api-key>'
response = http.request(request)
puts response.read_body{
"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
}
}
}
{
"message": "FORM_VALIDATION_ERROR",
"code": 400,
"validationErrors": [
{
"path": [
"domain"
],
"message": "Domain is required when origin headers cannot be resolved"
}
]
}
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
string
required
Your Publishable Key (
pk_live_... or pk_test_...) generated from the Developer settings in your dashboard.Query Parameters
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
}
}
}
{
"message": "FORM_VALIDATION_ERROR",
"code": 400,
"validationErrors": [
{
"path": [
"domain"
],
"message": "Domain is required when origin headers cannot be resolved"
}
]
}
⌘I