Skip to main content
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>'
{
  "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
    }
  ]
}
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

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

Path Parameters

shopId
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
    }
  ]
}