What is the Whatalo API
An overview of the Whatalo REST API and what you can build with it.
Overview
The Whatalo API is a RESTful API that lets you programmatically manage stores on the Whatalo platform. Build integrations, automate workflows, and extend store functionality.
What You Can Build
- Order management systems — sync orders with fulfillment, shipping, or accounting software
- Product catalog tools — bulk import/export, price synchronization, inventory management
- Customer engagement — CRM integrations, loyalty programs, marketing automation
- Custom storefronts — headless commerce using the API as your backend
- Analytics dashboards — aggregate store data for business intelligence
Base URL
All API requests are made to:
https://api.whatalo.com/v1Request Format
The API accepts and returns JSON. Include the following headers:
Content-Type: application/json
X-API-Key: wk_live_your_key_hereResponse Format
All responses follow a consistent structure:
Success (list):
{
"data": [...],
"pagination": {
"page": 1,
"per_page": 25,
"total": 142,
"total_pages": 6
}
}Success (single resource):
{
"data": { ... }
}Error:
{
"error": {
"code": "VALIDATION_ERROR",
"message": "Description of what went wrong",
"details": [...]
}
}Available Resources
| Resource | Description | Endpoints |
|---|---|---|
| Products | Manage your store catalog | CRUD + count |
| Orders | Process and fulfill orders | Read + Update + count + items |
| Customers | Manage customer records | Create + Read + Update + count |
| Categories | Organize products | CRUD |
| Discounts | Create promotions | CRUD + validate |
| Webhooks | Receive event notifications | CRUD |
| Store | Read store information | Read-only |
Next Steps
- Quick Start — make your first API call in 5 minutes
- Authentication — API keys, scopes, and security
- API Reference — complete endpoint documentation