Buscar establecimientos

Busca establecimientos en el sistema usando criterios específicos. Útil para encontrar establecimientos por nombre, número o ubicación.

---

Entorno

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

Endpoint

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

Ejemplo de solicitud

curl -X GET "https://api.guarani.app/establecimientos/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: 100

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": "06dabe45-cbb5-425e-b1c3-13a67d7114e0",
      "numero_establecimiento": "001",
      "nombre": "Matriz",
      "direccion": "Plaza Sinuelo 2",
      "barrio": "Sinuelo 2",
      "numero_casa": "0",
      "whatsapp": "+595983055940",
      "ciudad": {
        "id": "a5e7b9e0-a5c1-43c0-b03b-0421888e2079",
        "codigo_sifen": "1",
        "nombre": "ASUNCION (DISTRITO)",
        "distrito": {
          "id": "a6648dd2-96c7-4cd1-ad8e-91e7f64fcea9",
          "nombre": "ASUNCION (DISTRITO)",
          "codigo_sifen": "1",
          "departamento": {
            "id": "40b24d7a-28b1-4fee-87da-a10e01bd8bfc",
            "nombre": "CAPITAL",
            "codigo_sifen": "1"
          }
        }
      }
    }
  ],
  "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 del establecimiento.
numero_establecimiento	string	Número que identifica al establecimiento.
nombre	string	Nombre del establecimiento.
direccion	string	Dirección física del establecimiento.
barrio	string	Nombre del barrio donde se encuentra el establecimiento.
numero_casa	string	Número de casa o edificio.
whatsapp	string	Número de WhatsApp del establecimiento en formato internacional.
ciudad	objeto	Información de la ciudad donde se ubica el establecimiento.

Campos de ciudad

Campo	Tipo	Descripción
id	uuid	Identificador único de la ciudad.
codigo_sifen	string	Código de la ciudad según el catálogo SIFEN.
nombre	string	Nombre de la ciudad.
distrito	objeto	Información del distrito.

Campos de distrito

Campo	Tipo	Descripción
id	uuid	Identificador único del distrito.
nombre	string	Nombre del distrito.
codigo_sifen	string	Código del distrito según el catálogo SIFEN.
departamento	objeto	Información del departamento.

Campos de departamento

Campo	Tipo	Descripción
id	uuid	Identificador único del departamento.
nombre	string	Nombre del departamento.
codigo_sifen	string	Código del departamento según el catálogo SIFEN.

Campos de paginación

Campo	Tipo	Descripción
total_registros	number	Cantidad total de establecimientos 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 y cómo manejarlos, consulta errores.