Public
Documentation Settings
No Environment
Double Column
cURL - cURL
E-commerce microservice
Introduction
Product
Category
Order
Authentication

E-commerce microservice

Product

GETGet all products

http://localhost:3000/api/products
Example Request
Get all products
curl
curl --location 'http://localhost:3000/api/products'
200 OK
Example Response
json
{
  "success": true,
  "message": "Product retrieved successfully",
  "data": [
    {
      "id": 1,
      "name": "Strawberry",
      "categoryId": 1,
      "sku": 2001,
      "availableQuantity": 10,
      "costPrice": 200,
      "sellingPrice": 200,
      "description": "Some stuff",
      "isActive": true,
      "createdAt": "2022-06-29T13:20:34.892Z",
      "updatedAt": "2022-06-29T13:20:34.892Z"
    },
    {
      "id": 2,
      "name": "Coconut",
      "categoryId": 1,
      "sku": 2001,
      "availableQuantity": 10,
      "costPrice": 200,
      "sellingPrice": 200,
      "description": "Some stuff",
      "isActive": true,
      "createdAt": "2022-06-29T13:20:34.892Z",
      "updatedAt": "2022-06-29T13:20:34.892Z"
    },
    {
      "id": 3,
      "name": "Mango",
      "categoryId": 1,
      "sku": 2001,
      "availableQuantity": 10,
      "costPrice": 200,
      "sellingPrice": 200,
      "description": "Some stuff",
      "isActive": true,
      "createdAt": "2022-06-29T13:20:34.892Z",
      "updatedAt": "2022-06-29T13:20:34.892Z"
    },
    {
      "id": 4,
      "name": "Fruit",
      "categoryId": 1,
      "sku": 2001,
      "availableQuantity": 10,
      "costPrice": 200,
      "sellingPrice": 200,
      "description": "Some stuff",
      "isActive": true,
      "createdAt": "2022-06-29T13:20:34.892Z",
      "updatedAt": "2022-06-29T13:20:34.892Z"
    }
  ]
}
X-Powered-By

Express

Content-Type

application/json; charset=utf-8

Content-Length

991

ETag

W/"3df-YzSyioYiCmpa7Jav1MV4BEyzoFo"

Date

Wed, 29 Jun 2022 13:29:57 GMT

Connection

keep-alive

Keep-Alive

timeout=5

GETGet a product

http://localhost:3000/api/products/1
Example Request
Get a product
curl
curl --location 'http://localhost:3000/api/products/1'
200 OK
Example Response
json
{
  "success": true,
  "message": "Product retrieved successfully",
  "data": {
    "id": 1,
    "name": "Strawberry",
    "categoryId": 1,
    "sku": 2001,
    "availableQuantity": 10,
    "costPrice": 200,
    "sellingPrice": 200,
    "description": "Some stuff",
    "isActive": true,
    "createdAt": "2022-06-29T13:20:34.892Z",
    "updatedAt": "2022-06-29T13:20:34.892Z"
  }
}
X-Powered-By

Express

Content-Type

application/json; charset=utf-8

Content-Length

300

ETag

W/"12c-lWCUTBYsVMpeW9t0VxooGtHZzes"

Date

Wed, 29 Jun 2022 13:37:05 GMT

Connection

keep-alive

Keep-Alive

timeout=5

GETGet products by category

http://localhost:3000/api/products/1/products
Example Request
Get products by category
curl
curl --location 'http://localhost:3000/api/products/1/products'
200 OK
Example Response
json
{
  "success": true,
  "message": "Product retrieved successfully",
  "data": [
    {
      "id": 1,
      "name": "Strawberry",
      "categoryId": 1,
      "sku": 2001,
      "availableQuantity": 10,
      "costPrice": 200,
      "sellingPrice": 200,
      "description": "Some stuff",
      "isActive": true,
      "createdAt": "2022-06-29T13:20:34.892Z",
      "updatedAt": "2022-06-29T13:20:34.892Z"
    },
    {
      "id": 2,
      "name": "Coconut",
      "categoryId": 1,
      "sku": 2001,
      "availableQuantity": 10,
      "costPrice": 200,
      "sellingPrice": 200,
      "description": "Some stuff",
      "isActive": true,
      "createdAt": "2022-06-29T13:20:34.892Z",
      "updatedAt": "2022-06-29T13:20:34.892Z"
    },
    {
      "id": 3,
      "name": "Mango",
      "categoryId": 1,
      "sku": 2001,
      "availableQuantity": 10,
      "costPrice": 200,
      "sellingPrice": 200,
      "description": "Some stuff",
      "isActive": true,
      "createdAt": "2022-06-29T13:20:34.892Z",
      "updatedAt": "2022-06-29T13:20:34.892Z"
    },
    {
      "id": 4,
      "name": "Fruit",
      "categoryId": 1,
      "sku": 2001,
      "availableQuantity": 10,
      "costPrice": 200,
      "sellingPrice": 200,
      "description": "Some stuff",
      "isActive": true,
      "createdAt": "2022-06-29T13:20:34.892Z",
      "updatedAt": "2022-06-29T13:20:34.892Z"
    }
  ]
}
X-Powered-By

Express

Content-Type

application/json; charset=utf-8

Content-Length

991

ETag

W/"3df-YzSyioYiCmpa7Jav1MV4BEyzoFo"

Date

Wed, 29 Jun 2022 14:10:21 GMT

Connection

keep-alive

Keep-Alive

timeout=5

Category

GETGet all categories

http://localhost:3000/api/categories
Example Request
Get all categories
curl
curl --location 'http://localhost:3000/api/categories'
200 OK
Example Response
json
{
  "success": true,
  "message": "Category retrieved successfully",
  "data": [
    {
      "id": 1,
      "name": "Cloths",
      "description": "Some stuff",
      "isActive": true,
      "createdAt": "2022-06-29T13:20:34.843Z",
      "updatedAt": "2022-06-29T13:20:34.843Z"
    },
    {
      "id": 2,
      "name": "Fruits",
      "description": "Some stuff",
      "isActive": true,
      "createdAt": "2022-06-29T13:20:34.843Z",
      "updatedAt": "2022-06-29T13:20:34.843Z"
    },
    {
      "id": 3,
      "name": "Food",
      "description": "Some stuff",
      "isActive": true,
      "createdAt": "2022-06-29T13:20:34.843Z",
      "updatedAt": "2022-06-29T13:20:34.843Z"
    }
  ]
}
X-Powered-By

Express

Content-Type

application/json; charset=utf-8

Content-Length

505

ETag

W/"1f9-ZMXW6nObumTfJFSwWSoJIHp+e1k"

Date

Wed, 29 Jun 2022 13:38:41 GMT

Connection

keep-alive

Keep-Alive

timeout=5

GETGet a category

http://localhost:3000/api/categories/1
Example Request
Get a category
curl
curl --location 'http://localhost:3000/api/categories/1'
200 OK
Example Response
json
{
  "success": true,
  "message": "Category retrieved successfully",
  "data": {
    "id": 1,
    "name": "Cloths",
    "description": "Some stuff",
    "isActive": true,
    "createdAt": "2022-06-29T13:20:34.843Z",
    "updatedAt": "2022-06-29T13:20:34.843Z"
  }
}
X-Powered-By

Express

Content-Type

application/json; charset=utf-8

Content-Length

213

ETag

W/"d5-OJ6QqOfySevGDNY41EK7twx68F0"

Date

Wed, 29 Jun 2022 13:45:44 GMT

Connection

keep-alive

Keep-Alive

timeout=5