Boxme Levelling API Documentation
Performance & Rating Management System for Boxme warehouse operations.
Boxme Levelling provides a comprehensive API for managing employee performance, violations, recovery training, bonuses, and benefit eligibility across multiple warehouses.
What is Boxme Levelling?
| Module | Description |
|---|---|
| Dashboard | KPI overview, PPH distribution, top performers, pending alerts |
| Employees | Employee directory with status, group, and warehouse assignment |
| PPH Scores | Period-based scoring (monthly/weekly), multi-stage approval workflow |
| Violations | Record, confirm, appeal, and waive violations with penalty points |
| Recovery / Training | Link skill courses to violations; auto-create recovery on confirmation |
| Bonuses | Award bonus points (initiative, certification, attendance, events) |
| Benefits | Calculate benefit eligibility based on PPH level and violation level |
| 13th Month Bonus | Calculate, review, and approve year-end bonuses |
| HR Export | CSV exports for payroll, benefit eligibility, 13th month bonus |
| Reports | Executive summary, PPH performance, violations analysis, weekly, early warning |
| Config | Full system configuration management |
🏪 Seller SOS Module
| Module | Description |
|---|---|
| SOS Scoring | P/O/T/F/I composite scoring engine for seller quality |
| Campaigns | Major/mini campaign management with forecast tracking |
| Appeals | 2-level appeal workflow with score adjustment |
| Webhooks | Real-time event notifications with HMAC-SHA256 |
| Data Sync | Push integration for OMS, WMS, Helpdesk, Accounting |
| Surcharges | Automated surcharges and enforcement (order blocking) |
| AM Portfolio | Account Manager KPI tracking |
Quick Links
- 🚀 Getting Started → — 3 steps to integrate
- 🔐 Authentication → — How to authenticate
- 🔗 API Reference → — Full endpoint documentation (60+ endpoints)
- 📋 Business Logic → — Workflows and rules
- 👥 Roles & Permissions → — Access control matrix
- 🏪 Seller SOS → — Seller Operation Score system
- 🔔 Webhook Integration → — Real-time webhook events
- 🔄 Data Sync Guide → — OMS/WMS/Accounting integration
Tech Stack
| Layer | Technology |
|---|---|
| Runtime | Cloudflare Workers (Edge) |
| Framework | Hono v4.x |
| Database | Supabase (PostgreSQL) |
| Frontend | Vanilla JS + Tailwind CSS + Chart.js |
| Build | Vite + @hono/vite-build |
| Deploy | Wrangler CLI + Cloudflare Pages |
Base URLs
Production: https://boxme-levelling.pages.dev/api
Local Dev: http://localhost:5173/api