This API provides comprehensive endpoints for managing customers, items, and orders, enabling full CRUD operations for each entity. It allows users to create, update, delete, and retrieve customer, item, and order data with detailed success and error responses. The system is designed for seamless integration and efficient data management, ensuring smooth interaction between different parts of the application. With robust handling of all operations, the API supports reliable and flexible management of business data.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"35384124","collectionId":"dfb8041a-7578-476b-a5a7-4c3508d66245","publishedId":"2sAXxV4pTW","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-10-16T07:49:40.000Z"},"item":[{"name":"Health Test API","item":[{"name":"Health Test","id":"6451ad31-2709-4fef-abdf-1bc165bd2b01","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:8080/pos_system/api/v1/health","description":"This controller features a single endpoint that responds to GET requests. When a GET request is made to /api/v1/health, it returns a simple string message indicating that the health test is successful, confirming the application is operational.
This API endpoint is designed to monitor the application's health status. It handles HTTP requests mapped to the URL path api/v1/health, providing a straightforward health check functionality.
The POST /api/v1/customers endpoint creates a new customer by accepting customer properties as multipart data. Upon successful processing of the request, it returns a 201 Created response. If the provided data is invalid or fails to persist, it responds with a 400 Bad Request. In cases of unexpected errors, the endpoint will return a 500 Internal Server Error.
The PUT /api/v1/customers/{id} endpoint updates an existing customer by accepting the customer properties as multipart data, along with the customer's ID as a path variable. Upon successful processing, it returns a 204 No Content response. If the specified customer ID does not exist, it responds with a 404 Not Found. In the event of unexpected errors, the endpoint will return a 500 Internal Server Error.
The DELETE /api/v1/customer/{id} endpoint deletes a customer by their id. A successful deletion returns 204 No Content. If the customer doesn’t exist, 404 Not Found is returned. Server errors result in 500 Internal Server Error.
The GET /api/v1/customer/{id} endpoint retrieves a customer by their id. A successful retrieval returns 200 OK. If the customer is not found, 404 Not Found is returned. Unexpected errors return 500 Internal Server Error.
The GET /api/v1/customer endpoint retrieves all customers. A successful request returns 200 OK with customer data. If a server error occurs during retrieval, 500 Internal Server Error is returned.
This API endpoints handles CRUD operations for managing customer data in the system. It allows creating, updating, deleting, and retrieving customer records. The controller includes the following endpoints: POST /api/v1/customer to save a new customer, PUT /api/v1/customer/{id} to update an existing customer by ID, DELETE /api/v1/customer/{id} to remove a customer, GET /api/v1/customer/{id} to retrieve a customer by their ID, and GET /api/v1/customer to retrieve all customers. Each operation is accompanied by appropriate responses, including success and error handling, ensuring seamless customer data management.
The POST /api/v1/item endpoint creates a new item using an ItemDTO object in the request body. A successful request returns 201 Created. If the data is invalid or cannot be persisted, a 400 Bad Request is returned. Server errors result in a 500 Internal Server Error.
The PUT /api/v1/item/{id} endpoint updates an existing item identified by its id using an ItemDTO object in the request body. A successful update returns 204 No Content. If the item is not found, 404 Not Found is returned, and server errors result in 500 Internal Server Error.
The DELETE /api/v1/item/{id} endpoint deletes an existing item by its id. A successful deletion returns 204 No Content. If the item doesn’t exist, 404 Not Found is returned. Any server errors lead to a 500 Internal Server Error.
The GET /api/v1/item/{id} endpoint retrieves a specific item by its id. If successful, the server returns the item along with a 200 OK status. If the item is not found, 404 Not Found is returned. Server errors result in a 500 Internal Server Error.
The GET /api/v1/item endpoint retrieves all items in the system. A successful response returns 200 OK with the list of items. If a server error occurs, a 500 Internal Server Error is returned.
This API endpoints manages operations related to items within the system, providing endpoints for creating, updating, deleting, and retrieving items. The available endpoints include POST /api/v1/item for saving a new item, PUT /api/v1/item/{id} for updating an existing item by its ID, DELETE /api/v1/item/{id} for deleting an item by ID, GET /api/v1/item/{id} for retrieving a specific item, and GET /api/v1/item for fetching all items. The controller ensures proper handling of success and error responses, facilitating smooth item management across all operations.
The POST /api/v1/order endpoint creates a new order using an OrderDTO object in the request body. A successful request returns 201 Created. If data persistence fails, a 400 Bad Request is returned. Server errors result in a 500 Internal Server Error.
The GET /api/v1/order/{id} endpoint retrieves a specific order by its id. If successful, the order is returned with a 200 OK status. If the order is not found, a 404 Not Found is returned. Server errors result in a 500 Internal Server Error.
The GET /api/v1/order endpoint retrieves all orders. A successful request returns 200 OK with the list of orders. If a server error occurs during retrieval, a 500 Internal Server Error is returned.
This API endpoints facilitates the management of customer orders by offering endpoints to create and retrieve order data. The controller includes POST /api/v1/order to save a new order, GET /api/v1/order/{id} to retrieve a specific order by its ID, and GET /api/v1/order to retrieve all orders. Each endpoint is equipped with detailed success and error responses, ensuring robust handling of customer orders within the system.