The POS Order Management API provides endpoints to handle order processing, customer management, and item management in a Point of Sale (POS) system. It allows users to create, view, and manage orders, customers, and items, including detailed information about each order, customer, and item.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"35384500","collectionId":"1a751899-1f33-499f-8880-161b7002ded8","publishedId":"2sA3s3GWG7","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-08-09T17:31:11.000Z"},"item":[{"name":"customer","item":[{"name":"save customer","id":"921d04c7-d585-45e2-9fb1-6f6541f29481","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\":\"C00-001\",\r\n \"name\":\"Mihiranga\",\r\n \"address\":\"Matara\",\r\n \"salary\":\"50000.00\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"http://localhost:8080/posSystem/customer","urlObject":{"protocol":"http","port":"8080","path":["posSystem","customer"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"921d04c7-d585-45e2-9fb1-6f6541f29481"},{"name":"update customer","id":"361af96f-5784-4076-bedd-f31893b4a972","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\":\"Charaka Mihiranga\",\r\n \"address\":\"Matara\",\r\n \"salary\":\"50000.00\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:8080/posSystem/customer?id=C00-001","description":"This endpoint allows the client to update the details of a specific customer.
\nMethod: PUT
\nURL: http://localhost:8080/posSystem/customer?id=C00-001
Headers:
\nParameters:
\nBody:
\nname (string, optional): The updated name of the customer
\naddress (string, optional): The updated address of the customer
\nsalary (string, optional): The updated salary of the customer
\nStatus: 204
\nContent-Type: text/xml
\nBody: null
\nThis endpoint is used to delete a customer from the Point of Sale (POS) system.
\nMethod: DELETE
\nURL: http://localhost:8080/posSystem/customer?id=C00-001
The response for this request is a 204 status code with no content.
\nThis request does not require a request body.
\n{}\n\nThe API endpoint retrieves customer details based on the provided ID.
\nThe response is in JSON format with the following schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"address\": {\n \"type\": \"string\"\n },\n \"id\": {\n \"type\": \"string\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"salary\": {\n \"type\": \"number\"\n }\n }\n}\n\nThis endpoint retrieves a list of customers from the point of sale system.
\nNo request body is required for this endpoint.
\nThe response will be a JSON array containing customer objects with the following properties:
\naddress (string): The address of the customer.
id (string): The unique identifier of the customer.
name (string): The name of the customer.
salary (number): The salary of the customer.
Example response:
\n[\n {\n \"address\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"salary\": 0\n }\n]\n\nThis endpoint is used to create a new item in the Point of Sale (POS) system.
\ncode (string, required): The unique code of the item.
name (string, required): The name of the item.
qty (string, required): The quantity of the item.
unitPrice (string, required): The unit price of the item.
The response of this request is a JSON object with the following schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"number\",\n \"description\": \"The status code of the response.\"\n },\n \"message\": {\n \"type\": \"string\",\n \"description\": \"A message indicating the result of the request.\"\n }\n }\n}\n\nRequest:
\n{\n \"code\": \"ABC123\",\n \"name\": \"Sample Item\",\n \"qty\": \"10\",\n \"unitPrice\": \"25.00\"\n}\n\nResponse:
\n{\n \"status\": 201,\n \"message\": \"Item saved successfully!\"\n}\n\nThe GET request retrieves information about a specific item from the Point of Sale system using the item code as a query parameter. The response is in JSON format and has the following schema:
{\n \"type\": \"object\",\n \"properties\": {\n \"code\": {\n \"type\": \"string\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"qty\": {\n \"type\": \"integer\"\n },\n \"unitPrice\": {\n \"type\": \"number\"\n }\n }\n}\n\nThis endpoint makes an HTTP GET request to retrieve the list of items from the POS system. The request does not include any request body parameters.
\nUpon a successful execution, the server responds with a status code of 200 and a JSON array containing the details of the items. Each item object includes the following properties:
\ncode: The code of the item.
name: The name of the item.
qty: The quantity of the item available.
unitPrice: The unit price of the item.
This endpoint is used to update the details of a specific item in the POS system.
\nname (string, required): The updated name of the item.
qty (string, required): The updated quantity of the item.
unitPrice (string, required): The updated unit price of the item.
Status: 204
\nContent-Type: text/xml
\nResponse Body: null
\nThis endpoint is used to delete a specific item from the POS system by providing the item code as a query parameter.
\nMethod: DELETE
\nEndpoint: http://localhost:8080/posSystem/item
Query Parameters:
\ncode: The code of the item to be deleted (e.g. I00-001)Status: 204
\nContent-Type: text/xml
\nBody: null
\nThis endpoint retrieves the details of a specific order identified by the orderId parameter.
\norderId (string, required): The unique identifier of the order.address (string): The address associated with the order.
balance (number): The remaining balance for the order.
customerId (string): The unique identifier of the customer associated with the order.
discount (number): The discount applied to the order.
orderDate (string): The date of the order.
orderDetails (array): An array of objects containing the details of the items in the order, including item code, name, price, order ID, quantity, and total cost.
itemCode (string): The code of the item.
itemName (string): The name of the item.
itemPrice (number): The price of the item.
orderId (string): The unique identifier of the order.
quantity (number): The quantity of the item in the order.
total (number): The total cost of the item in the order.
orderId (string): The unique identifier of the order.
paidAmount (number): The amount already paid for the order.
subTotal (number): The subtotal of the order.
total (number): The total cost of the order.
Example:
\n{\n \"address\": \"\",\n \"balance\": 0,\n \"customerId\": \"\",\n \"discount\": 0,\n \"orderDate\": \"\",\n \"orderDetails\": [\n {\n \"itemCode\": \"\",\n \"itemName\": \"\",\n \"itemPrice\": 0,\n \"orderId\": \"\",\n \"quantity\": 0,\n \"total\": 0\n }\n ],\n \"orderId\": \"\",\n \"paidAmount\": 0,\n \"subTotal\": 0,\n \"total\": 0\n}\n\nThis endpoint allows you to retrieve the details of orders from the point of sale system.
\nGET http://localhost:8080/posSystem/order
Upon a successful request, the server will respond with a status code of 200 and a JSON array containing the details of the orders. The response body includes the following fields for each order:
\naddress (string): The address associated with the order.
balance (number): The balance amount for the order.
customerId (string): The ID of the customer who placed the order.
discount (number): The discount applied to the order.
orderDate (string): The date of the order.
orderId (string): The unique identifier of the order.
paidAmount (number): The amount paid for the order.
subTotal (number): The subtotal amount for the order.
total (number): The total amount for the order.
Example response body:
\n[\n {\n \"address\": \"\",\n \"balance\": 0,\n \"customerId\": \"\",\n \"discount\": 0,\n \"orderDate\": \"\",\n \"orderId\": \"\",\n \"paidAmount\": 0,\n \"subTotal\": 0,\n \"total\": 0\n }\n]\n\nThis endpoint is used to create a new order in the POS system.
\norderId (string): The unique identifier for the order.
orderDate (string): The date of the order.
customerId (string): The unique identifier of the customer placing the order.
total (string): The total amount of the order.
subTotal (string): The subtotal amount of the order.
paidAmount (string): The amount paid by the customer.
discount (string): The discount applied to the order.
balance (string): The remaining balance to be paid.
address (string): The address for delivering the order.
orderDetails (array): An array of order details including:
orderId (string): The unique identifier for the order detail.
itemCode (string): The code of the item in the order.
itemName (string): The name of the item in the order.
itemPrice (string): The price of the item.
quantity (number): The quantity of the item in the order.
total (string): The total amount for the item in the order.
The response is a JSON object with the following schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"number\",\n \"description\": \"The status code of the response.\"\n },\n \"message\": {\n \"type\": \"string\",\n \"description\": \"A message indicating the result of the request.\"\n }\n }\n}\n\n{\n \"status\": 201,\n \"message\": \"Success\"\n}\n\n