Referencia de la APISucursales
Eliminar
Elimina una sucursal.
Descripcion general
Este endpoint realiza el borrado de la sucursal: a partir de ese momento deja de aparecer en GET /api/v1/branches y se trata como no encontrada en PATCH/DELETE (404). El borrado no es recursivo: si la sucursal tiene hijos vivos, la solicitud falla — primero debes eliminarlos o re-asignarlos a otro padre. Al eliminarla, la sucursal se desvincula de cada empleo que la referenciaba (su branch_code queda en null).
No se exige un permiso granular para este endpoint todavía: basta con que la API key sea válida y esté vinculada a la organización. La respuesta exitosa es 204 No Content con cuerpo vacío.
Endpoint
DELETE
https://app.integranom.com/api/v1/branches/{branch_number}Path param: branch_number — entero positivo, el número de sucursal dentro de la organización.
Comportamiento
- Marca la sucursal como eliminada.
- La fila deja de devolverse por
GET /api/v1/branches. - Rechaza la solicitud (
400) si la sucursal tiene hijos vivos — primero elimínalos o reasígnalos a otro padre con PATCH. - Desvincula la sucursal de cada empleo que la referenciaba: su
branch_codequeda ennull(misma transacción).
Errores
| Status | Causa |
|---|---|
400 | branch_number inválido en la URL, o la sucursal tiene hijos vivos. La respuesta incluye { "message": "Cannot delete a branch with live children. Delete or reparent them first." }. |
404 | La sucursal no existe o ya fue eliminada en esta organización. |