Get Active Collections
curl --request GET \
--url https://api.getscale.ng/api/v1/storefront/shop/{shopId}/collections \
--header 'X-Shop-API-Key: <x-shop-api-key>'import requests
url = "https://api.getscale.ng/api/v1/storefront/shop/{shopId}/collections"
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}/collections', 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}/collections",
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}/collections"
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}/collections")
.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}/collections")
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": 5,
"name": "Summer Shoe Guide",
"slug": "summer-shoe-guide",
"description": "Light and breezy shoes for warm weather",
"imageUrl": "https://cdn.getscale.ng/collections/summer.jpg",
"sortOrder": 1
}
]
}
{
"message": "FORM_VALIDATION_ERROR",
"code": 400,
"validationErrors": [
{
"path": [
"shopId"
],
"message": "Invalid UUID format"
}
]
}
Curated Collections
Get Active Collections
GET
/
api
/
v1
/
storefront
/
shop
/
{shopId}
/
collections
Get Active Collections
curl --request GET \
--url https://api.getscale.ng/api/v1/storefront/shop/{shopId}/collections \
--header 'X-Shop-API-Key: <x-shop-api-key>'import requests
url = "https://api.getscale.ng/api/v1/storefront/shop/{shopId}/collections"
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}/collections', 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}/collections",
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}/collections"
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}/collections")
.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}/collections")
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": 5,
"name": "Summer Shoe Guide",
"slug": "summer-shoe-guide",
"description": "Light and breezy shoes for warm weather",
"imageUrl": "https://cdn.getscale.ng/collections/summer.jpg",
"sortOrder": 1
}
]
}
{
"message": "FORM_VALIDATION_ERROR",
"code": 400,
"validationErrors": [
{
"path": [
"shopId"
],
"message": "Invalid UUID format"
}
]
}
Retrieves active curated collections configured by the merchant (e.g. “Summer Clearance”, “New Arrivals”). Collections are groups of items grouped for promotional or display purposes.
Use this endpoint to draw banner sections or special collections on the home page.
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": 5,
"name": "Summer Shoe Guide",
"slug": "summer-shoe-guide",
"description": "Light and breezy shoes for warm weather",
"imageUrl": "https://cdn.getscale.ng/collections/summer.jpg",
"sortOrder": 1
}
]
}
{
"message": "FORM_VALIDATION_ERROR",
"code": 400,
"validationErrors": [
{
"path": [
"shopId"
],
"message": "Invalid UUID format"
}
]
}
⌘I