API Reference

Complete reference for the Cimplify Commerce REST API.

Base URLs

Authentication

Include your API key in every request via the X-API-Key header. Use publishable keys (pk_test_ / pk_live_) for client-side calls and secret keys (sk_test_ / sk_live_) for server-side calls.

curl https://storefront.cimplify.io/api/v1/catalogue/products \
  -H "X-API-Key: pk_test_your_api_key"

Request Format

All request bodies must be JSON with Content-Type: application/json.

Response Format

All responses follow a consistent envelope. Single objects return data as an object; lists return data as an array with meta.pagination.

{
  "success": true,
  "data": { ... },
  "meta": {
    "pagination": {
      "total_count": 100,
      "page_size": 20,
      "current_page": 1
    }
  }
}

Pagination

Filtering

Most list endpoints support query parameter filters. See individual endpoint docs for available filters.

curl "https://storefront.cimplify.io/api/v1/catalogue/products?category=cat_1&featured=true&limit=10"

Rate Limits

Publishable keys: 100 requests/second. Secret keys: 50 requests/second. Rate limit headers are included in every response.

API Sections