Skip to main content

Base URL

All product endpoints are prefixed with:
/api/v1/products

Available Endpoints

Create Product

Create a new product in the inventory

List Products

Retrieve all products with pagination

Update Prices

Bulk update product prices

Price History

View price change history for a product

Authentication

All product endpoints require authentication with role-based access control:
  • admin: Full access to all operations
  • gestor: Can create, update, and view products
  • consultor: Read-only access to product information

Product Schema

Products in the system have the following structure:
id
string
required
Unique identifier for the product (UUID format)
sku
string
required
Stock Keeping Unit - unique product code
name
string
required
Product name
description
string
Detailed product description
category
string
required
Product category for organization
unit_measure
string
required
Unit of measurement (e.g., “kg”, “liters”, “units”)
unit_value
number
required
Value per unit (default: 1.0)
is_perishable
boolean
required
Indicates if product has expiration date (default: false)
expiration_date
string
Expiration date for perishable products
suggested_price
number
required
Recommended selling price

Common Query Parameters

skip
integer
default:"0"
Number of records to skip for pagination
limit
integer
default:"100"
Maximum number of records to return

Build docs developers (and LLMs) love