Buscar marcas

Busca marcas en el sistema usando criterios específicos. Útil para encontrar marcas por nombre o filtrar resultados.

---

Entorno

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

Endpoint

GET /marcas/search?q={query}&page=1&limit=100

Ejemplo de solicitud

curl -X GET "https://api.guarani.app/marcas/search?q={query}&page=1&limit=100" \
  -H "x-api-key: Bearer <access_token>" \
  -H "Accept: application/json" | jq

Nota: Asegúrate de reemplazar {query} por el parametro a buscar y <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ámetros de ruta

Parámetro	Tipo	Requerido	Descripción
query	string	Sí	Parámetro de busqueda.
page	integer	No	Número de página. Por defecto: 1.
limit	integer	No	Resultados por página. Por defecto: 10.

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

{
  "success": true,
  "codigo": "200",
  "message": "Operación realizada correctamente.",
  "data": [
    {
      "id": "dc25a120-d05a-43df-987f-c90e021b969a",
      "nombre": "PEPSI"
    }
  ],
  "pagination": {
    "total_registros": 1,
    "pagina": 1,
    "total_paginas": 1
  }
}

Descripción de Campos de Respuesta

Campos principales

Campo	Tipo	Descripción
id	uuid	Identificador único de la marca.
nombre	string	Nombre de la marca.

Campos de paginación

Campo	Tipo	Descripción
total_registros	number	Cantidad total de marcas que coinciden con la búsqueda.
pagina	number	Número de página actual.
total_paginas	number	Cantidad total de páginas disponibles.

Recursos adicionales

Para más información sobre posibles errores relacionados, consulta errores.