Catalogue

Read the published product catalogue: products and their variants, product categories and collections. Supports search, category and collection filters, price range, brand, product type and featured filters.

Feature requirement: the project must have the commerce feature enabled, or these endpoints return 404.

Prices are integer minor units with a currency code.
Only products with a published status are returned.

GET/api/v1/storefront/projects/{project_slug}/categories

List Categories

Parameters
Name	Type	In	Description
project_slug	string	path	Required.
page	integer	query	Optional. Page number (1-based)
page_size	integer	query	Optional. Number of items per page

Response 200 (list) · StorefrontCategoryRead[]
Field	Type		Description
id	string	required	—
parent_id	string (nullable)	optional	—
name	string	required	—
slug	string	required	—
description	string (nullable)	optional	—
position	integer	required	—
children	StorefrontCategoryRead[]	optional	—

Example request

curl "https://api.webtools.ng/api/v1/storefront/projects/your-project/categories" \
  -H "X-Project-Key: wt_pk_your_key"

GET/api/v1/storefront/projects/{project_slug}/collections

List Collections

Parameters
Name	Type	In	Description
project_slug	string	path	Required.
page	integer	query	Optional. Page number (1-based)
page_size	integer	query	Optional. Number of items per page

Response 200 (list) · StorefrontCollectionRead[]
Field	Type		Description
id	string	required	—
name	string	required	—
slug	string	required	—
description	string (nullable)	optional	—
position	integer	required	—
products	StorefrontProductRead[]	optional	—

Example request

curl "https://api.webtools.ng/api/v1/storefront/projects/your-project/collections" \
  -H "X-Project-Key: wt_pk_your_key"

GET/api/v1/storefront/projects/{project_slug}/products

List Products

Parameters
Name	Type	In	Description
project_slug	string	path	Required.
q	string (nullable)	query	Optional.
category	string (nullable)	query	Optional.
collection	string (nullable)	query	Optional.
product_type	ProductType (nullable)	query	Optional.
brand	string (nullable)	query	Optional.
featured	boolean (nullable)	query	Optional.
min_price_minor	integer (nullable)	query	Optional.
max_price_minor	integer (nullable)	query	Optional.
page	integer	query	Optional. Page number (1-based)
page_size	integer	query	Optional. Number of items per page

Response 200 (list) · StorefrontProductRead[]
Field	Type		Description
id	string	required	—
name	string	required	—
slug	string	required	—
product_type	ProductType	required	—
short_description	string (nullable)	optional	—
description_html	string (nullable)	optional	—
brand	string (nullable)	optional	—
specifications	object	required	—
is_featured	boolean	required	—
variants	StorefrontVariantRead[]	required	—
categories	ProductCategoryAssignmentRead[]	required	—
media	StorefrontMediaRead[]	required	—
seo	SeoRead	required	Nested SEO metadata for API read responses.

Example request

curl "https://api.webtools.ng/api/v1/storefront/projects/your-project/products" \
  -H "X-Project-Key: wt_pk_your_key"

GET/api/v1/storefront/projects/{project_slug}/products/{product_slug}

Get Product

Parameters
Name	Type	In	Description
project_slug	string	path	Required.
product_slug	string	path	Required.

Response 200 · StorefrontProductRead
Field	Type		Description
id	string	required	—
name	string	required	—
slug	string	required	—
product_type	ProductType	required	—
short_description	string (nullable)	optional	—
description_html	string (nullable)	optional	—
brand	string (nullable)	optional	—
specifications	object	required	—
is_featured	boolean	required	—
variants	StorefrontVariantRead[]	required	—
categories	ProductCategoryAssignmentRead[]	required	—
media	StorefrontMediaRead[]	required	—
seo	SeoRead	required	Nested SEO metadata for API read responses.

Example request

curl "https://api.webtools.ng/api/v1/storefront/projects/your-project/products/{product_slug}" \
  -H "X-Project-Key: wt_pk_your_key"

← All resource groups