https://github.com/sandeep5521/martdb-api
MartDB is a REST API that provides a database for ecommerce shopping products. It allows you to create, read, update and delete products from your online store. MartDB is designed to be used in conjunction with an ecommerce website or mobile app, and provides a simple manage product data.
https://github.com/sandeep5521/martdb-api
api ecommerce expressjs hbs mongodb mongoose nodejs
Last synced: 25 days ago
JSON representation
MartDB is a REST API that provides a database for ecommerce shopping products. It allows you to create, read, update and delete products from your online store. MartDB is designed to be used in conjunction with an ecommerce website or mobile app, and provides a simple manage product data.
- Host: GitHub
- URL: https://github.com/sandeep5521/martdb-api
- Owner: Sandeep5521
- Created: 2023-04-15T13:28:27.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-05-27T14:17:30.000Z (over 2 years ago)
- Last Synced: 2025-07-01T03:49:54.277Z (3 months ago)
- Topics: api, ecommerce, expressjs, hbs, mongodb, mongoose, nodejs
- Language: JavaScript
- Homepage: https://martdb.onrender.com/
- Size: 45.9 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# MartDB-API
Welcome to the MartDB eCommerce Shopping Products API! Our API provides free access to a wide range of products from various categories, allowing you to retrieve detailed information about each product, including its name, description, price, images, reviews, and more.
Our API is currently deployed on Render and can be accessed through the following URL: https://martdb.onrender.com/. It is also being used by our eCommerce website, IndiMart, which is also deployed on Render and can be accessed through the following URL: https://indimart.onrender.com/.
To use our API, simply make HTTP requests to our endpoints, passing the necessary parameters to retrieve the desired information. Our API supports various HTTP methods, including GET, POST, PUT, and DELETE, allowing you to perform various operations on our product database.
## API Reference
#### Get all products
```
GET /products
```
| Parameter | Type | Description |
| :-------- | :------- | :-------------------------------- |
| `page` | `number` | **Optional**. Page number of products to fetch
| `limit` | `number` | **Optional**. Page limit of products to fetch |
#### Get product by id
```
GET /products?id={id}
```
| Parameter | Type | Description |
| :-------- | :------- | :-------------------------------- |
| `id` | `string` | **Required**. _Id of product to fetch |
#### Get products by Category
```
GET /products?cat=mobiles
```
| Parameter | Type | Description |
| :-------- | :------- | :-------------------------------- |
| `cat` | `string` | **Required**. category of product to fetch |
| `page` | `number` | **Optional**. Page number of products to fetch
| `limit` | `number` | **Optional**. Page limit of products to fetch |
#### Get product by Name
```
GET /products?name={title}
```
| Parameter | Type | Description |
| :-------- | :------- | :-------------------------------- |
| `name` | `string` | **Required**. title of product to fetch |
#### Get All Categories
```
GET /category
```
#### Get Products by Search
```
GET /search?q={query}
```
| Parameter | Type | Description |
| :-------- | :------- | :-------------------------------- |
| `q` | `string` | **Required**. Search query for fetching the products |
#### Get Autocomplete text by Search
```
GET /search?a={text}
```
| Parameter | Type | Description |
| :-------- | :------- | :-------------------------------- |
| `a` | `string` | **Required**. text for fetching the autocomplete text |
#### Get Single Random Product
```
GET /random
```
| Parameter | Type | Description |
| :-------- | :------- | :-------------------------------- |
| `limit` | `number` | **Optional**. limit of random products to fetch |
#### Post Single Product
```
POST /products
```
```
{
"title": "AVANT Men's Grey/Black Running Shoes - 8 UK",
"description": "MAXIMUM COMFORT: From rigorous running to high intensity training this shoe has got you covered. It has a soft cushioning to give the feet maximum comfort.The design ensures full comfort with spacious yet secure fit. It is lightweight and breathable with high density backing. The engineered backing across the vamp & collar provides stretch & comfort where needed",
"thumbnail": "https://m.media-amazon.com/images/I/61xJ6SfB-eL._SY450_.jpg",
"price": 1599,
"discountPrice": 649,
"brand": "AVANT",
"category": "mens-shoes",
"images": [
"https://m.media-amazon.com/images/I/61xJ6SfB-eL._SY450_.jpg",
"https://m.media-amazon.com/images/I/51jXZccor9L._SY450_.jpg",
"https://m.media-amazon.com/images/I/61Ya9D4xdGL._SY450_.jpg",
"https://m.media-amazon.com/images/I/617OZ-jgYlL._SY450_.jpg",
"https://m.media-amazon.com/images/I/51bjbbhBPxL._SY450_.jpg"
]
}
```
To access our API, you don't need to sign up for an API key. Our API documentation provides detailed instructions on how to make requests, as well as examples of the JSON responses you can expect to receive.
We hope you find our MartDB eCommerce Shopping Products API useful! If you have any questions or encounter any issues, please don't hesitate to contact us through our website or email.