Skip to main content

​
Welcome to the Komerza API

The Komerza API is a comprehensive REST interface that allows you to build custom integrations, applications, and tools on top of the Komerza e-commerce platform. Whether you’re building a mobile app, integrating with third-party services, or creating custom business workflows, our API provides everything you need to access and manage your store data.

Generate API Keys

Create and manage your API keys with custom scopes

​
Base URL

All API requests should be made to: 
https://api.komerza.com

​
Key Features

Our API is designed with modern REST principles and includes:

Complete Store Management

Manage stores, products, variants, pricing, and inventory

Order Processing

Handle orders, payments, refunds, and delivery tracking

Customer Management

Manage customer profiles, authentication, and store credit

Marketing Tools

Coupons, affiliate programs, and customer reviews

Analytics & Insights

Store analytics, visitor tracking, and conversion metrics

Customization

Custom fields, domains, branding, and webhooks

​
Authentication

All API endpoints require authentication using Bearer tokens. Include your API key in the Authorization header: 
curl -H "Authorization: Bearer YOUR_API_KEY" \
  -H "User-Agent: MyApp/1.0" \
  https://api.komerza.com/stores/{storeId}
Required: All API requests must include a User-Agent header or they will be blocked. Make sure to identify your application with a descriptive User-Agent string.
API keys can be generated from your Komerza Dashboard. Each key has specific scopes that determine which endpoints and operations are accessible.

View All API Scopes

Complete reference for all available permission scopes

​
Rate Limiting

The API implements token bucket rate limiting to ensure fair usage and system stability:

​
Anonymous Users (No API Key)

  • Token Limit: 10 tokens
  • Replenishment: 4 tokens every 7 seconds
  • Auto-replenishment: Enabled

​
Authenticated Users (With API Key)

  • Token Limit: 12 tokens
  • Replenishment: 4 tokens every 2 seconds
  • Auto-replenishment: Enabled
Each API request consumes one token. When your token bucket is empty, requests will be rate limited until tokens are replenished.

​
Response Format

All API responses follow a consistent JSON structure based on our strongly-typed response models:

​
Standard Response

For single object operations (create, update, get): 
{
  "success": true,
  "message": "Operation completed successfully",
  "code": null,
  "data": {
    // Response data object here
  }
}

​
Paginated Response

For list operations that return multiple items: 
{
  "success": true,
  "pages": 5,
  "data": [
    // Array of data objects here
  ]
}

​
Error Response

When operations fail, detailed error information is provided: 
{
  "success": false,
  "message": "Operation failed",
  "code": "VALIDATION_ERROR",
  "data": null
}

​
Validation Error Response

For validation failures, field-specific errors are included: 
{
  "success": false,
  "message": "Validation failed",
  "code": "VALIDATION_ERROR", 
  "data": null,
  "invalidFields": [
    "(Username) Must be between 3 and 32 characters",
    "(Email) Must be a valid email address"
  ]
}

​
Getting Started

  1. Get API Access - Generate an API key from your dashboard
  2. Choose Your Scope - Select appropriate permissions for your use case
  3. Test Endpoints - Start with the store information endpoint
  4. Build Your Integration - Use our comprehensive endpoint documentation

Quick Start Guide

Follow our step-by-step guide to make your first API call

​
Support & Resources

Help Center

Comprehensive guides and troubleshooting

System Status

Real-time API status and uptime monitoring

Developer Community

Connect with other developers building on Komerza

Support Team

Direct support for technical issues