This API endpoint is used to authenticate and login a user.
\nidentifier (string) - The identifier of the user (e.g. email or username).
password (string) - The password of the user.
The response is in JSON format with the following properties:
\nmessage (string) - A message related to the authentication.
status (integer) - The status of the authentication process.
token (string) - The authentication token for the user.
{\n \"message\": \"\",\n \"status\": 0,\n \"token\": \"\"\n}\n\nThis endpoint is used to authenticate and login the user.
\nidentifier (text) : The identifier or email of the user.
password (text) : The password of the user.
message : A message indicating the status of the authentication.
status : The status of the authentication process.
token : The authentication token for the user.
Example Response:
\n{\n \"message\": \"\",\n \"status\": 0,\n \"token\": \"\"\n}\n\nThe endpoint allows users to authenticate and obtain a token for accessing protected resources.
\nidentifier (string) - The user's email, phoneNumber or username.
password (string) - The user's password.
message (string) - A message related to the authentication status.
status (integer) - The status of the authentication process.
token (string) - The authentication token for accessing protected resources.
This endpoint is used to authenticate and login a user.
\nidentifier (text, required): The identifier of the user.
password (text, required): The password of the user.
The response for this request can be represented as a JSON schema:
\nThe response object includes the following properties:
\nmessage (string): A message related to the authentication process.
status (integer): The status code of the authentication process.
token (string): The authentication token for the user.
{\n \"message\": \"Login successful\",\n \"status\": 200,\n \"token\": \"eyJhbGciOiJIUzI1NiJ9.eyJyb2xlcyI6WyJST0xFX09XTkVSIl0sInN1YiI6IkdhbEdhZG90IiwiaWF0IjoxNzMyMjA3MDAyLCJleHAiOjE3MzIyNDMwMDJ9.90O8cinxr77Zf_CjQ933p3pBsWuLtojYvBsRQg_-Kow\"\n}\n\nThis folder contains endpoints for system access control and user authentication. It manages different user roles and their access to the system.
\nAvailable Endpoints:
\nPOST Admin Login
\nHandles administrator authentication
\nProvides access to administrative functions
\nPOST Owner Login
\nManages owner-level authentication
\nGrants access to owner-specific features
\nThis endpoint allows you to import products from a CSV file.
\nfile (file): The CSV file containing the products to be imported.
filePath (text): The file path of the CSV file.
Upon successful import, the response will include:
\nimportedProducts (array): An array of imported products.
message (string): A message indicating the import status.
totalImported (number): The total number of products imported.
status (number): The status of the import process.
{\n \"importedProducts\": [],\n \"message\": \"\",\n \"totalImported\": 0,\n \"status\": 0\n}\n\n{\n \"name\": \"\",\n \"sku\": \"\",\n \"price\": 0,\n \"quantity\": 0,\n \"minStockLevel\": 0,\n \"category\": \"\",\n \"status\": \"\",\n \"supplierId\": 0\n}\n\nThis endpoint allows you to import orders from a CSV file.
\nfile (file): The CSV file containing the orders to be imported.The response will be a JSON object with the following schema:
\n{\n \"data\": [\n {\n \"id\": 0,\n \"productId\": 0,\n \"supplierId\": 0,\n \"quantity\": 0,\n \"totalPrice\": 0,\n \"status\": \"\"\n }\n ],\n \"message\": \"\",\n \"status\": \"\"\n}\n\nThe data field contains an array of objects representing the imported orders, where each object has fields id, productId, supplierId, quantity, totalPrice, and status. The message and status fields provide additional information about the import operation.
{\n \"data\": [\n {\n \"id\": 0,\n \"productId\": 0,\n \"supplierId\": 0,\n \"quantity\": 0,\n \"totalPrice\": 0,\n \"status\": null\n }\n ],\n \"message\": \"\",\n \"status\": \"\"\n}\n\nThis endpoint allows you to export products to a CSV file.
\nThe response for this request is in JSON format and includes the following fields:
\nfilePath (string): The file path of the exported CSV file.
message (string): Any additional message related to the export process.
status (string): The status of the export process.
Example response:
\n{\n \"filePath\": \"\",\n \"message\": \"\",\n \"status\": \"\"\n}\n\n{\n \"type\": \"object\",\n \"properties\": {\n \"filePath\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"status\": {\n \"type\": \"string\"\n }\n }\n}\n\nThis endpoint allows you to export orders to a CSV file.
\nThe response for this request is in JSON format and follows the schema below:
\n{\n \"filePath\": \"string\",\n \"message\": \"string\",\n \"status\": \"string\"\n}\n\nThe response includes the following fields:
\nfilePath: The path to the exported CSV file.
message: A message related to the export process.
status: The status of the export process.
{\n \"filePath\": \"example/path/to/exported/file.csv\",\n \"message\": \"Export successful\",\n \"status\": \"success\"\n}\n\nThis folder manages all bulk data operations through CSV file handling. It contains endpoints for importing and exporting data in CSV format.
\nAvailable Endpoints:
\nPOST Import products through csv
\nAllows bulk upload of product data
\nProcesses product information from CSV files
\nPOST Import orders through csv
\nEnables bulk import of order data
\nProcesses order information from CSV files
\nPOST Export products in CSV
\nGenerates CSV files containing product data
\nAllows downloading of product information
\nPOST Export orders in CSV
\nCreates CSV files with order information
\nEnables downloading of order data
\nThe Create Order endpoint allows the client to place a new order for a product from a supplier.
productId (number): The ID of the product being ordered.
supplierId (number): The ID of the supplier from whom the product is being ordered.
quantity (number): The quantity of the product being ordered.
Status: 201 Created
\nContent-Type: application/json
\nExample Response Body:
\n{\n \"message\": \"\",\n \"status\": 0,\n \"order\": {\n \"id\": 0,\n \"product\": {\n \"id\": 0,\n \"name\": \"\",\n \"sku\": \"\",\n \"price\": 0,\n \"quantity\": 0,\n \"minStockLevel\": 0,\n \"category\": \"\",\n \"status\": \"\",\n \"supplier\": {\n \"id\": 0,\n \"name\": \"\",\n \"email\": \"\",\n \"phoneNumber\": \"\",\n \"address\": \"\",\n \"companyName\": \"\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n },\n \"quantity\": 0,\n \"totalPrice\": 0,\n \"createdAt\": \"\",\n \"status\": \"\"\n }\n}\n\nThis endpoint is used to update the details of a specific order.
\nproductId (number): The ID of the product being ordered.
supplierId (number): The ID of the supplier for the product.
quantity (number): The quantity of the product being ordered.
status (string): The status of the order.
The request body should be in JSON format and include the productId, supplierId, quantity, and status parameters.
The response will be a JSON object with the following properties:
\nmessage (string): A message related to the response.
status (number): The status code of the response.
order (object): An object containing the updated order details.
id (number): The ID of the order.
product (object): An object containing the details of the product in the order.
id (number): The ID of the product.
name (string): The name of the product.
sku (string): The stock keeping unit of the product.
price (number): The price of the product.
quantity (number): The available quantity of the product.
minStockLevel (number): The minimum stock level of the product.
category (string): The category of the product.
status (string): The status of the product.
supplier (object): An object containing the details of the supplier for the product.
id (number): The ID of the supplier.
name (string): The name of the supplier.
email (string): The email of the supplier.
phoneNumber (string): The phone number of the supplier.
address (string): The address of the supplier.
companyName (string): The name of the company of the supplier.
createdAt (string): The date and time when the product was created.
quantity (number): The quantity of the product in the order.
totalPrice (number): The total price of the order.
createdAt (string): The date and time when the order was created.
status (string): The status of the order.
The response is in JSON format.
\n{\n \"type\": \"object\",\n \"properties\": {\n \"message\": {\n \"type\": \"string\"\n },\n \"status\": {\n \"type\": \"number\"\n },\n \"order\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"number\"\n },\n \"product\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"number\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"sku\": {\n \"type\": \"string\"\n },\n \"price\": {\n \"type\": \"number\"\n },\n \"quantity\": {\n \"type\": \"number\"\n },\n \"minStockLevel\": {\n \"type\": \"number\"\n },\n \"category\": {\n \"type\": \"string\"\n },\n \"status\": {\n \"type\": \"string\"\n },\n \"supplier\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"number\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"email\": {\n \"type\": \"string\"\n },\n \"phoneNumber\": {\n \"type\": \"string\"\n },\n \"address\": {\n \"type\": \"string\"\n },\n \"companyName\": {\n \"type\": \"string\"\n }\n }\n },\n \"createdAt\": {\n \"type\": \"string\"\n }\n }\n },\n \"quantity\": {\n \"type\": \"number\"\n },\n \"totalPrice\": {\n \"type\": \"number\"\n },\n \"createdAt\": {\n \"type\": \"string\"\n },\n \"status\": {\n \"type\": \"string\"\n }\n }\n }\n }\n}\n\nThis endpoint retrieves the details of a specific order identified by its ID.
\n1 (number) - The unique identifier of the order to retrieve.The response body follows the JSON schema below:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"number\"\n },\n \"order\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"number\"\n },\n \"product\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"number\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"sku\": {\n \"type\": \"string\"\n },\n \"price\": {\n \"type\": \"number\"\n },\n \"quantity\": {\n \"type\": \"number\"\n },\n \"minStockLevel\": {\n \"type\": \"number\"\n },\n \"category\": {\n \"type\": \"string\"\n },\n \"status\": {\n \"type\": \"string\"\n },\n \"supplier\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"number\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"email\": {\n \"type\": \"string\"\n },\n \"phoneNumber\": {\n \"type\": \"string\"\n },\n \"address\": {\n \"type\": \"string\"\n },\n \"companyName\": {\n \"type\": \"string\"\n }\n }\n },\n \"createdAt\": {\n \"type\": \"string\"\n }\n }\n },\n \"quantity\": {\n \"type\": \"number\"\n },\n \"totalPrice\": {\n \"type\": \"number\"\n },\n \"createdAt\": {\n \"type\": \"string\"\n },\n \"status\": {\n \"type\": \"string\"\n }\n }\n }\n }\n}\n\nThis is a GET request to fetch all the orders.
\nThe response will be a JSON object with the following schema:
\n{\n \"orders\": [\n {\n \"id\": \"number\",\n \"product\": {\n \"id\": \"number\",\n \"name\": \"string\",\n \"sku\": \"string\",\n \"price\": \"number\",\n \"quantity\": \"number\",\n \"minStockLevel\": \"number\",\n \"category\": \"string\",\n \"status\": \"string\",\n \"supplier\": {\n \"id\": \"number\",\n \"name\": \"string\",\n \"email\": \"string\",\n \"phoneNumber\": \"string\",\n \"address\": \"string\",\n \"companyName\": \"string\"\n },\n \"createdAt\": \"string\",\n \"updatedAt\": \"string\"\n },\n \"quantity\": \"number\",\n \"totalPrice\": \"number\",\n \"createdAt\": \"string\",\n \"status\": \"string\"\n }\n ],\n \"status\": \"number\"\n}\n\nThis endpoint is used to delete a specific order identified by the orderId in the URL.
\nNo request body is required for this endpoint. The orderId is specified in the URL path.
\norderId (path parameter) - The ID of the order to be deleted.The response for this request is in JSON format and includes the following fields:
\nmessage (string) - A message related to the status of the request.
status (number) - A status code indicating the result of the request.
Example response:
\n{\n \"message\":\"string\",\n \"status\": \"number\"\n}\n\n{\n \"type\": \"object\",\n \"properties\": {\n \"message\": {\n \"type\": \"string\"\n },\n \"status\": {\n \"type\": \"number\"\n }\n },\n \"required\": [\"message\", \"status\"]\n}\n\nThis folder contains all endpoints related to order management and processing. It handles the complete lifecycle of orders from creation to deletion.
\nAvailable Endpoints:
\nPOST Create a New Order
\nPrimary method for creating orders
\nFirst version of order creation
\nPUT Update an Order
\nModifies existing order information
\nHandles order updates
\nGET Get Order by ID
\nRetrieves specific order details
\nSearches orders by unique identifier
\nGET Get all orders
\nLists all orders in the system
\nProvides complete order overview
\nDEL Delete an Order
\nRemoves orders from the system
\nHandles order deletion
\nThis endpoint allows the creation of a new product.
\nname (string, required): The name of the product.
\nsku (string, required): The stock keeping unit (SKU) of the product.
\nprice (number, required): The price of the product.
\nquantity (number, required): The initial quantity of the product.
\nminStockLevel (number, required): The minimum stock level for the product.
\ncategory (string, required): The category of the product.
\nsupplierId (number, required): The ID of the supplier for the product.
\nThe response will be a JSON object with the following schema:
\n{\n \"product\": {\n \"id\": 0,\n \"name\": \"\",\n \"sku\": \"\",\n \"price\": 0,\n \"quantity\": 0,\n \"minStockLevel\": 0,\n \"category\": \"\",\n \"status\": \"\",\n \"supplier\": {\n \"id\": 0,\n \"name\": \"\",\n \"email\": \"\",\n \"phoneNumber\": \"\",\n \"address\": \"\",\n \"companyName\": \"\"\n },\n \"createdAt\": \"\"\n },\n \"message\": \"\",\n \"status\": 0\n}\n\nproduct (object): The details of the created product.
\nid (number): The ID of the product.
\nname (string): The name of the product.
\nsku (string): The stock keeping unit (SKU) of the product.
\nprice (number): The price of the product.
\nquantity (number): The quantity of the product.
\nminStockLevel (number): The minimum stock level for the product.
\ncategory (string): The category of the product.
\nstatus (string): The status of the product.
\nsupplier (object): The details of the supplier for the product.
\nid (number): The ID of the supplier.
\nname (string): The name of the supplier.
\nemail (string): The email of the supplier.
\nphoneNumber (string): The phone number of the supplier.
\naddress (string): The address of the supplier.
\ncompanyName (string): The company name of the supplier.
\ncreatedAt (string): The date and time of product creation.
\nmessage (string): A message related to the request.
\nstatus (number): The status of the request.
\nThis endpoint is used to update a specific product by its ID.
\nname (string, required): The name of the product.
\nsku (string, required): The Stock Keeping Unit (SKU) of the product.
\nprice (number, required): The price of the product.
\nquantity (number, required): The available quantity of the product.
\nminStockLevel (number, required): The minimum stock level of the product.
\ncategory (string, required): The category of the product.
\nsupplierId (number, required): The ID of the supplier.
\nThe response will be a JSON object with the following properties:
\nproduct (object): Information about the updated product, including its ID, name, SKU, price, quantity, minimum stock level, category, status, supplier details, creation date, and last update date.
\nmessage (string): A message related to the update operation.
\nstatus (number): The status of the update operation.
\n{\n \"product\": {\n \"id\": 0,\n \"name\": \"\",\n \"sku\": \"\",\n \"price\": 0,\n \"quantity\": 0,\n \"minStockLevel\": 0,\n \"category\": \"\",\n \"status\": \"\",\n \"supplier\": {\n \"id\": 0,\n \"name\": \"\",\n \"email\": \"\",\n \"phoneNumber\": \"\",\n \"address\": \"\",\n \"companyName\": \"\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n },\n \"message\": \"\",\n \"status\": 0\n}\n\n{\n \"type\": \"object\",\n \"properties\": {\n \"product\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"number\" },\n \"name\": { \"type\": \"string\" },\n \"sku\": { \"type\": \"string\" },\n \"price\": { \"type\": \"number\" },\n \"quantity\": { \"type\": \"number\" },\n \"minStockLevel\": { \"type\": \"number\" },\n \"category\": { \"type\": \"string\" },\n \"status\": { \"type\": \"string\" },\n \"supplier\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"number\" },\n \"name\": { \"type\": \"string\" },\n \"email\": { \"type\": \"string\" },\n \"phoneNumber\": { \"type\": \"string\" },\n \"address\": { \"type\": \"string\" },\n \"companyName\": { \"type\": \"string\" }\n }\n },\n \"createdAt\": { \"type\": \"string\" },\n \"updatedAt\": { \"type\": \"string\" }\n }\n },\n \"message\": { \"type\": \"string\" },\n \"status\": { \"type\": \"number\" }\n }\n}\n\nThe endpoint retrieves product information based on the provided product ID.
\nThe response for this request can be documented as a JSON schema as follows:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"product\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\"type\": \"number\"},\n \"name\": {\"type\": \"string\"},\n \"sku\": {\"type\": \"string\"},\n \"price\": {\"type\": \"number\"},\n \"quantity\": {\"type\": \"number\"},\n \"minStockLevel\": {\"type\": \"number\"},\n \"category\": {\"type\": \"string\"},\n \"status\": {\"type\": \"string\"},\n \"supplier\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\"type\": \"number\"},\n \"name\": {\"type\": \"string\"},\n \"email\": {\"type\": \"string\"},\n \"phoneNumber\": {\"type\": \"string\"},\n \"address\": {\"type\": \"string\"},\n \"companyName\": {\"type\": \"string\"}\n }\n },\n \"createdAt\": {\"type\": \"string\"}\n }\n },\n \"status\": {\"type\": \"number\"}\n }\n}\n\nThis endpoint retrieves all products.
\nThis request does not require a request body.
\nThe response will be in JSON format with the following schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"number\"\n },\n \"products\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"number\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"sku\": {\n \"type\": \"string\"\n },\n \"price\": {\n \"type\": \"number\"\n },\n \"quantity\": {\n \"type\": \"number\"\n },\n \"minStockLevel\": {\n \"type\": \"number\"\n },\n \"category\": {\n \"type\": \"string\"\n },\n \"status\": {\n \"type\": \"string\"\n },\n \"supplier\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"number\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"email\": {\n \"type\": \"string\"\n },\n \"phoneNumber\": {\n \"type\": \"string\"\n },\n \"address\": {\n \"type\": \"string\"\n },\n \"companyName\": {\n \"type\": \"string\"\n }\n }\n },\n \"createdAt\": {\n \"type\": \"string\"\n },\n \"updatedAt\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}\n\nThis endpoint is used to delete a specific product.
\nMethod: DELETE
\nEndpoint: http://localhost:8080/api/products/delete/4
The response for this request follows the JSON schema below:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"message\": {\n \"type\": \"string\"\n },\n \"status\": {\n \"type\": \"number\"\n }\n }\n}\n\nThis folder manages all product-related operations in the inventory system, including creation, modification, retrieval, and deletion of products.
\nAvailable Endpoints:
\nPOST Create a New Product
\nPrimary method for product creation
\nFirst version of product registration
\nPUT Update an existing product
\nModifies existing product information
\nHandles product updates
\nGET Get Product by ID
\nRetrieves specific product details
\nSearches products by unique identifier
\nGET Get All Products
\nLists all products in the system
\nProvides complete product catalog
\nDEL Delete Product by ID
\nRemoves products from the system
\nHandles product deletion
\nThis endpoint allows you to create a new supplier.
\nname (string, required): The name of the supplier.
\nemail (string, required): The email address of the supplier.
\nphoneNumber (string, required): The phone number of the supplier.
\naddress (string, required): The address of the supplier.
\ncompanyName (string, required): The name of the supplier's company.
\nThe response will be a JSON object with the following properties:
\nsupplier (object): An object containing the details of the created supplier, including id, name, email, phoneNumber, address, and companyName.
\nmessage (string): A message indicating the status of the request.
\nstatus (integer): A status code indicating the success or failure of the request.
\n{\n \"supplier\": {\n \"id\": 0,\n \"name\": \"\",\n \"email\": \"\",\n \"phoneNumber\": \"\",\n \"address\": \"\",\n \"companyName\": \"\"\n },\n \"message\": \"\",\n \"status\": 0\n}\n\nThis endpoint allows the client to update the details of a specific supplier.
\nType: JSON
\nname: (string) The name of the supplier.
email: (string) The email address of the supplier.
phoneNumber: (string) The phone number of the supplier.
address: (string) The address of the supplier.
companyName: (string) The name of the supplier's company.
{\n \"type\": \"object\",\n \"properties\": {\n \"supplier\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"integer\" },\n \"name\": { \"type\": \"string\" },\n \"email\": { \"type\": \"string\" },\n \"phoneNumber\": { \"type\": \"string\" },\n \"address\": { \"type\": \"string\" },\n \"companyName\": { \"type\": \"string\" }\n }\n },\n \"message\": { \"type\": \"string\" },\n \"status\": { \"type\": \"integer\" }\n }\n}\n\nThis endpoint retrieves a list of all suppliers.
\nThis is a GET request to fetch the list of all suppliers.
\nThe response will be in JSON format with the following schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"suppliers\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"integer\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"email\": {\n \"type\": \"string\"\n },\n \"phoneNumber\": {\n \"type\": \"string\"\n },\n \"address\": {\n \"type\": \"string\"\n },\n \"companyName\": {\n \"type\": \"string\"\n }\n }\n }\n },\n \"status\": {\n \"type\": \"integer\"\n }\n }\n}\n\nThe response will contain an array of supplier objects with their respective id, name, email, phone number, address, and company name. The status field indicates the status of the response.
\n","urlObject":{"protocol":"http","port":"8080","path":["api","suppliers","all"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"40b1eaef-8bd3-4e1e-b7fe-eff021fd36a1","name":"Get all suppliers_Success","originalRequest":{"method":"GET","header":[],"url":"http://localhost:8080/api/suppliers/all"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 21 Nov 2024 14:33:46 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"suppliers\": [\n {\n \"id\": 1,\n \"name\": \"Supplier Name 1\",\n \"email\": \"supplier1@yopmail.com\",\n \"phoneNumber\": \"1234567891\",\n \"address\": \"123 Street, City\",\n \"companyName\": \"Supplier1 Company\"\n },\n {\n \"id\": 2,\n \"name\": \"Supplier Name 2\",\n \"email\": \"supplier2@yopmail.com\",\n \"phoneNumber\": \"1234567892\",\n \"address\": \"123 Street, City\",\n \"companyName\": \"Supplier2 Company\"\n }\n ],\n \"status\": 200\n}"},{"id":"20320e79-18e3-4e80-a852-6a1ac450d94e","name":"Get all suppliers_Failure (unauthorized)","originalRequest":{"method":"GET","header":[],"url":"http://localhost:8080/api/suppliers/all"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json;charset=ISO-8859-1"},{"key":"Content-Length","value":"145"},{"key":"Date","value":"Thu, 21 Nov 2024 14:34:11 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2024-11-21T20:19:11.324996100\",\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": \"Authentication is required to access this resource.\"\n}"}],"_postman_id":"46ca2ab9-5084-4272-9caf-25df6aa94073"},{"name":"get supplier by id","id":"4bee803e-d2e5-49c7-befc-38032bc5bcda","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This endpoint retrieves the details of a specific supplier with the given ID.
\nNo request body is required for this endpoint.
\nThe response will be in JSON format with the following schema:
\n{\n \"supplier\": {\n \"id\": 0,\n \"name\": \"\",\n \"email\": \"\",\n \"phoneNumber\": \"\",\n \"address\": \"\",\n \"companyName\": \"\"\n },\n \"status\": 0\n}\n\nThe supplier object contains the details of the supplier including their ID, name, email, phone number, address, and company name. The status field indicates the status of the response.
Example response:
\n{\n \"supplier\": {\n \"id\": 0,\n \"name\": \"\",\n \"email\": \"\",\n \"phoneNumber\": \"\",\n \"address\": \"\",\n \"companyName\": \"\"\n },\n \"status\": 0\n}\n\nThis endpoint is used to delete a specific supplier by their ID.
\nThis request does not require a request body.
\nmessage (string): A message indicating the result of the deletion.
status (integer): A status code indicating the success or failure of the deletion operation.
Example Response:
\n{\n \"message\": \"\",\n \"status\": 0\n}\n\nThis folder contains endpoints for managing supplier information, including adding new suppliers, updating their information, and managing supplier relationships.
\nAvailable Endpoints:
\nPOST Create a new Supplier
\nPrimary method for supplier registration
\nFirst version of supplier creation
\nPUT Update existing Supplier
\nModifies existing supplier information
\nHandles supplier detail updates
\nGET Get all suppliers
\nLists all suppliers in the system
\nProvides complete supplier overview
\nGET get supplier by id
\nRetrieves specific supplier details
\nSearches suppliers by unique identifier
\nDEL delete supplier by id
\nRemoves suppliers from the system
\nHandles supplier deletion
\nThis endpoint allows the client to register a new user.
\nusername (string, required): The username of the user.
password (string, required): The password for the user account.
email (string, required): The email address of the user.
fullName (string, required): The full name of the user.
dateOfBirth (string, required): The date of birth of the user.
phoneNumber (string, required): The phone number of the user.
address (string, required): The address of the user.
Example:
\n{\n \"username\": \"GalGadot\",\n \"password\": \"GalGadot\",\n \"email\": \"fiwiji4188@venfee.com\",\n \"fullName\": \"Gal Gadot\",\n \"dateOfBirth\": \"30-04-1985\",\n \"phoneNumber\": \"6543210987\",\n \"address\": \"Rosh HaAyin, Israel\"\n}\n\nThe response will be a JSON object with the following properties:
\nmessage (string): A message related to the request.
user (object): An object containing user details including id, username, password, email, fullName, roles, dateOfBirth, phoneNumber, address, and createdAt.
id (number): The unique identifier of the user.
username (string): The username of the user.
password (string): The password of the user.
email (string): The email address of the user.
fullName (string): The full name of the user.
roles (array of strings): The roles assigned to the user.
dateOfBirth (string): The date of birth of the user.
phoneNumber (string): The phone number of the user.
address (string): The address of the user.
createdAt (string): The timestamp of when the user account was created.
status (number): The status code of the response.
Example:
\n{\n \"message\": \"\",\n \"user\": {\n \"id\": 0,\n \"username\": \"\",\n \"password\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"roles\": [\"\"],\n \"dateOfBirth\": \"\",\n \"phoneNumber\": \"\",\n \"address\": \"\",\n \"createdAt\": \"\"\n },\n \"status\": 0\n}\n\nThis endpoint allows updating user information via an HTTP PUT request to the specified URL. The request should include a JSON payload with the updated user details such as username, password, email, full name, date of birth, phone number, and address.
\nusername: (string) The updated username.
password: (string) The updated password.
email: (string) The updated email address.
fullName: (string) The updated full name.
dateOfBirth: (string) The updated date of birth.
phoneNumber: (string) The updated phone number.
address: (string) The updated address.
The response is in JSON format and includes the following fields:
\nmessage: (string) A message related to the update operation.
user: (object) An object containing the updated user information with the following fields:
id: (number) The user ID.
username: (string) The updated username.
password: (string) The updated password.
email: (string) The updated email address.
fullName: (string) The updated full name.
roles: (array) An array of user roles.
dateOfBirth: (string) The updated date of birth.
phoneNumber: (string) The updated phone number.
address: (string) The updated address.
createdAt: (string) The timestamp of user creation.
updatedAt: (string) The timestamp of the last update.
status: (number) The status of the update operation.
{\n \"type\": \"object\",\n \"properties\": {\n \"message\": {\"type\": \"string\"},\n \"user\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\"type\": \"number\"},\n \"username\": {\"type\": \"string\"},\n \"password\": {\"type\": \"string\"},\n \"email\": {\"type\": \"string\"},\n \"fullName\": {\"type\": \"string\"},\n \"roles\": {\"type\": \"array\"},\n \"dateOfBirth\": {\"type\": \"string\"},\n \"phoneNumber\": {\"type\": \"string\"},\n \"address\": {\"type\": \"string\"},\n \"createdAt\": {\"type\": \"string\"},\n \"updatedAt\": {\"type\": \"string\"}\n }\n },\n \"status\": {\"type\": \"number\"}\n }\n}\n\nThis endpoint retrieves all users.
\nThis is a GET request to fetch all users.
\nThe response for this request is a JSON object with the following schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"users\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"number\"\n },\n \"username\": {\n \"type\": \"string\"\n },\n \"password\": {\n \"type\": \"string\"\n },\n \"email\": {\n \"type\": \"string\"\n },\n \"fullName\": {\n \"type\": \"string\"\n },\n \"roles\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"dateOfBirth\": {\n \"type\": \"string\"\n },\n \"phoneNumber\": {\n \"type\": \"string\"\n },\n \"address\": {\n \"type\": \"string\"\n },\n \"createdAt\": {\n \"type\": \"string\"\n },\n \"updatedAt\": {\n \"type\": \"string\"\n }\n }\n }\n },\n \"status\": {\n \"type\": \"number\"\n }\n }\n}\n\nThis endpoint retrieves the details of a specific user with the given ID.
\nNo request body is required for this request.
\nThe response will be in JSON format and will include the following fields:
\nuser (object): An object containing the details of the user, including their ID, username, password, email, full name, roles, date of birth, phone number, address, creation timestamp, and last update timestamp.
id (number): The unique identifier of the user.
username (string): The username of the user.
password (string): The password of the user.
email (string): The email address of the user.
fullName (string): The full name of the user.
roles (array): An array containing the roles assigned to the user.
dateOfBirth (string): The date of birth of the user.
phoneNumber (string): The phone number of the user.
address (string): The address of the user.
createdAt (string): The timestamp when the user was created.
updatedAt (string): The timestamp when the user was last updated.
status (number): The status of the response.
{\n \"user\": {\n \"id\": 0,\n \"username\": \"\",\n \"password\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"roles\": [\"\"],\n \"dateOfBirth\": \"\",\n \"phoneNumber\": \"\",\n \"address\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n },\n \"status\": 0\n}\n\nThis endpoint is used to delete a user with the specified ID.
\nNo request body parameters are required for this request.
\nPath Parameters
\nid (integer): The ID of the user to be deleted.The response for this request is in JSON format and follows the schema below:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"message\": {\n \"type\": \"string\"\n },\n \"status\": {\n \"type\": \"integer\"\n }\n }\n}\n\nThe response contains the following fields:
\nmessage (string): A message related to the deletion operation.
status (integer): The status code of the deletion operation.
{\n \"message\": \"\",\n \"status\": 0\n}\n\nThis folder manages user-related operations, including user registration, profile updates, and user account management.
\nAvailable Endpoints:
\nPOST Register User
\nCreates new user accounts
\nHandles user registration
\nPUT Update User
\nModifies existing user information
\nHandles user profile updates
\nGET get all users
\nLists all users in the system
\nProvides complete user overview
\nGET get user by id
\nRetrieves specific user details
\nSearches users by unique identifier
\nDEL delete user by id
\nRemoves user accounts
\nHandles user deletion
\n