Quick Start
Get up and running with the Scale API in under 5 minutes.
API Keys
Learn how to authenticate public and private requests.
Storefront APIs
Expose your products catalog, handle categories, and submit checkouts.
Management APIs
Programmatically create products, sync inventory, and update order statuses.
Headless API Architecture
Scale provides two logical layers of API endpoints to power custom integrations:1. Storefront API (Public)
Designed to run directly in the browser or mobile applications. These endpoints require a Public / Publishable API Key (pk_...) which is safe to expose in client-side code.
- Fetch store profiles & operating hours
- Search and list catalog products/variants
- Fetch categories & collections
- Place orders (checkout submissions)
2. Shop Management API (Private)
Designed to run on backend servers or sync scripts. These endpoints require a Secret API Key (sk_...) which must be kept secret.
- Full inventory sync (Create, Edit, Delete products and variants)
- Order management (Fetch list, Update fulfillment/payment statuses)
- Customer databases & storefront settings management
Developer Support
If you need help or want to report issues with the API:- View the GitHub Repository
- Email us at support@getscale.ng