Obtener una lista de las mercaderías
Lista todas las mercaderías registradas en el sistema de forma paginada. Permite gestionar y visualizar las mercaderías.
Entorno
Sección titulada «Entorno»URL Base: https://api.guarani.app
Endpoint
Sección titulada «Endpoint»GET /mercaderias?page=1&limit=100Ejemplo de solicitud
Sección titulada «Ejemplo de solicitud»curl -X GET "https://api.guarani.app/mercaderias?page=1&limit=100" \ -H "x-api-key: Bearer <access_token>" \ -H "Accept: application/json" | jqNota: Asegúrate de reemplazar
<access_token>con un token JWT válido proporcionado por el equipo Guarani.
Importante:
Es imprescindible incluir un token de acceso válido en el encabezadox-api-keypara autenticar y autorizar el uso de este endpoint. Sin este token, la solicitud será rechazada.
Parámetros de consulta
Sección titulada «Parámetros de consulta»| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
page | integer | No | Número de página. Por defecto: 1. |
limit | integer | No | Resultados por página. Por defecto: 100 |
Encabezados de la solicitud
Sección titulada «Encabezados de la solicitud»| Encabezado | Valor | Descripción |
|---|---|---|
x-api-key | Bearer <access_token> | Token de autenticación necesario para acceder al recurso. |
Accept | application/json | Indica que la respuesta debe devolverse en formato JSON. |
Ejemplo de respuesta
Sección titulada «Ejemplo de respuesta»{ "success": true, "codigo": "200", "message": "Operación realizada correctamente.", "data": [ { "id": "ejemplo-uuid-mercaderia-123", "codigo_original": "CODIGO ORIGINAL DE EJEMPLO", "codigo_fabricante": "CODIGO FABRICANTE DE EJEMPLO", "codigo_interno": "01-1234567", "codigo_barra": "CODIGO DE BARRAS DE EJEMPLO", "descripcion": "FILTRO DE LINEA SATELLITE A-R05", "descripcion_larga": "DESCRIPCION LARGA DE EJEMPLO", "observacion": "OBSERVACION DE EJEMPLO", "imagen_url": null, "unidades": { "unidad_medida_compra": { "id": "5f49c6c1-d622-4f5b-9d8b-2d1636b584ab", "codigo_sifen": "77", "representacion": "UNI", "descripcion": "Unidad" }, "factor_conversion": 1, "unidad_medida_venta": { "id": "5f49c6c1-d622-4f5b-9d8b-2d1636b584ab", "codigo_sifen": "77", "representacion": "UNI", "descripcion": "Unidad" } }, "marca": { "id": "00000000-0000-4000-8000-000000000000", "nombre": "Sin definir" }, "clasificacion": { "id": "00000000-0000-4000-8000-000000000000", "codigo": "99", "nombre": "Sin definir" }, "precios": [ { "precio_unitario": { "0": 7000, "5": 0, "10": 3300 }, "moneda": "PYG", "establecimiento_id": "ejemplo-uuid-establecimiento-123" } ] } ], "pagination": { "total_registros": 1, "pagina": 1, "total_paginas": 1 }}Descripción de Campos de Respuesta
Sección titulada «Descripción de Campos de Respuesta»Campos principales
Sección titulada «Campos principales»| Campo | Tipo | Descripción |
|---|---|---|
id | uuid | Identificador único de la mercadería. |
codigo_interno | string | Código interno de la mercadería. |
codigo_original | string | Código original del proveedor o fabricante. |
codigo_fabricante | string | Código asignado por el fabricante. |
codigo_barra | string | Código de barras del producto. |
descripcion | string | Descripción corta de la mercadería. |
descripcion_larga | string | Descripción detallada de la mercadería. |
observacion | string | Observaciones adicionales sobre la mercadería. |
imagen_url | string | URL de la imagen del producto en Firebase Storage. |
unidades | objeto | Información de unidades de medida y factor de conversión. |
marca | objeto | Información de la marca de la mercadería. |
clasificacion | objeto | Información de la clasificación de la mercadería. |
precios | array | Lista de precios por establecimiento y moneda. |
Campos de unidades
Sección titulada «Campos de unidades»| Campo | Tipo | Descripción |
|---|---|---|
unidad_medida_compra | objeto | Unidad de medida para compras. |
factor_conversion | number | Factor de conversión entre unidad de compra y venta. |
unidad_medida_venta | objeto | Unidad de medida para ventas. |
Campos de unidad de medida
Sección titulada «Campos de unidad de medida»| Campo | Tipo | Descripción |
|---|---|---|
id | uuid | Identificador único de la unidad de medida. |
codigo_sifen | string | Código de la unidad según el catálogo SIFEN. |
representacion | string | Representación corta de la unidad (ej: “UNI”). |
descripcion | string | Descripción de la unidad de medida. |
Campos de marca
Sección titulada «Campos de marca»| Campo | Tipo | Descripción |
|---|---|---|
id | uuid | Identificador único de la marca. |
nombre | string | Nombre de la marca. |
Campos de clasificacion
Sección titulada «Campos de clasificacion»| Campo | Tipo | Descripción |
|---|---|---|
id | uuid | Identificador único de la clasificación. |
codigo | string | Código de la clasificación. |
nombre | string | Nombre de la clasificación. |
Campos de precios
Sección titulada «Campos de precios»| Campo | Tipo | Descripción |
|---|---|---|
precio_unitario | objeto | Precios según tipo de IVA (0%, 5%, 10%). |
moneda | string | Código de moneda (ej: “PYG”, “USD”). |
establecimiento_id | uuid | ID del establecimiento donde aplica el precio. |
Campos de paginación
Sección titulada «Campos de paginación»| Campo | Tipo | Descripción |
|---|---|---|
total_registros | number | Cantidad total de mercaderías en el sistema. |
pagina | number | Número de página actual. |
total_paginas | number | Cantidad total de páginas disponibles. |
Recursos adicionales
Sección titulada «Recursos adicionales»Para más información sobre posibles errores y cómo manejarlos, consulta errores.