Bot Ban Hang — Developer Docs
Technical documentation for developers of the Bot Ban Hang platform — a sales management, payment, and order operations system for Vietnamese merchants.
About the project
Bot Ban Hang is the central hub for coordinating and storing all sales activities of businesses (Merchants). The system supports multi-channel data synchronization (from e-commerce platforms, Facebook, POS) and provides services to optimize operations, inventory management, and payments.
The documentation is structured in a modular format, helping developers easily integrate and build additional satellite applications for the Merchant Apps ecosystem.
System overview
| Service | Description | Tech Stack |
|---|---|---|
| api_oms | Order management — products, inventory, shipping, billing, loyalty | NestJS · Prisma · PostgreSQL |
| api_payment | Multi-platform payment gateway | NestJS |
| web_payment | Customer-facing payment UI | Next.js · React |
Getting started
- System architecture — Architecture overview and how services connect
- Environment setup — Install and run the project locally
- Code conventions — Coding standards and team workflow
API Modules
Order Management (api_oms)
- Product Management — CRUD products, sync variants, pricing, bulk import
- Addon Management — Addons and addon groups for products/orders
- Billing Management — Purchase orders and billing status
- Category Management — Setup and update categories
- Integration Management — Configuration, authorization, and platform sync
- Inventory Management — Stock in/out history, quantity sync
- Inventory Auditing — Stock audit history
- Label Management — Data classification labels
- Locations — Province, district, ward lookup
- Loyalty — Loyalty membership tiers
- Order Management — Create, update, statistics, export, payment
- Package Management — Service packages
- Partner Webhook — Register webhooks for partners
- Payment — Update and send payment events
- Public API — API for selling pages, embedded apps
- Report — Summary reports
- Settings — System settings
- Shipping — Shipping accounts, services, fees, delivery orders
- Tracking — Order shipment tracking
- Variant — Product variants
- Vendor — Supplier management
- Webhook — Webhooks from shipping carriers and integration platforms
Payment Gateway (api_payment)
- Payment overview — Multi-platform payment gateway