Browse documentation
Documentation
Webtools Storefront API
The Webtools Storefront API is a project-scoped HTTP + JSON API for public, customer-facing data: catalogue, blog and content, services, past works, carts, checkout, customer accounts, enquiries and subscriptions. Every resource resolves under a project slug.
Base URL
All endpoints are served from a single base URL. Storefront resources resolve under a project slug.
https://api.webtools.ng/api/v1https://api.webtools.ng/api/v1/storefront/projects/{project_slug}All requests and responses are JSON unless noted (media upload uses multipart form data). Timestamps are ISO 8601. Money is an integer minor-unit amount (for example 2500000 is ₦25,000.00) paired with a currency code.
Quickstart
Create a publishable key in the dashboard under Project settings → API keys, then resolve your project and read its catalogue.
# 1. Resolve the project
curl "https://api.webtools.ng/api/v1/storefront/projects/your-project" \
-H "X-Project-Key: wt_pk_your_key"
# 2. Read the catalogue
curl "https://api.webtools.ng/api/v1/storefront/projects/your-project/products" \
-H "X-Project-Key: wt_pk_your_key"Resource groups
The API exposes 79 endpoints across 18 resource groups. A group only responds when the matching project feature is enabled.
Projects
3Resolve a project by slug or custom domain and read its public configuration — name, default currency, enabled features and branding. Call this first to discover which other resource groups are available.
Catalogue
4Read 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.
Carts
4Create an anonymous cart, add and update line items, and read the current cart with computed totals. Carts are identified by the X-Cart-Token returned when the cart is created.
Shipping
1List the shipping methods a project offers so a shopper can choose one before checkout.
Checkout
1Validate the current cart and create the order and payment records in one call. The response contains the order reference and the resolved line items and totals.
Customers
4Register and log in project-scoped storefront customers, manage their addresses, and read their order history. Customer accounts are per project and are never the same as Webtools dashboard accounts.
Blog & content
11Read published editorial content: posts with pagination and full-text search, categories, tags, authors, featured posts, and the blog landing configuration.
Subscribers
2Let a storefront capture newsletter subscribers and process unsubscribe requests. Submissions are attributed to the project.
Services
3Read a business's published service catalogue — pricing type, deliverables, media and calls to action — and record view or enquiry events against a service.
Past works
3Read a published portfolio of past works or case studies, with galleries and metadata, and record view or click events against an item.
Landing pages
4Read published landing page layouts and the entries that fill them. Each entry is one URL, with SEO, theme colors, and values for that layout's blocks.
Enquiries
1Submit a typed enquiry from a storefront — contact, product enquiry, quote request, service request, support or wholesale. Submissions land in the project's enquiry inbox and can flow into CRM.
Forms
2Read public form metadata and submit freeform JSON payloads to a named form slug. Field keys are owned by your storefront and can change over time; the dashboard renders a dynamic submissions table.
Storefront events
1Record lightweight storefront analytics events — page and resource views, searches and clicks — for the project's insights dashboards.
Files
1Serve a media file by its opaque file key. Used for images and documents referenced by other resources.
Platform
1Service metadata endpoints that are not project-scoped.
Storefront Agent
2Storefront resources.
Storefront Writes
31Storefront resources.
For AI agents
Agents integrate a project with a secret key and a feature-filtered documentation pack — not a raw specification dump. See the AI agent integration guide. A machine-readable OpenAPI document is also available at https://api.webtools.ng/openapi.storefront.json.
Landing pages
Define a block layout once, then publish a URL for each entry with its own SEO and theme colors. See the landing pages guide →
SEO & IndexNow
Publish a product or blog post and Webtools can ping IndexNow (plus an optional storefront revalidate webhook) so new URLs are discovered faster. See the SEO & IndexNow guide →