MCP System Backend

🚀 System API Documentation

This system is designed to streamline various business processes through a set of well - defined APIs. It encompasses multiple core modules that handle user management, partner management, pickup services, order processing, and transaction record management.

🚀 Quick Start

Overview

The system consists of the following core modules:

1. User Management
2. Partner Management
3. Pickup Management
4. Order Processing
5. Transaction Record Management

✨ Features

User Registration and Login

Registration API

• Request Method: POST
• Path: /api/v1/auth/register

Request Parameters:

• name: User's full name
• email: User's email address (must be unique)
• password: User's password
• role: User's role (optional, default is "user")

Login API

• Request Method: POST
• Path: /api/v1/auth/login

Request Parameters:

• email: User's email address
• password: User's password

Partner Management

Create a Partner

• Request Method: POST
• Path: /api/v1/partners

Request Parameters:

• name: Name of the partnership firm
• email: Contact email (must be unique)
• password: Partner's password
• role: Role ("MCP" or "PickupPartner")

Pickup Management

Create a Pickup Task

• Request Method: POST
• Path: /api/v1/pickups

Request Parameters:

• title: Title of the pickup task
• description: Description of the pickup task
• address: Pickup address
• date: Scheduled date and time
• status: Status ("pending", "completed", "failed")
• assignedTo: ID of the person in charge (user or partner)

Order Processing

Create an Order

• Request Method: POST
• Path: /api/v1/orders

Request Parameters:

• orderNumber: Order number
• items: Array of order items, including:
  • product: Product name
  • quantity: Quantity
  • price: Unit price
  • total: Total price
• totalAmount: Total order amount
• shippingAddress: Shipping address
• paymentMethod: Payment method
• status: Status ("pending", "processing", "completed", "cancelled")

Transaction Record Management

Create a Transaction Record

• Request Method: POST
• Path: /api/v1/transactions

Request Parameters:

• type: Type ("deposit", "withdrawal", "transfer")
• amount: Transaction amount
• description: Transaction description
• status: Status ("completed", "failed", "pending")

Authorization Process

1. Registration/Login:

   • Users or partners register or log in via the corresponding endpoints.
   • The server returns a JWT token.

2. Token Usage:

   • Include the token in all protected requests in the following format:

   Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
   

3. Role - Based Access Control:

   • Some endpoints are restricted based on user roles.
   • Supported roles include "MCP" and "PickupPartner".
   • Unauthorized access attempts will be rejected with a 403 error.

🔧 Technical Details

Data Models

User

{
  name: String,         // User's full name
  email: String,        // User's email address (unique)
  password: String,     // Encrypted password
  role: String,         // Authorized role
  status: String,       // 'ACTIVE', 'INACTIVE'
  createdAt: Date,
  updatedAt: Date
}

Partner

{
  name: String,          // Name of the partnership firm
  email: String,         // Contact email (unique)
  password: String,      // Encrypted password
  role: String,          // 'MCP', 'PickupPartner'
  walletBalance: Number, // Current wallet balance
  createdAt: Date,
  updatedAt: Date
}

Pickup

{
  title: String,         // Title of the pickup task
  description: String,   // Description of the pickup task
  address: String,       // Pickup address
  date: Date,            // Scheduled date and time
  status: String,        // 'pending', 'completed', 'failed'
  assignedTo: ObjectId,  // Reference to the person in charge (user/partner)
  createdAt: Date,
  updatedAt: Date
}

Order

{
  orderNumber: String,   // Order number
  items: Array,          // Array of order items, including:
    - product: String   // Product name
    - quantity: Number  // Quantity
    - price: Number     // Unit price
    - total: Number     // Total price
  totalAmount: Number,   // Total order amount
  shippingAddress: String,// Shipping address
  paymentMethod: String,// Payment method
  status: String,        // Status ("pending", "processing", "completed", "cancelled")
  createdAt: Date,
  updatedAt: Date
}

Transaction

{
  type: String,          // Type ("deposit", "withdrawal", "transfer")
  amount: Number,        // Transaction amount
  description: String,   // Transaction description
  status: String,        // Status ("completed", "failed", "pending")
  createdAt: Date,
  updatedAt: Date
}