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/v1

Request Format

The API accepts and returns JSON. Include the following headers:

Content-Type: application/json
X-API-Key: wk_live_your_key_here

Response 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

ResourceDescriptionEndpoints
ProductsManage your store catalogCRUD + count
OrdersProcess and fulfill ordersRead + Update + count + items
CustomersManage customer recordsCreate + Read + Update + count
CategoriesOrganize productsCRUD
DiscountsCreate promotionsCRUD + validate
WebhooksReceive event notificationsCRUD
StoreRead store informationRead-only

Next Steps

On this page