Crear establecimiento

Registra un nuevo establecimiento en el sistema. Incluye datos de ubicación, contacto y información del local comercial.

Entorno

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

Endpoint

POST /establecimientos

Ejemplo de solicitud

curl -X POST "https://api.guarani.app/establecimientos" \
  -H "Content-Type: application/json" \
  -H "x-api-key: Bearer <access_token>" \
  -d '{
    "numero_establecimiento": "001",
    "nombre": "Matriz",
    "direccion": "Avda. Principal esq. 1ra",
    "numero_casa": "",
    "ciudad_id": "67ef2e9f-0fa7-43e7-ad5e-87a694e56341",
    "barrio": "Centro",
    "whatsapp": "+595981234567"
  }' | 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.

---

Encabezados de la Solicitud

Encabezado	Valor	Descripción
Content-Type	application/json	Indica que los datos se envían en formato JSON.
x-api-key	Bearer <access_token>	Token de autenticación necesario para acceder al recurso.

Descripción de Campos

Parámetro	Tipo	Requerido	Tamaño	Descripción
numero_establecimiento	string	Sí	3	Número secuencial que identifica al establecimiento. Debe ser único globalmente.
nombre	string	Sí	100	Nombre del establecimiento. Ej: “Matriz”, “Sucursal Central”, etc.
direccion	string	No	100	Dirección física donde se ubica el establecimiento.
barrio	string	No	-	Nombre del barrio en el cual se encuentra el establecimiento.
numero_casa	string	No	-	Número de casa, bloque o unidad correspondiente al domicilio.
ciudad_id	uuid	Sí	36	Identificador único de la ciudad. (ver ciudades)
whatsapp	string	No	15	Número de WhatsApp del establecimiento. (ej. +595xxxxxxxxx)

Ejemplo de respuesta

{
  "success": true,
  "codigo": "201",
  "message": "Recurso creado con éxito.",
  "data": {
    "id": "077abfe5-45a5-41c6-a82c-88ef8e8a2679",
    "numero_establecimiento": "001",
    "nombre": "Matriz",
    "direccion": "Avda. Principal esq. 1ra",
    "barrio": "Centro",
    "numero_casa": "0",
    "whatsapp": "+595981234567",
    "ciudad": {
      "id": "67ef2e9f-0fa7-43e7-ad5e-87a694e56341",
      "codigo_sifen": "3556",
      "nombre": "SANTA RITA"
    }
  }
}

Descripción de campos de respuesta

Campos principales

Campo	Tipo	Descripción
id	uuid	Identificador único del establecimiento creado.
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.

Recursos adicionales

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