{"info":{"_postman_id":"defe2d89-6fbe-49d1-bf14-3a62b858ce96","name":"Spring-POS","description":"

StartFragmentThe Spring POS API is a robust RESTful API designed to serve the front end of a Point of Sale (POS) system. Built using the Spring Framework, this API facilitates seamless interaction between the client application and the server, allowing for efficient management of customers, items, and orders.EndFragment

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"35384500","collectionId":"defe2d89-6fbe-49d1-bf14-3a62b858ce96","publishedId":"2sAXxV7Vvw","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-10-17T15:17:37.000Z"},"item":[{"name":"customer","item":[{"name":"save customer","event":[{"listen":"test","script":{"id":"d5496be6-753d-4f5b-9988-3cfe3d699858","exec":[""],"type":"text/javascript","packages":{}}}],"id":"aa69ad71-545d-47eb-9e0c-ebecf3d0ac85","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Charaka Gamage\",\r\n \"email\": \"charakamihiranga@gmail.com\",\r\n \"address\": \"Deniyaya\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:8080/springpos/api/v1/customer","description":"

POST /springpos/api/v1/customer

This endpoint is used to create a new customer in the system.

Request Body

name: (text) The name of the customer.
\n
email: (text) The email address of the customer.
\n
address: (text) The address of the customer.
\n

Response

The response for this request is in text/xml format with a status code of 201 (Created). However, the response body is null.

JSON Schema

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"status\": {\n      \"type\": \"number\"\n    },\n    \"content-type\": {\n      \"type\": \"string\"\n    },\n    \"data\": {\n      \"type\": \"null\"\n    }\n  }\n}\n\n

\n","urlObject":{"protocol":"http","port":"8080","path":["springpos","api","v1","customer"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"aa69ad71-545d-47eb-9e0c-ebecf3d0ac85"},{"name":"update customer","id":"0c072e68-aa87-4334-a689-09f8fd219784","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Charaka Gamage\",\r\n \"email\": \"charakamihiranga123@gmaail.com\",\r\n \"address\": \"Deniyaya\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:8080/springpos/api/v1/customer/CUS-0c761478-3fe4-4968-8621-d5ae64f8135f","urlObject":{"protocol":"http","port":"8080","path":["springpos","api","v1","customer","CUS-0c761478-3fe4-4968-8621-d5ae64f8135f"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"0c072e68-aa87-4334-a689-09f8fd219784"},{"name":"delete customer","id":"a1e6a749-f0e6-41b6-b8db-cb401f2ae123","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"http://localhost:8080/springpos/api/v1/customer/CUS-e0bcdca8-c514-4f5d-9004-325c7348361d","description":"

Delete Customer

This endpoint is used to delete a specific customer by their ID.

Request Body

This request does not require a request body.

Response

Status: 204
\n
Content-Type: text/xml
\n

\n","urlObject":{"protocol":"http","port":"8080","path":["springpos","api","v1","customer","CUS-e0bcdca8-c514-4f5d-9004-325c7348361d"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"a1e6a749-f0e6-41b6-b8db-cb401f2ae123"},{"name":"get customer by id","id":"ef465c5c-93d5-4923-8f3f-8335bbd77fda","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:8080/springpos/api/v1/customer/CUS-d9d16bff-a215-4acf-9aff-fda00f5edf19","description":"

The endpoint retrieves information about a specific customer using the customer ID in the URL. The response returned is a JSON object with the following schema:

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"id\": {\n      \"type\": \"string\"\n    },\n    \"name\": {\n      \"type\": \"string\"\n    },\n    \"email\": {\n      \"type\": \"string\"\n    },\n    \"address\": {\n      \"type\": \"string\"\n    },\n    \"createdAt\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"type\": \"number\"\n      }\n    },\n    \"updatedAt\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"type\": \"number\"\n      }\n    }\n  }\n}\n\n

\n","urlObject":{"protocol":"http","port":"8080","path":["springpos","api","v1","customer","CUS-d9d16bff-a215-4acf-9aff-fda00f5edf19"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"ef465c5c-93d5-4923-8f3f-8335bbd77fda"},{"name":"get all customers","id":"3c7e5a26-a832-47d2-a84a-2a9d405e0f3e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:8080/springpos/api/v1/customer","description":"

Retrieve Customer Information

This endpoint retrieves a list of customer information.

Request

Method: GET
\n
URL: http://localhost:8080/springpos/api/v1/customer
\n

Response

The response is a JSON array containing customer objects with the following properties:

id (string): The unique identifier of the customer.
\n
name (string): The name of the customer.
\n
email (string): The email address of the customer.
\n
address (string): The address of the customer.
\n
createdAt (array): An array representing the creation timestamp of the customer record.
\n
updatedAt (string): The timestamp representing when the customer record was last updated.
\n

Example Response:

[\n    {\n        \"id\": \"\",\n        \"name\": \"\",\n        \"email\": \"\",\n        \"address\": \"\",\n        \"createdAt\": [0],\n        \"updatedAt\": [0]\n    }\n]\n\n

JSON Schema

{\n    \"type\": \"array\",\n    \"items\": {\n        \"type\": \"object\",\n        \"properties\": {\n            \"id\": {\n                \"type\": \"string\"\n            },\n            \"name\": {\n                \"type\": \"string\"\n            },\n            \"email\": {\n                \"type\": \"string\"\n            },\n            \"address\": {\n                \"type\": \"string\"\n            },\n            \"createdAt\": {\n                \"type\": \"array\",\n                \"items\": {\n                    \"type\": \"number\"\n                }\n            },\n            \"updatedAt\": {\n                 \"type\": \"array\",\n                \"items\": {\n                    \"type\": \"number\"\n                }\n\n            }\n        }\n    }\n}\n\n

\n","urlObject":{"protocol":"http","port":"8080","path":["springpos","api","v1","customer"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"3c7e5a26-a832-47d2-a84a-2a9d405e0f3e"}],"id":"fb481596-b725-4789-8370-3f8f625d3f06","_postman_id":"fb481596-b725-4789-8370-3f8f625d3f06","description":""},{"name":"item","item":[{"name":"save item","id":"1a38f5b8-4b77-4fc7-a2c9-fb8b457adc0c","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"itemName","value":"Keyboard","type":"text"},{"key":"desc","value":"Wireless Keyboard","type":"text"},{"key":"price","value":"2000.00","type":"text"},{"key":"qtyOnHand","value":"100","type":"text"},{"key":"itemPic","type":"file","src":"postman-cloud:///1ef8bb62-2655-4630-b6d7-92c95fc31a09"}]},"url":"http://localhost:8080/springpos/api/v1/item","description":"

POST /springpos/api/v1/item

This endpoint is used to create a new item in the system.

Request Body

itemName (text): The name of the item.
\n
desc (text): The description of the item.
\n
price (text): The price of the item.
\n
qtyOnHand (text): The quantity of the item available.
\n
itemPic (file): The picture of the item.
\n

Response

The response for this request is not available at the moment.

JSON Schema

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"status\": {\n      \"type\": \"number\"\n    },\n    \"Content-Type\": {\n      \"type\": \"string\"\n    },\n    \"data\": {\n      \"type\": \"null\"\n    }\n  }\n}\n\n

\n","urlObject":{"protocol":"http","port":"8080","path":["springpos","api","v1","item"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"1a38f5b8-4b77-4fc7-a2c9-fb8b457adc0c"},{"name":"update item","id":"371e8391-bd0a-4174-9906-5c3177a107c0","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"PATCH","header":[],"body":{"mode":"formdata","formdata":[{"key":"itemName","value":"Wireless Mouse","type":"text"},{"key":"desc","value":"High precision wireless mouse","type":"text"},{"key":"price","value":"5000.00","type":"text"},{"key":"qtyOnHand","value":"200","type":"text"},{"key":"itemPic","type":"file","src":"postman-cloud:///1ef8bb62-2655-4630-b6d7-92c95fc31a09"}]},"url":"http://localhost:8080/springpos/api/v1/item/ITEM-89035955-de1f-458a-ad6a-e1cdbd84473f","description":"

PATCH /springpos/api/v1/item/ITEM-1301bf6a-aa8c-4423-93d6-c5f38a24fb32

This endpoint is used to update an existing item in the system.

Request Body

itemName (text): The name of the item.
\n
desc (text): The description of the item.
\n
price (text): The price of the item.
\n
qtyOnHand (text): The quantity of the item available.
\n
itemPic (file): The picture of the item.
\n

Response

status (number): The status code of the response.
\n
Content-Type (string): The type of content in the response.
\n
data (null): The data returned in the response.
\n

JSON Schema

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"status\": {\n      \"type\": \"number\"\n    },\n    \"Content-Type\": {\n      \"type\": \"string\"\n    },\n    \"data\": {\n      \"type\": \"null\"\n    }\n  }\n}\n\n

\n","urlObject":{"protocol":"http","port":"8080","path":["springpos","api","v1","item","ITEM-89035955-de1f-458a-ad6a-e1cdbd84473f"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"371e8391-bd0a-4174-9906-5c3177a107c0"},{"name":"delete item","id":"79f3e2ee-2f27-4ad8-abb6-489f450e7686","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"http://localhost:8080/springpos/api/v1/item/ITEM-89035955-de1f-458a-ad6a-e1cdbd84473f","description":"

The API endpoint sends an HTTP DELETE request to delete the item with the specified ID. Upon successful deletion, the server returns a 204 status code with a content type of text/xml. As per the user's request, the response can be documented as a JSON schema.

\n","urlObject":{"protocol":"http","port":"8080","path":["springpos","api","v1","item","ITEM-89035955-de1f-458a-ad6a-e1cdbd84473f"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"79f3e2ee-2f27-4ad8-abb6-489f450e7686"},{"name":"get item by code","id":"65b99789-5933-4b7c-bed7-61790b784ce4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:8080/springpos/api/v1/item/ITEM-47c14676-c060-4e45-a6c4-b5d8c954ed8b","description":"

GET /springpos/api/v1/item/ITEM-1301bf6a-aa8c-4423-93d6-c5f38a24fb32

This endpoint retrieves details of a specific item.

Request

No request body parameters.

Response

The response will be in JSON format and will have the following schema:

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"code\": {\n      \"type\": \"string\"\n    },\n    \"name\": {\n      \"type\": \"string\"\n    },\n    \"itemPic\": {\n      \"type\": \"string\"\n    },\n    \"description\": {\n      \"type\": \"string\"\n    },\n    \"price\": {\n      \"type\": \"number\"\n    },\n    \"qtyOnHand\": {\n      \"type\": \"number\"\n    },\n    \"createdAt\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"type\": \"number\"\n      }\n    },\n    \"updatedAt\": {\n      \"type\": [\"array\", \"null\"]\n    }\n  }\n}\n\n

\n","urlObject":{"protocol":"http","port":"8080","path":["springpos","api","v1","item","ITEM-47c14676-c060-4e45-a6c4-b5d8c954ed8b"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"65b99789-5933-4b7c-bed7-61790b784ce4"},{"name":"get all items","id":"b25b5d75-1ff6-4b4f-b77b-0758a928bbbe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:8080/springpos/api/v1/item/allitems","description":"

Retrieve All Items

This endpoint retrieves a list of all items.

Request Body

This request does not require a request body.

Response Body

The response will be a JSON array containing objects with the following properties:

code (string): The code of the item.
\n
name (string): The name of the item.
\n
itemPic (string): The URL of the item's picture.
\n
description (string): The description of the item.
\n
price (number): The price of the item.
\n
qtyOnHand (number): The quantity of the item on hand.
\n
createdAt (array): The timestamp of when the item was created.
\n
updatedAt (null): The timestamp of when the item was last updated.
\n

[\n    {\n        \"code\": \"\",\n        \"name\": \"\",\n        \"itemPic\": \"\",\n        \"description\": \"\",\n        \"price\": 0,\n        \"qtyOnHand\": 0,\n        \"createdAt\": [0],\n        \"updatedAt\": null\n    }\n]\n\n

\n","urlObject":{"protocol":"http","port":"8080","path":["springpos","api","v1","item","allitems"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"b25b5d75-1ff6-4b4f-b77b-0758a928bbbe"}],"id":"d6eaae31-e9f4-44c7-baa5-373b2d27cd7a","_postman_id":"d6eaae31-e9f4-44c7-baa5-373b2d27cd7a","description":""},{"name":"order","item":[{"name":"save order","id":"369443b2-c8bb-4b1b-922b-3363608c90ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"customerId\": \"CUS-d9d16bff-a215-4acf-9aff-fda00f5edf19\",\r\n \"orderDetailDtos\": [\r\n {\r\n \"itemCode\": \"ITEM-47c14676-c060-4e45-a6c4-b5d8c954ed8b\",\r\n \"qty\": 3,\r\n \"unitPrice\": 7000.00\r\n },\r\n {\r\n \"itemCode\": \"ITEM-c8287d83-09b9-4e15-bb5d-8cce5c04cca2\",\r\n \"qty\": 1,\r\n \"unitPrice\": 2000.00\r\n }\r\n ],\r\n \"totalAmount\": 23000.00,\r\n \"paidAmount\": 25000.00,\r\n \"discount\": 2000.00,\r\n \"balance\": 4000.00\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"http://localhost:8080/springpos/api/v1/orders","description":"

POST /springpos/api/v1/orders

This endpoint is used to create a new order.

Request Body

customerId (string, required): The ID of the customer placing the order.
\n
orderDetailDtos (array, required): An array of objects containing details of each item in the order.
\n
- itemCode (string, required): The code of the item being ordered.
  \n
- qty (integer, required): The quantity of the item being ordered.
  \n
- unitPrice (integer, required): The unit price of the item being ordered.
  \n
\n
totalAmount (integer, required): The total amount of the order.
\n
paidAmount (integer, required): The amount paid by the customer.
\n
discount (integer, required): The discount applied to the order.
\n
balance (integer, required): The remaining balance to be paid.
\n

Response

The response for this request is in text/xml format and does not contain any specific data. To document the response as a JSON schema, further details about the response structure and data types are required.

\n","urlObject":{"protocol":"http","port":"8080","path":["springpos","api","v1","orders"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"369443b2-c8bb-4b1b-922b-3363608c90ce"},{"name":"get order by id","id":"78844486-afc2-4c0b-aa0b-9f2e738732ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:8080/springpos/api/v1/orders/2","description":"

GET /springpos/api/v1/orders/2

This endpoint retrieves the details of a specific order.

Request

There are no request parameters for this endpoint.

Response

The response will be in JSON format with the following schema:

{\n  \"id\": \"number\",\n  \"customerId\": \"string\",\n  \"orderDetailDtos\": [\n    {\n      \"id\": \"number\",\n      \"itemEntity\": {\n        \"code\": \"string\",\n        \"name\": \"string\",\n        \"itemPic\": \"string\",\n        \"description\": \"string\",\n        \"price\": \"number\",\n        \"qtyOnHand\": \"number\"\n      },\n      \"qty\": \"number\",\n      \"unitPrice\": \"number\"\n    }\n  ],\n  \"totalAmount\": \"number\",\n  \"paidAmount\": \"number\",\n  \"discount\": \"number\",\n  \"balance\": \"number\",\n  \"createdAt\": \"string\"\n}\n

\n","urlObject":{"protocol":"http","port":"8080","path":["springpos","api","v1","orders","2"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"78844486-afc2-4c0b-aa0b-9f2e738732ce"},{"name":"get all orders","id":"cb4cf2b3-9a95-42b3-835f-3f5f50f81946","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:8080/springpos/api/v1/orders","description":"

Get Orders

This endpoint makes an HTTP GET request to retrieve a list of orders.

Request

Method: GET
\n
URL: http://localhost:8080/springpos/api/v1/orders
\n

Response

The response will be in JSON format and will include an array of order objects. Each order object contains the following fields:

id (number): The unique identifier for the order.
\n
customerEntity (object): Details of the customer associated with the order, including id, name, email, and address.
\n
orderDetailEntities (array): An array of order details, each containing id, itemEntity (with code, name, itemPic, description, price, and qtyOnHand), qty, and unitPrice.
\n
totalAmount (number): The total amount for the order.
\n
paidAmount (number): The amount paid for the order.
\n
discount (number): The discount applied to the order.
\n
balance (number): The remaining balance for the order.
\n
createdAt (array): The timestamp of when the order was created.
\n

Example Response:

[\n    {\n        \"id\": 0,\n        \"customerEntity\": {\n            \"id\": \"\",\n            \"name\": \"\",\n            \"email\": \"\",\n            \"address\": \"\"\n        },\n        \"orderDetailEntities\": [\n            {\n                \"id\": 0,\n                \"itemEntity\": {\n                    \"code\": \"\",\n                    \"name\": \"\",\n                    \"itemPic\": \"\",\n                    \"description\": \"\",\n                    \"price\": 0,\n                    \"qtyOnHand\": 0\n                },\n                \"qty\": 0,\n                \"unitPrice\": 0\n            }\n        ],\n        \"totalAmount\": 0,\n        \"paidAmount\": 0,\n        \"discount\": 0,\n        \"balance\": 0,\n        \"createdAt\": [0]\n    }\n]\n\n

\n","urlObject":{"protocol":"http","port":"8080","path":["springpos","api","v1","orders"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"cb4cf2b3-9a95-42b3-835f-3f5f50f81946"}],"id":"8a3da154-9c3a-4de5-a1a8-401d04c13777","_postman_id":"8a3da154-9c3a-4de5-a1a8-401d04c13777","description":""},{"name":"health check","id":"2d5170db-3429-4926-aaf0-6c8787ab65ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:8080/springpos/api/v1/healthCheck","description":"

The GET request to /healthCheck endpoint is used to check the health status of the Spring POS API.

Response

The response returned is a text/plain content with a status code of 200. The response body contains a message indicating the status of the Spring POS API.

Response Body

The response body is a plain text message:

{\n  \"message\": \"Spring POS API is running\"\n}\n\n

\n","urlObject":{"protocol":"http","port":"8080","path":["springpos","api","v1","healthCheck"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"ff1b0c02-047d-4d3d-8616-639732caf49d","name":"health check","originalRequest":{"method":"GET","header":[],"url":"http://localhost:8080/springpos/api/v1/healthCheck"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"2d5170db-3429-4926-aaf0-6c8787ab65ec"}]}