SimpleStore API Documentation

Complete API documentation and endpoint reference

v1.14.8

Backend API for SimpleStore e-commerce platform

Base URL: http://localhost:3001
🔐 Authentication

Type: JWT Token

Description: Most endpoints require authentication via JWT token

Header: Authorization: Bearer
/healthcheck
GET
Check API health status
Response: Simple text response indicating API is running
/user
GETPOSTPUTDELETE
User management operations
Sub-endpoints:
  • /user/login
  • /user/register
  • /user/profile
  • /user/list
/product
GETPOSTPUTDELETE
Product management operations
Sub-endpoints:
  • /product/list
  • /product/create
  • /product/update
  • /product/delete
  • /product/upload
/client
GETPOSTPUTDELETE
Client management operations
/sales
GETPOSTPUTDELETE
Sales and order management
/company
GETPOSTPUTDELETE
Company management operations
/provider
GETPOSTPUTDELETE
Provider/supplier management
/order-service
GETPOSTPUTDELETE
Order service operations
/media
GETPOSTDELETE
Media file management
/bills-pay
GETPOSTPUTDELETE
Bills and payments management
/payments-methods
GETPOSTPUTDELETE
Payment methods management
/report
GET
Various business reports
/version
GET
API version information and changelog
Sub-endpoints:
  • /version
  • /version/current
  • /version/list
  • /version/:version

⚠️ Error Codes

400
Bad Request - Invalid input data
401
Unauthorized - Authentication required
403
Forbidden - Insufficient permissions
404
Not Found - Resource not found
500
Internal Server Error - Server error