Endpoints Specifications

Type Endpoint Auth Description Function Parameters
GET /products/all API Key Retrieves all products from the database. GetAll none
GET /products/get/:id API Key Retrieves the product from the database with the given ID. Get Product ID
Type: Integer
GET /products/category/:id API Key Retrieves all products from the database by category. GetByCategory Category ID
Type: Integer
GET /products/subcategory/:id API Key Retrieves all products from the database by sub-category. GetBySubCategory Subcategory ID
Type: Integer
GET /products/hero API Key Retrieves all hero products from the database. GetHeroProducts none
GET /products/hero/category/:category API Key Retrieves all hero products from the database by category. GetHeroProductsByCategory Category ID
Type: Integer
GET /products/search/:query API Key Retrieves all products from the database by search query. Search Query Text
Type: String
POST /products/add Private Inserts a product into the database. Insert none
PUT /products/update/:id Private Updates the product in the database with the given ID. Update Product ID
Type: Integer
DELETE /products/delete/:id Private Deletes the product from the database with the given ID. Delete Product ID
Type: Integer

Endpoints Return Data Specifications

GET /products/all

GET /product/get/:id

GET /products/category/:id

GET /products/subcategory/:id

GET /products/hero

GET /products/search/:query

POST /products/add

PUT /products/update/:id

Error Schema

Client Code Helpers

This section providers some helpers for designing the client-side code to consume the Products service from the Plamatio backend REST API.