E-Commerce API Documentation

This is a comprehensive e-commerce API built with Django REST Framework that supports multi-tenant architecture, allowing both individual sellers and store owners to manage their products and orders.

Table of Contents

• Setup
• Authentication
• API Modules
• Environment Variables

Setup

1. Clone the repository
2. Create a virtual environment:

python -m venv env
source env/bin/activate  # On Windows: env\Scripts\activate

3. Install dependencies:

pip install -r requirements.txt

4. Set up environment variables (see Environment Variables section)

5. Run migrations:

python manage.py migrate

6. Start the development server:

python manage.py runserver

Authentication

The API uses JWT (JSON Web Tokens) for authentication. Include the token in the Authorization header:

Authorization: Bearer <your_token>

API Modules

• User API - User management, authentication, and profiles
• Product API - Product management, categories, and variants
• Cart API - Shopping cart operations
• Order API - Order management and tracking
• Website API - Multi-tenant website management
• Tracking API - Analytics and visit tracking

Environment Variables

Create a .env file in the root directory with the following variables:

SECRET_KEY=your_secret_key
DEBUG=True

# AWS S3 Configuration
AWS_ACCESS_KEY_ID=your_aws_access_key
AWS_SECRET_ACCESS_KEY=your_aws_secret_key
AWS_STORAGE_BUCKET_NAME=your_bucket_name
AWS_S3_REGION_NAME=your_region

# Database Configuration
PGDATABASE=your_db_name
PGUSER=your_db_user
PGPASSWORD=your_db_password
PGHOST=your_db_host
PGPORT=your_db_port

User Types

The API supports different user types with varying permissions:

• ADMIN - Full system access
• CUSTOMER - Can browse products, make orders
• VENDOR - Can manage products and fulfill orders
• INDIVIDUAL-SELLER - Can sell products individually
• STORE-OWNER - Can manage a full store with multiple products

Error Handling

All API endpoints return responses in the following format:

{
    "type": "success|error",
    "message": "Description of the result",
    "data": {} // Optional data object
}