Skip to main content

​
Welcome to Twigz Backend API

The Twigz Backend API is a comprehensive platform for building marketplace applications with stores, customers, orders, payments, and more. Built on Convex for real-time functionality and scalability.

​
🚀 What is Twigz?

Twigz is a modern marketplace platform that connects customers with local stores. Our API provides everything you need to build:
  • 🏪 Store Management: Registration, products, inventory, reviews
  • 👥 Customer Experience: Shopping carts, orders, payments, social features
  • 💳 Payment Processing: Stripe integration with marketplace fees
  • 📱 Real-time Features: Live notifications, order tracking
  • 🛡️ Admin Tools: Platform management, payouts, moderation

​
⚡ Key Features

Real-time Everything

Built on Convex for instant updates across all clients

Stripe Marketplace

Complete payment processing with automatic commission handling

FCM/APNs Notifications

Native push notifications without Expo dependency

Advanced Search

Comprehensive search across stores, products, and customers

​
🏗️ Architecture Overview

​
📊 API Statistics

150+
API Functions
8
Core Modules
99.9%
Uptime
< 100ms
Avg Response

​
🎯 Getting Started

1

Authentication Setup

Configure Clerk authentication for your application
2

Install SDK

Install the Convex client in your application
3

Make Your First Call

Test the API with a simple query
4

Explore Features

Dive into stores, products, and customer management

​
💡 Quick Example

Here’s how easy it is to get started: 
import { ConvexReactClient } from "convex/react";
import { api } from "./convex/_generated/api";

const convex = new ConvexReactClient(process.env.NEXT_PUBLIC_CONVEX_URL!);

// Get all stores
const stores = await convex.query(api.customers.explore.getStoresWithPagination, {
  paginationOpts: { numItems: 20, cursor: null }
});

console.log(`Found ${stores.page.length} stores`);

​
🔗 Useful Links

Convex Documentation

Learn more about the Convex platform

Stripe Documentation

Payment processing documentation

GitHub Repository

View the source code and contribute

Community Support

Join our developer community

​
📞 Support

Need help? We’re here for you:
This API is currently in beta. While we maintain high stability, some endpoints may change. We’ll provide migration guides for any breaking changes.
Search Note: Search functionality is available in production deployments. In local preview mode, search may show as “not available” - this is normal and will work when deployed.