API Platform Active

Modular Single-Vendor E-Commerce Engine

A high-performance Laravel backend API and Admin CRM featuring secure phone-based customer auth, Spatie role-gated product management, coupon rules, status workflows, and automated courier tracking.

5
System Roles
30+
API Endpoints
100%
Audit Logged
RESTful
JSON Architecture
System Capabilities

Core Features & Backend Architecture

Role-Gated Auth

Integrated Laravel Sanctum API tokens and Spatie Role/Permission gating. Support for 5 core roles (super-admin, admin, staff, seller, customer) with seller-scoped product inventory and profile overrides.

Flexible Product Catalog

Fully structured categories and subcategories, JSON fields mapping product sizes, colors, and key attributes. Supports Draft vs Published flow and automated product rating calculations on approved reviews.

Robust Order Workflows

Complete order placement flow validation. Automatically computes tax calculations (8%), custom coupon validation, and delivery rules ($0 shipping for orders over $50). Auto-restores stock on cancelled orders.

Discount Rules Engine

Admin-configured coupon model supporting percentage-based or fixed value rules. Incorporates custom thresholds (minimum order subtotal), usage capacity limits, and start/expiry date window constraints.

Courier Tracking & Logistics

Integration with Courier companies. Supports assignment of unique tracking codes, status timelines (shipped, out for delivery), delivery type scopes, and dedicated customer-facing tracking views.

Audit Trails & CRM Pages

Tracks all administrative activities (IP address, changed model properties, descriptions). Features rich-text Quill.js dynamic CMS pages (FAQs, Policies) and a modular application-wide settings key-value store.

Developer Experience

Clean API Resources & Documentation

Interactive Previews

Product Catalog Listing

Retrieve active, published products dynamically filtered by category, search queries, and featured flags. Responses are returned in a standard API formatting wrapping JSON structures.

GET /api/v1/products?category=smartphones&sort=latest
Response format (json)
{
  "success": true,
  "message": "Products retrieved successfully",
  "data": [
    {
      "id": 12,
      "name": "ECOM Phone X",
      "slug": "ecom-phone-x",
      "price": 799.00,
      "stock_quantity": 45,
      "colors": ["Graphite", "Silver"],
      "rating_avg": 4.8
    }
  ]
}

Customer Registration

Register a new user inside the e-commerce client space. The endpoint requires name, phone number, and password, returning an active token for API requests.

POST /api/v1/auth/register
Post Payload & Response
// Payload: { name: "John", phone: "01700000000", password: "secret" }
{
  "success": true,
  "message": "User registered successfully",
  "data": {
    "token": "7|s6qK54qM93i7G...",
    "user": {
      "name": "John Doe",
      "phone": "01700000000",
      "role": "customer"
    }
  }
}

Submit Checkout Order

Create client orders while running real-time inventory validation, tax calculations (8%), and validating discount coupon limits.

POST /api/v1/orders
Response format (json)
{
  "success": true,
  "message": "Order placed successfully",
  "data": {
    "order_number": "ORD-20260701-99",
    "status": "pending",
    "subtotal": 100.00,
    "discount": 10.00, // coupon applied
    "tax": 7.20,
    "shipping": 0.00, // Free shipping over $50
    "total": 97.20
  }
}

Audit Activity Trail

For accountability, all write transactions inside the administrative panels are automatically catalogued inside the system logs, recording details like IP and metadata changes.

GET /api/v1/admin/activity-logs
Response format (json)
{
  "success": true,
  "data": [
    {
      "action": "order.updated",
      "description": "Order status updated from paid to processing",
      "user_id": 2, // Staff Admin
      "ip_address": "127.0.0.1",
      "properties": { "previous": "paid", "current": "processing" }
    }
  ]
}
Roadmap Tracker

Milestones & Upcoming Features

Phase 1 (Completed)

Auth, Products, & Checkout Engine

Implemented initial database migrations, Sanctum client tokens, categories structure, core product attributes, basic order checkouts, and shipping logic.

Phase 2 (Completed)

Coupons, Reviews, & Logs

Added active discount coupon support during checkout, review/rating features with moderator approvals, global image upload APIs, and system-wide administrative activity logging.

Phase 3 (Active)

Payment Gateways & bKash/Nagad

Designing payments layout and checkout gateway connectors for local mobile payment platforms (bKash, Nagad) alongside primary Cash on Delivery support.

Phase 4 (Planned)

Algolia Search & Async Queues

Configuring Meilisearch/Algolia for instantaneous search indexing and implementing Redis queue workers to run async mailing tasks in the background.