{"info":{"_postman_id":"0bbdc8e4-e8bd-4d37-901a-3f1585d69a69","name":"Spring POS API","description":"

The Spring POS API provides a set of endpoints for managing customers, orders, items, and payments in a Point of Sale (POS) system. This API allows users to interact with the core functionalities of the POS, such as placing orders, managing customers and inventory, and retrieving sales information.

Base URL

All API requests should be made to the base URL: http://localhost:8080/Spring_POS_API/api/v1

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"35384990","collectionId":"0bbdc8e4-e8bd-4d37-901a-3f1585d69a69","publishedId":"2sAXxQfCXa","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-10-10T13:03:59.000Z"},"item":[{"name":"Health","item":[{"name":"health check","id":"de2c07e7-0e38-4799-a986-a53b134ba50b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:8080/Spring_POS_API/api/v1/health","description":"

This request is used to check the health status of the API. It verifies whether the API is operational and can respond to requests.

\n","urlObject":{"protocol":"http","port":"8080","path":["Spring_POS_API","api","v1","health"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"f1a7c422-6285-4813-9b5e-1b215d33277d","name":"health response","originalRequest":{"method":"GET","header":[],"url":"http://localhost:8080/Spring_POS_API/api/v1/health"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Content-Type","value":"text/plain;charset=ISO-8859-1"},{"key":"Content-Length","value":"25"},{"key":"Date","value":"Fri, 04 Oct 2024 06:44:37 GMT"},{"key":"Keep-Alive","value":"timeout=20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"Spring POS API is running"}],"_postman_id":"de2c07e7-0e38-4799-a986-a53b134ba50b"}],"id":"a08bc8c6-45ec-4d27-8d78-84dc496d7ac3","description":"

This folder contains requests related to checking the health status of the API. These requests are used to verify whether the API and its dependencies are operational. Typically, these requests return status information about the API’s uptime, database connections, and other critical services.

\n","_postman_id":"a08bc8c6-45ec-4d27-8d78-84dc496d7ac3"},{"name":"Customers","item":[{"name":"save customer","id":"a7087ab7-b50e-43cf-a382-e0860ee33639","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"firstName\": \"Sandun\",\r\n \"lastName\": \"Dilshan\",\r\n \"address\": \"Galle\",\r\n \"email\": \"sandun@gmail.com\",\r\n \"mobile\": \"0762357995\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:8080/Spring_POS_API/api/v1/customers","description":"

This request is used to save customer details in the POS system API. The endpoint accepts a JSON payload containing the customer’s first name, last name, email, and mobile number. Upon successful execution, the API will store the provided customer information in the database.

This request is used to retrieve customer details by their unique ID. The endpoint requires the customer ID as a path parameter and returns the customer’s information if the ID is found in the database. This is useful for fetching specific customer data for review or further processing.

\n","urlObject":{"protocol":"http","port":"8080","path":["Spring_POS_API","api","v1","customers","C001"],"host":["localhost"],"query":[{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[{"id":"6158ae47-ba1e-4e33-8704-b3ce1f52054f","name":"search customer","originalRequest":{"method":"GET","header":[],"url":{"raw":"http://localhost:8080/Spring_POS_API/api/v1/customers/C001","protocol":"http","host":["localhost"],"port":"8080","path":["Spring_POS_API","api","v1","customers","C001"],"query":[{"key":"","value":"","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Sat, 05 Oct 2024 11:17:41 GMT"},{"key":"Keep-Alive","value":"timeout=20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"customerId\": \"C001\",\n \"firstName\": \"Sandun\",\n \"lastName\": \"Dilshan\",\n \"name\": \"Sandun Dilshan\",\n \"address\": \"Galle\",\n \"email\": \"sandun@gmail.com\",\n \"mobile\": 762357995,\n \"registerDateTime\": [\n 2024,\n 10,\n 5,\n 11,\n 9,\n 5,\n 102276000\n ]\n}"}],"_postman_id":"64f38882-86b5-4273-9bf0-f4bfd36dc2b0"},{"name":"update customer","id":"b1ff9739-3c7f-4d86-aa76-80fba77592be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"firstName\": \"Sandun\",\r\n \"lastName\": \"Dilshan\",\r\n \"address\": \"Colombo\",\r\n \"email\": \"sandun@gmail.com\",\r\n \"mobile\": \"0762357995\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:8080/Spring_POS_API/api/v1/customers/C001","description":"

This request is used to update the details of an existing customer in the POS system API. The endpoint requires the customer ID as a path parameter and accepts a JSON payload with the updated customer information. Upon successful execution, the API will update the specified customer’s record in the database.

\n","urlObject":{"protocol":"http","port":"8080","path":["Spring_POS_API","api","v1","customers","C001"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"b3976f5e-491d-41be-a743-e19dfbdb65a9","name":"update customer","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"firstName\": \"Sandun\",\r\n \"lastName\": \"Dilshan\",\r\n \"address\": \"Colombo\",\r\n \"email\": \"sandun@gmail.com\",\r\n \"mobile\": \"0762357995\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:8080/Spring_POS_API/api/v1/customers/C001"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Sat, 05 Oct 2024 11:42:49 GMT"},{"key":"Keep-Alive","value":"timeout=20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"b1ff9739-3c7f-4d86-aa76-80fba77592be"},{"name":"delete customer","id":"d2a7b59f-b67c-47e7-ab7b-89e7d86b0336","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"http://localhost:8080/Spring_POS_API/api/v1/customers/C001","description":"

This request is used to delete a customer from the POS system API. The endpoint requires the customer ID as a path parameter. Upon successful execution, the API will remove the specified customer’s record from the database.

\n","urlObject":{"protocol":"http","port":"8080","path":["Spring_POS_API","api","v1","customers","C001"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"68f7bf80-4271-42c5-b5fd-a8ff0d9d8343","name":"delete customer","originalRequest":{"method":"DELETE","header":[],"url":"http://localhost:8080/Spring_POS_API/api/v1/customers/C001"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Sat, 05 Oct 2024 11:52:58 GMT"},{"key":"Keep-Alive","value":"timeout=20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"d2a7b59f-b67c-47e7-ab7b-89e7d86b0336"},{"name":"get all customers","id":"66ea1182-6e34-423c-be9e-b2c7694aadcb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:8080/Spring_POS_API/api/v1/customers","description":"

This request is used to retrieve a list of all customers from the POS system API. The endpoint returns a JSON array containing customer details such as id, first name, last name, email, and mobile number. This is useful for fetching all customer records for review or further processing.

\n","urlObject":{"protocol":"http","port":"8080","path":["Spring_POS_API","api","v1","customers"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"5c8062bb-ca92-4a91-9137-d13c8e428ff0","name":"get all customers","originalRequest":{"method":"GET","header":[],"url":"http://localhost:8080/Spring_POS_API/api/v1/customers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Fri, 11 Oct 2024 17:46:45 GMT"},{"key":"Keep-Alive","value":"timeout=20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"customerId\": \"C002\",\n \"firstName\": null,\n \"lastName\": null,\n \"name\": \"test data\",\n \"address\": \"Galle\",\n \"email\": \"test@gmail.com\",\n \"mobile\": 112345678,\n \"lastUpdatedAt\": \"2024-10-05T16:49:27.510103\"\n },\n {\n \"customerId\": \"C003\",\n \"firstName\": null,\n \"lastName\": null,\n \"name\": \"Sandun Dilshan\",\n \"address\": \"Galle\",\n \"email\": \"sandun@gmail.com\",\n \"mobile\": 762357995,\n \"lastUpdatedAt\": \"2024-10-05T17:24:11.483828\"\n },\n {\n \"customerId\": \"C004\",\n \"firstName\": null,\n \"lastName\": null,\n \"name\": \"udara san\",\n \"address\": \"Galle\",\n \"email\": \"san@gmail.com\",\n \"mobile\": 762357996,\n \"lastUpdatedAt\": \"2024-10-09T23:33:15.524904\"\n },\n {\n \"customerId\": \"C005\",\n \"firstName\": null,\n \"lastName\": null,\n \"name\": \"ajax jquery\",\n \"address\": \"java script\",\n \"email\": \"ajaxjquery@gmail.com\",\n \"mobile\": 789645368,\n \"lastUpdatedAt\": \"2024-10-11T22:02:44.154464\"\n }\n]"}],"_postman_id":"66ea1182-6e34-423c-be9e-b2c7694aadcb"}],"id":"6695d7b1-18a8-4e09-83e3-0fbcc8feef45","description":"

This folder includes requests for managing customer data within the POS system. These requests allow you to create, retrieve, update, and delete customer records. This is essential for maintaining accurate and up-to-date customer information.

\n","_postman_id":"6695d7b1-18a8-4e09-83e3-0fbcc8feef45"},{"name":"Items","item":[{"name":"save item","id":"f4317c61-d7e0-4e5c-baf3-22f8f3f08855","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"category\": \"Soap\",\r\n \"unitPrice\": 100,\r\n \"qtyOnHand\": 20,\r\n \"expireDate\": \"2025-10-05\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"http://localhost:8080/Spring_POS_API/api/v1/items","description":"

This request is used to save a new item in the POS system. The endpoint accepts a JSON payload containing the item’s category, unit price, quantity on hand, and expiry date. Upon successful execution, the API will store the provided item information in the database, making it available for inventory management and sales operations.

\n","urlObject":{"protocol":"http","port":"8080","path":["Spring_POS_API","api","v1","items"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"c805c562-c683-43b7-b7c3-6f4a1e09e74c","name":"save item","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"category\": \"Soap\",\r\n \"unitPrice\": 100,\r\n \"qtyOnHand\": 20,\r\n \"expireDate\": \"2025-10-05\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"http://localhost:8080/Spring_POS_API/api/v1/items"},"status":"Created","code":201,"_postman_previewlanguage":"plain","header":[{"key":"Content-Length","value":"0"},{"key":"Date","value":"Wed, 09 Oct 2024 18:16:23 GMT"},{"key":"Keep-Alive","value":"timeout=20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"f4317c61-d7e0-4e5c-baf3-22f8f3f08855"},{"name":"search item","id":"1aa58177-ed7c-4365-897c-d899241ba619","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:8080/Spring_POS_API/api/v1/items/I001","description":"

This request is used to retrieve the details of a specific item in the POS system by its unique ID. The endpoint requires the item ID as a path parameter and returns the item’s information if the ID is found in the database. This is useful for fetching specific item data for inventory management or sales operations.

\n","urlObject":{"protocol":"http","port":"8080","path":["Spring_POS_API","api","v1","items","I001"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"0e214701-be08-47e8-b394-a05d5d02e0e0","name":"search item","originalRequest":{"method":"GET","header":[],"url":"http://localhost:8080/Spring_POS_API/api/v1/items/I001"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Sat, 05 Oct 2024 16:16:18 GMT"},{"key":"Keep-Alive","value":"timeout=20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"itemCode\": \"I001\",\n \"category\": \"soap\",\n \"unitPrice\": 150,\n \"qtyOnHand\": 50,\n \"registerDate\": [\n 2024,\n 10,\n 5\n ],\n \"expireDate\": [\n 2025,\n 10,\n 5\n ]\n}"}],"_postman_id":"1aa58177-ed7c-4365-897c-d899241ba619"},{"name":"update item","id":"99339b37-b6dc-407f-9f24-fa4a5fbd01e8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"category\": \"soap\",\r\n \"unitPrice\": \"180\",\r\n \"qtyOnHand\": \"50\",\r\n \"expireDate\": \"2025-10-05\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:8080/Spring_POS_API/api/v1/items/I001","description":"

This request is used to update the details of an existing item in the POS system. The endpoint requires the item ID as a path parameter and accepts a JSON payload with the updated item information. Upon successful execution, the API will update the specified item’s record in the database.

\n","urlObject":{"protocol":"http","port":"8080","path":["Spring_POS_API","api","v1","items","I001"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"5c1a7c28-8910-48a4-9530-ade03383f79e","name":"update item","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"category\": \"soap\",\r\n \"unitPrice\": \"180\",\r\n \"qtyOnHand\": \"50\",\r\n \"expireDate\": \"2025-10-05\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:8080/Spring_POS_API/api/v1/items/I001"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Sat, 05 Oct 2024 16:32:06 GMT"},{"key":"Keep-Alive","value":"timeout=20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"99339b37-b6dc-407f-9f24-fa4a5fbd01e8"},{"name":"get all items","id":"9dd2e692-bd4c-455f-94c7-c4d6cf1a168b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:8080/Spring_POS_API/api/v1/items","description":"

This request is used to retrieve a list of all items from the POS system API. The endpoint returns a JSON array containing details of all items, such as category, unit price, quantity on hand, and expiry date. This is useful for fetching all item records for inventory management and review.

\n","urlObject":{"protocol":"http","port":"8080","path":["Spring_POS_API","api","v1","items"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"6c0f2f58-2314-4d07-b01b-bbc62a4efa3e","name":"get all items","originalRequest":{"method":"GET","header":[],"url":"http://localhost:8080/Spring_POS_API/api/v1/items"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Sat, 05 Oct 2024 16:36:51 GMT"},{"key":"Keep-Alive","value":"timeout=20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"itemCode\": \"I001\",\n \"category\": \"soap\",\n \"unitPrice\": 180,\n \"qtyOnHand\": 50,\n \"registerDate\": [\n 2024,\n 10,\n 5\n ],\n \"expireDate\": [\n 2025,\n 10,\n 5\n ]\n },\n {\n \"itemCode\": \"I002\",\n \"category\": \"buiscut\",\n \"unitPrice\": 200,\n \"qtyOnHand\": 20,\n \"registerDate\": [\n 2024,\n 10,\n 5\n ],\n \"expireDate\": [\n 2025,\n 10,\n 5\n ]\n }\n]"}],"_postman_id":"9dd2e692-bd4c-455f-94c7-c4d6cf1a168b"},{"name":"delete item","id":"251b724c-b0f1-4eb4-ab5d-94184922630b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"http://localhost:8080/Spring_POS_API/api/v1/items/I001","description":"

This request is used to delete an item from the POS system. The endpoint requires the item ID as a path parameter. Upon successful execution, the API will remove the specified item’s record from the database.

This folder contains requests for managing inventory items in the POS system. These requests enable you to add new items, retrieve item details, update item information, and delete items from the inventory. This helps in maintaining an accurate inventory database.

\n","_postman_id":"d6076e8a-087f-4da1-b54b-9b40d5abaf84"},{"name":"Orders","item":[{"name":"place order","id":"db1aacb4-5d15-4a3e-a634-b5ba743173ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"customerId\": \"C003\",\r\n \"orderDetails\":[\r\n {\r\n \"itemCode\": \"I002\",\r\n \"qty\": 2,\r\n \"unitPrice\": 200.00\r\n },\r\n {\r\n \"itemCode\": \"I003\",\r\n \"qty\": 7,\r\n \"unitPrice\": 50.00\r\n }\r\n ],\r\n \"paymentMethod\": \"cash\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:8080/Spring_POS_API/api/v1/orders","description":"

This request is used to place a new order in the POS system. The endpoint accepts a JSON payload containing the customer ID, an array of order details (each with item ID, quantity, and unit price), and the payment method. Upon successful execution, the API will create a new order record in the database.

\n","urlObject":{"protocol":"http","port":"8080","path":["Spring_POS_API","api","v1","orders"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"37ef31ff-b17f-48d3-8416-cbcdc42189e7","name":"place order","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"customerId\": \"C002\",\r\n \"orderDetails\":[\r\n {\r\n \"itemCode\": \"I002\",\r\n \"qty\": 2,\r\n \"unitPrice\": 200.00\r\n },\r\n {\r\n \"itemCode\": \"I003\",\r\n \"qty\": 7,\r\n \"unitPrice\": 50.00\r\n }\r\n ],\r\n \"paymentMethod\": \"cash\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:8080/Spring_POS_API/api/v1/orders"},"status":"Created","code":201,"_postman_previewlanguage":"plain","header":[{"key":"Content-Length","value":"0"},{"key":"Date","value":"Mon, 07 Oct 2024 13:31:55 GMT"},{"key":"Keep-Alive","value":"timeout=20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"db1aacb4-5d15-4a3e-a634-b5ba743173ef"}],"id":"96ea6d7c-4ad4-4f41-acad-78c684ed9ba7","description":"

This folder includes requests for managing orders within the POS system. These requests allow you to place new orders, retrieve order details, and manage order-related information. This is crucial for processing sales and managing order records.

\n","_postman_id":"96ea6d7c-4ad4-4f41-acad-78c684ed9ba7"}]}