🏷️ Products API#
The Products API allows external systems to manage the product catalog used in UCS MiniPOS. It supports operations for listing, retrieving, creating, updating, and deleting products in the catalog. These products can be referenced when creating invoices, sales, or refunds.
📦 Request Structure Overview#
The Products API provides the following core operations:GET /api/products – Retrieve all products
GET /api/products/{id} – Get a specific product by ID
POST /api/products – Create a new product
PUT /api/products/{id} – Update an existing product
DELETE /api/products/{id} – Delete a product
🧩 Minimum and Optional Fields#
✅ Minimum Required Fields#
These are mandatory when creating a product:name – Name of the product
price – Price of the product, in format like 1.00 (two decimal places)
⚙️ Optional Fields for Full Control#
code – Item’s code used for quick access from GUI
is_free_price – If true, allows the operator to manually adjust the product's price at the POS
is_weight – If true, marks the product as weightable (POS may auto-call scales)
default_quantity – Quantity that is automatically added when the product button is pressed (unless operator specifies otherwise)
payload – Free field for integrators to store their own internal data
info – Adds printable elements (text or barcodes) beneath the product on the receipt
no_discount – If true, the product is marked as non-discountable
category – Category ID the product belongs to
fiscal_section – Fiscal section ID (allowed values: 1–20)
tax – Tax group ID. Allowed values: 0 (default), 1, 2, 3, 5
barcodes – An array of barcode values associated with the product
addons – An array of product IDs that will be automatically added when this product is added
📘 GET Products List#
Returns a list of all available products. Each product includes fields like:flags like is_free_price, is_weight, no_discount
quantities and category/fiscal/tax info
internal fields like payload, info, and timestamps
🔍 GET Product by ID#
Returns full details about a specific product using its ID.
➕ Create New Product#
Creates a new product entry using the minimum required fields or extended structure for full control (see above).
🛠️ Update Product#
Updates an existing product by ID. You can change any supported fields using the same format as during creation.
❌ Delete Product#
Deletes a product from the catalog.204 No Content if successful
404 Not Found if the product does not exist
Modified at 2026-04-15 12:52:15
