Overview
The Zochil Platform is an online business management system for merchants. Using Zochil Platform’s products, merchants can create their own e-commerce websites. The platform allows merchants to manage product catalogs, inventory, website content, orders, customers, and storefront settings. Our API is organized around REST principles, uses JSON for request and response bodies, and follows a microservices architecture for scalability and maintainability.What you’ll find here
Quick Start
Get up and running with the Zochil API in minutes
Development Setup
Set up your local development environment
Architecture
Explore our microservices architecture
Authentication
Learn how to authenticate your API requests
Platform Capabilities
The Zochil Platform enables merchants to manage:- Product Catalogs: Products, variants, categories, and brands
- Inventory Management: Stock levels and warehouse operations
- Content Management: Posts, banners, and lookbooks
- Marketing: Promotion campaigns and coupons
- Financial: Bank accounts and payment processing
- Order Management: Order lifecycle and fulfillment
- Customer Management: Customer data and relationships
- Storefront Settings: Website customization and configuration
Architecture
- Multi-tenant Architecture: Support for multiple merchants with isolated data
- Microservices: Domain-specific services (user-api, catalog-api, order-api, etc.)
- Event-driven: Pub/sub messaging with Dapr for real-time updates
- Express.js: RESTful API services built with Express and TypeScript
- Database: PostgreSQL with Knex.js query builder
- Caching: Redis for session management and caching
- Flexible Deployment: Single-service or aggregated deployment modes
Development Workflow
- Bruno API Testing: Comprehensive API specifications and testing in
./spec/folder - TypeScript: Full TypeScript support with strict typing
- Hot Reload: Development server with automatic code reloading
- Database Migrations: Structured database schema management
- Code Style: Consistent coding standards and conventions