ifixkart-admin/docs/api/api-design.md
Adithiyan bbd3a3e959 feat: initial commit — full platform snapshot
- Backend: FastAPI app with all models, services, schemas, routes
- Admin Panel: Next.js dashboard with all modules
  (CRM, POS, repairs, warranties, billing, notifications, etc.)
- Ecommerce: storefront (submodule) + product catalog
- AI Agents: .agents/ skill library for Antigravity IDE
- Docs: architecture, billing, notification gateway markdown
- Submodules: Backend/OpenWA, Ecommerce/File 2/storefront
2026-10-13 12:59:47 +05:30

33 lines
1.8 KiB
Markdown

# OpenAPI RESTful Contract Specification
Every domain resides in its own router file under `Backend/app/api/v1/routers/`.
---
## Endpoint Directory
### Customer & Auth
* `CustomerAuthRouter.py`: `POST /api/v1/customer/auth/login`, `POST /api/v1/customer/auth/google`, `POST /api/v1/customer/auth/refresh`
* `CustomerProfileRouter.py`: `GET /api/v1/customer/profile`, `GET /api/v1/customer/addresses`
### Catalog & Discovery
* `CatalogRouter.py`: `GET /api/v1/products`, `GET /api/v1/products/search`, `GET /api/v1/products/filter`
* `WishlistRouter.py`: `GET /api/v1/wishlist`, `POST /api/v1/wishlist/add`, `POST /api/v1/wishlist/remove`
* `ProductCompareRouter.py`: `POST /api/v1/products/compare`
### Commerce & Invoicing
* `CartRouter.py`: `GET /api/v1/cart`, `POST /api/v1/cart/items`, `POST /api/v1/cart/merge`
* `CheckoutRouter.py`: `POST /api/v1/checkout/validate`, `POST /api/v1/checkout/create`
* `OrderRouter.py`: `GET /api/v1/orders`, `GET /api/v1/orders/{id}`, `POST /api/v1/orders/{id}/cancel`
* `PaymentRouter.py`: `POST /api/v1/payment/create`, `POST /api/v1/payment/verify`, `POST /api/v1/payment/webhook`
* `InvoiceRouter.py`: `GET /api/v1/invoices/{id}`, `GET /api/v1/invoices/{id}/pdf`
### POS & Inventory
* `PosSyncRouter.py`: `POST /api/v1/pos/sync`, `GET /api/v1/pos/products`
* `InventoryRouter.py`: `GET /api/v1/inventory/stock`, `POST /api/v1/inventory/adjust`
### System Settings & Dynamic Policies
* `SettingsRouter.py`: `GET /api/v1/settings/delivery` (public), `PUT /api/v1/settings/delivery` (admin)
* `CreditRouter.py`: `GET /api/v1/credits/settings`, `PUT /api/v1/credits/settings`, `GET /api/v1/credits/wallets/{customer_id}`, `POST /api/v1/credits/adjust`, `GET /api/v1/credits/my-wallet`
* `CronRouter.py`: `POST /api/v1/cron/process-credit-maturity`