https://github.com/tanjib-rafi/ecommerce-api
API for core functionalities common to most e-commerce platforms
https://github.com/tanjib-rafi/ecommerce-api
Last synced: 5 months ago
JSON representation
API for core functionalities common to most e-commerce platforms
- Host: GitHub
- URL: https://github.com/tanjib-rafi/ecommerce-api
- Owner: Tanjib-Rafi
- Created: 2024-05-18T08:42:57.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-25T12:42:20.000Z (over 1 year ago)
- Last Synced: 2025-01-04T14:40:26.900Z (about 1 year ago)
- Language: Python
- Size: 72.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Setup instructions
First, clone the repository to your local machine:
```bash
git clone https://github.com/Tanjib-Rafi/Ecommerce-API.git
```
Install the requirements:
```bash
pip install -r requirements.txt
```
Apply the migrations:
```bash
python3 manage.py migrate
```
Finally, run the development server:
```bash
python manage.py runserver
```
The API endpoints will be available at:
http://127.0.0.1:8000/api/
## API Endpoints
### User Endpoints
| Action | HTTP Method | Endpoint |
|-----------------------|-------------|------------------------|
| Register for an account | POST | `/api/users/register/` |
| Login | POST | `/api/users/login/` |
| Logout | POST | `/api/users/logout/` |
### Product Endpoints
| Action | HTTP Method | Endpoint |
|------------------------------|-------------|-------------------------------------|
| List and create products | GET, POST | `/api/products/products/` |
| Retrieve, update, delete product | GET, PUT, DELETE | `/api/products/products//` |
| List and create categories | GET, POST | `/api/products/categories/` |
| Retrieve, update, delete category | GET, PUT, DELETE | `/api/products/categories//` |
| List and create brands | GET, POST | `/api/products/brands/` |
| Retrieve, update, delete brand | GET, PUT, DELETE | `/api/products/brands//` |
| List and create product variations | GET, POST | `/api/products/variations/` |
| Retrieve, update, delete product variation | GET, PUT, DELETE | `/api/products/variations//` |
| List and create reviews | GET, POST | `/api/products/reviews/` |
| Retrieve, update, delete review | GET, PUT, DELETE | `/api/products/reviews//` |
| List and create wishlists | GET, POST | `/api/products/wishlists/` |
| Retrieve, update, delete wishlist | GET, PUT, DELETE | `/api/products/wishlists//` |
### Order Endpoints
| Action | HTTP Method | Endpoint |
|------------------------------|-------------|-------------------------------------|
| List and create orders | GET, POST | `/api/orders/orders/` |
| Retrieve, update, delete order | GET, PUT, DELETE | `/api/orders/orders//` |
| List and create order items | GET, POST | `/api/orders/order-items/` |
| Retrieve, update, delete order item | GET, PUT, DELETE | `/api/orders/order-items//` |
| List and create carts | GET, POST | `/api/orders/carts/` |
| Retrieve, update, delete cart | GET, PUT, DELETE | `/api/orders/carts//` |
| List and create coupons | GET, POST | `/api/orders/coupons/` |
| Retrieve, update, delete coupon | GET, PUT, DELETE | `/api/orders/coupons//` |
### Payment Endpoints
| Action | HTTP Method | Endpoint |
|------------------------------|-------------|-------------------------------------|
| List and create payments | GET, POST | `/api/payments/payments/` |
| Retrieve, update, delete payment | GET, PUT, DELETE | `/api/payments/payments//` |
### Address Endpoints
| Action | HTTP Method | Endpoint |
|------------------------------|-------------|-------------------------------------|
| List and create addresses | GET, POST | `/api/addresses/addresses/` |
| Retrieve, update, delete address | GET, PUT, DELETE | `/api/addresses/addresses//` |
### Admin Endpoint
| Action | HTTP Method | Endpoint |
|--------------|-------------|-------------|
| Admin panel | GET | `/admin/` |
## Example Usage
To register for an account, send a POST request to:
```http
POST /api/users/register/
```JSON
{
}
```