Skip to main content
GET
/
api
/
v1
/
storefront
/
shop
/
{shopId}
/
products
List Storefront Products
curl --request GET \
  --url https://api.getscale.ng/api/v1/storefront/shop/{shopId}/products \
  --header 'X-Shop-API-Key: <x-shop-api-key>'
{
  "status": "success",
  "data": {
    "products": [
      {
        "id": 1,
        "productName": "Air Max Sneaker",
        "productSlug": "air-max-sneaker",
        "productDescription": "Running athletic shoes",
        "productPrice": 12000,
        "currencySymbol": "₦",
        "media": [
          {
            "mediaUrl": "https://cdn.getscale.ng/products/sneaker1.jpg",
            "mediaType": "image",
            "mediaIndex": 0
          }
        ]
      }
    ],
    "totalCount": 42,
    "limit": 10,
    "offset": 0
  }
}
Retrieves a paginated list of all active products inside the shop catalog. Supports keyword search queries against names/descriptions, category ID filtering, curated collection filtering, and custom sorting options. You can use this endpoint to render search bars, filter sidebars, product grids, and pagination lists on product index pages.

​
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.

​
Query Parameters

​
limit
number
default:"20"
Number of items to return. Must be a positive integer.
​
offset
number
default:"0"
Number of items to skip for paging. Must be non-negative.
​
search
string
A keyword search query to filter products by title or description matching.
​
categoryId
number
Filter products belonging to a specific category ID.
​
collectionId
number
Filter products mapped to a specific curated collection ID.
​
sortBy
string
default:"newest"
Results sorting field. Options: newest, oldest, name, price_low (ascending), price_high (descending).
{
  "status": "success",
  "data": {
    "products": [
      {
        "id": 1,
        "productName": "Air Max Sneaker",
        "productSlug": "air-max-sneaker",
        "productDescription": "Running athletic shoes",
        "productPrice": 12000,
        "currencySymbol": "₦",
        "media": [
          {
            "mediaUrl": "https://cdn.getscale.ng/products/sneaker1.jpg",
            "mediaType": "image",
            "mediaIndex": 0
          }
        ]
      }
    ],
    "totalCount": 42,
    "limit": 10,
    "offset": 0
  }
}