Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/CLINTONARMANDO/apiregistropendientes/llms.txt

Use this file to discover all available pages before exploring further.

The Catalogs API organizes products into service plans or offering bundles. A catalog represents a named service offering (such as a fiber internet plan or a camera installation kit) with a defined type. Products are linked to catalogs with quantities, making it easy to know what materials are required for a given service.
All endpoints require a valid Bearer token. Include Authorization: Bearer <token> in every request header.

​
Catalogs

​
List active catalogs

GET /api/catalogos Returns all catalogs where vigente = true. 
curl --request GET \
  --url 'https://your-api.example.com/api/catalogos' \
  --header 'Authorization: Bearer <token>'

​
Response fields

​
id
number
Unique catalog ID.
​
nombre
string
Catalog name (e.g., Plan Fibra 100 Mbps).
​
descripcion
string
Description of the service offering.
​
tipo
string
Service type. One of: INTERNET, CAMARAS, KIT, SERVICIO.
​
vigente
boolean
true if the catalog is active.

​
Create a catalog

POST /api/catalogos Creates a new service catalog entry.
​
nombre
string
required
Catalog name (e.g., Plan Fibra 100 Mbps).
​
descripcion
string
Description of what this catalog includes.
​
tipo
string
required
Service type. One of: INTERNET, CAMARAS, KIT, SERVICIO.
curl --request POST \
  --url 'https://your-api.example.com/api/catalogos' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "nombre": "Plan Fibra 100 Mbps",
    "descripcion": "Residential fiber internet plan up to 100 Mbps symmetric",
    "tipo": "INTERNET"
  }'

​
Update a catalog

PUT /api/catalogos/{id} Updates an existing catalog’s name, description, or type.
​
id
number
required
Numeric ID of the catalog to update.
All body fields from Create a catalog are accepted. 
curl --request PUT \
  --url 'https://your-api.example.com/api/catalogos/3' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "nombre": "Plan Fibra 200 Mbps",
    "descripcion": "Upgraded residential fiber plan up to 200 Mbps symmetric"
  }'

​
Delete a catalog

DELETE /api/catalogos/{id} Soft-deletes a catalog by setting vigente = false. Associated catalog-product entries are not automatically removed.
​
id
number
required
Numeric ID of the catalog to deactivate.
Deactivating a catalog does not remove its associated product entries. If the catalog is reactivated, those product links will still be present.
curl --request DELETE \
  --url 'https://your-api.example.com/api/catalogos/3' \
  --header 'Authorization: Bearer <token>'

​
Catalog products

Each catalog can have one or more products associated with it, along with the expected quantity of each. This defines the materials needed to deliver the service.

​
List products in a catalog

GET /api/catalogos/{catalogoId}/productos Returns all active product entries for a specific catalog.
​
catalogoId
number
required
Numeric ID of the catalog.
curl --request GET \
  --url 'https://your-api.example.com/api/catalogos/3/productos' \
  --header 'Authorization: Bearer <token>'

​
Response fields

​
id
number
Catalog-product link ID.
The parent catalog.
​
producto
object
The associated product. See ProductoResponse for field details.
​
cantidad
number
Expected quantity of this product for the service.

​
Add a product to a catalog

POST /api/catalogos/productos Associates a product with a catalog and specifies the required quantity.
​
catalogoId
number
required
ID of the catalog to add the product to.
​
productoId
number
required
ID of the product to associate.
​
cantidad
number
required
Expected quantity of this product for one instance of the service.
Use this to define a standard material list for each service plan. For example, a fiber installation plan might require 1 router, 2 patch cables, and 1 ONT device.
curl --request POST \
  --url 'https://your-api.example.com/api/catalogos/productos' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "catalogoId": 3,
    "productoId": 7,
    "cantidad": 1
  }'

​
Update a catalog product entry

PUT /api/catalogos/productos/{id} Updates the quantity (or other fields) of an existing catalog-product link.
​
id
number
required
Numeric ID of the catalog-product link to update.
​
cantidad
number
Updated quantity.
curl --request PUT \
  --url 'https://your-api.example.com/api/catalogos/productos/12' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "cantidad": 2
  }'

​
Remove a product from a catalog

DELETE /api/catalogos/productos/{id} Removes the association between a product and a catalog. This is a permanent removal (not a soft delete) of the link, not the product itself.
​
id
number
required
Numeric ID of the catalog-product link to remove.
curl --request DELETE \
  --url 'https://your-api.example.com/api/catalogos/productos/12' \
  --header 'Authorization: Bearer <token>'

​
Enumerations

ValueDescription
INTERNETInternet service plans
CAMARASSecurity camera installation packages
KITEquipment kits
SERVICIOGeneral service offerings

Build docs developers (and LLMs) love

Get started for freeTalk to us