Saltearse al contenido

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.


URL Base: https://api.guarani.app

GET /mercaderias?page=1&limit=100
Ventana de terminal
curl -X GET "https://api.guarani.app/mercaderias?page=1&limit=100" \
-H "x-api-key: Bearer <access_token>" \
-H "Accept: application/json" | jq

Nota: 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 encabezado x-api-key para autenticar y autorizar el uso de este endpoint. Sin este token, la solicitud será rechazada.


ParámetroTipoRequeridoDescripción
pageintegerNoNúmero de página. Por defecto: 1.
limitintegerNoResultados por página. Por defecto: 100
EncabezadoValorDescripción
x-api-keyBearer <access_token>Token de autenticación necesario para acceder al recurso.
Acceptapplication/jsonIndica que la respuesta debe devolverse en formato JSON.
{
"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
}
}
CampoTipoDescripción
iduuidIdentificador único de la mercadería.
codigo_internostringCódigo interno de la mercadería.
codigo_originalstringCódigo original del proveedor o fabricante.
codigo_fabricantestringCódigo asignado por el fabricante.
codigo_barrastringCódigo de barras del producto.
descripcionstringDescripción corta de la mercadería.
descripcion_largastringDescripción detallada de la mercadería.
observacionstringObservaciones adicionales sobre la mercadería.
imagen_urlstringURL de la imagen del producto en Firebase Storage.
unidadesobjetoInformación de unidades de medida y factor de conversión.
marcaobjetoInformación de la marca de la mercadería.
clasificacionobjetoInformación de la clasificación de la mercadería.
preciosarrayLista de precios por establecimiento y moneda.
CampoTipoDescripción
unidad_medida_compraobjetoUnidad de medida para compras.
factor_conversionnumberFactor de conversión entre unidad de compra y venta.
unidad_medida_ventaobjetoUnidad de medida para ventas.
CampoTipoDescripción
iduuidIdentificador único de la unidad de medida.
codigo_sifenstringCódigo de la unidad según el catálogo SIFEN.
representacionstringRepresentación corta de la unidad (ej: “UNI”).
descripcionstringDescripción de la unidad de medida.
CampoTipoDescripción
iduuidIdentificador único de la marca.
nombrestringNombre de la marca.
CampoTipoDescripción
iduuidIdentificador único de la clasificación.
codigostringCódigo de la clasificación.
nombrestringNombre de la clasificación.
CampoTipoDescripción
precio_unitarioobjetoPrecios según tipo de IVA (0%, 5%, 10%).
monedastringCódigo de moneda (ej: “PYG”, “USD”).
establecimiento_iduuidID del establecimiento donde aplica el precio.
CampoTipoDescripción
total_registrosnumberCantidad total de mercaderías en el sistema.
paginanumberNúmero de página actual.
total_paginasnumberCantidad total de páginas disponibles.

Para más información sobre posibles errores y cómo manejarlos, consulta errores.