Get Shop Details
curl --request GET \
--url https://api.getscale.ng/api/v1/storefront/shop/{shopId} \
--header 'X-Shop-API-Key: <x-shop-api-key>'import requests
url = "https://api.getscale.ng/api/v1/storefront/shop/{shopId}"
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/shop/{shopId}', 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/shop/{shopId}",
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/shop/{shopId}"
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/shop/{shopId}")
.header("X-Shop-API-Key", "<x-shop-api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getscale.ng/api/v1/storefront/shop/{shopId}")
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": {
"id": "d3b07384-d113-4e4e-9828-4e4e98284e4e",
"name": "Best Shoes",
"description": "Premium footwear for everyone",
"shopAddress": "123 Lagos St, Lagos",
"shopLogo": "https://cdn.getscale.ng/logos/shoes.png",
"shopBanner": "https://cdn.getscale.ng/banners/shoes.png",
"themeColor": "#FF5733",
"fontFamily": "Inter",
"templateId": "default",
"announcementBarText": "Free shipping on orders over ₦5000!",
"showAnnouncementBar": true,
"socialLinks": {},
"operatingHours": [
{
"dayOfWeek": 1,
"isOpen": true,
"openTime": "09:00",
"closeTime": "17:00"
}
],
"contacts": [
{
"contactChannel": "whatsapp",
"contactValue": "+2348012345678"
}
]
}
}
{
"message": "FORM_VALIDATION_ERROR",
"code": 400,
"validationErrors": [
{
"path": [
"shopId"
],
"message": "Invalid UUID format"
}
]
}
Shop Identity
Get Shop Details
GET
/
api
/
v1
/
storefront
/
shop
/
{shopId}
Get Shop Details
curl --request GET \
--url https://api.getscale.ng/api/v1/storefront/shop/{shopId} \
--header 'X-Shop-API-Key: <x-shop-api-key>'import requests
url = "https://api.getscale.ng/api/v1/storefront/shop/{shopId}"
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/shop/{shopId}', 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/shop/{shopId}",
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/shop/{shopId}"
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/shop/{shopId}")
.header("X-Shop-API-Key", "<x-shop-api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getscale.ng/api/v1/storefront/shop/{shopId}")
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": {
"id": "d3b07384-d113-4e4e-9828-4e4e98284e4e",
"name": "Best Shoes",
"description": "Premium footwear for everyone",
"shopAddress": "123 Lagos St, Lagos",
"shopLogo": "https://cdn.getscale.ng/logos/shoes.png",
"shopBanner": "https://cdn.getscale.ng/banners/shoes.png",
"themeColor": "#FF5733",
"fontFamily": "Inter",
"templateId": "default",
"announcementBarText": "Free shipping on orders over ₦5000!",
"showAnnouncementBar": true,
"socialLinks": {},
"operatingHours": [
{
"dayOfWeek": 1,
"isOpen": true,
"openTime": "09:00",
"closeTime": "17:00"
}
],
"contacts": [
{
"contactChannel": "whatsapp",
"contactValue": "+2348012345678"
}
]
}
}
{
"message": "FORM_VALIDATION_ERROR",
"code": 400,
"validationErrors": [
{
"path": [
"shopId"
],
"message": "Invalid UUID format"
}
]
}
Fetches the complete profile details for a shop, including active contact phone numbers, social media channels, support emails, physical addresses, and opening/closing hours.
Use this endpoint to construct contact sections, customer support forms, operating hours lists, and store location badges in your storefront application.
Authorizations
string
required
Your Publishable Key (
pk_live_... or pk_test_...) generated from the Developer settings in your dashboard.Path Parameters
string
required
The unique UUID of the shop.
{
"status": "success",
"data": {
"id": "d3b07384-d113-4e4e-9828-4e4e98284e4e",
"name": "Best Shoes",
"description": "Premium footwear for everyone",
"shopAddress": "123 Lagos St, Lagos",
"shopLogo": "https://cdn.getscale.ng/logos/shoes.png",
"shopBanner": "https://cdn.getscale.ng/banners/shoes.png",
"themeColor": "#FF5733",
"fontFamily": "Inter",
"templateId": "default",
"announcementBarText": "Free shipping on orders over ₦5000!",
"showAnnouncementBar": true,
"socialLinks": {},
"operatingHours": [
{
"dayOfWeek": 1,
"isOpen": true,
"openTime": "09:00",
"closeTime": "17:00"
}
],
"contacts": [
{
"contactChannel": "whatsapp",
"contactValue": "+2348012345678"
}
]
}
}
{
"message": "FORM_VALIDATION_ERROR",
"code": 400,
"validationErrors": [
{
"path": [
"shopId"
],
"message": "Invalid UUID format"
}
]
}
⌘I