API · zones
zones operations in the OpenAPI contract that accept an API key.
Updated:
Zonas (F1-38): grupos de personas con un área (barrios, ciudades o códigos postales), días y horas de atención y un tope opcional de tareas por franja. Lectura: todos los roles; escritura: owner y manager.
GET /zones
Listar zonas
- Authentication: API key or dashboard session
- Scopes: None
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
include_inactive | query | No | boolean default false |
Responses
| Status | Description |
|---|---|
200 | OK (object) |
default | Error (RFC 9457) (Problem) |
POST /zones
Crear una zona (owner/manager, CSRF)
- Authentication: API key or dashboard session
- Scopes: None
Request body (required)
application/json: ZoneInput
Responses
| Status | Description |
|---|---|
201 | Creada (Zone) |
422 | Error (RFC 9457) (Problem) |
default | Error (RFC 9457) (Problem) |
GET /zones/{id}
Leer una zona (activa o no)
- Authentication: API key or dashboard session
- Scopes: None
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | Yes | string |
Responses
| Status | Description |
|---|---|
200 | OK (Zone) |
404 | Error (RFC 9457) (Problem) |
default | Error (RFC 9457) (Problem) |
PATCH /zones/{id}
Editar una zona (owner/manager, CSRF)
- Authentication: API key or dashboard session
- Scopes: None
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | Yes | string |
Request body (required)
application/json: ZonePatch
Responses
| Status | Description |
|---|---|
200 | Actualizada (Zone) |
422 | Error (RFC 9457) (Problem) |
default | Error (RFC 9457) (Problem) |
DELETE /zones/{id}
Desactivar una zona (owner/manager, CSRF)
Una zona no se borra (las tareas la referencian): se desactiva y deja de asignarse y de limitar.
- Authentication: API key or dashboard session
- Scopes: None
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | Yes | string |
Responses
| Status | Description |
|---|---|
204 | Desactivada |
default | Error (RFC 9457) (Problem) |
GET /zones/coverage
Cobertura del negocio (unión de las zonas activas)
La cobertura es la unión de las zonas activas; sin zonas no hay límite (solo el país). Incluye qué hace el bot con una dirección fuera de cobertura. Todos los roles del panel y API keys config:read.
- Authentication: API key or dashboard session
- Scopes:
config:read
Responses
| Status | Description |
|---|---|
200 | OK (Coverage) |
default | Error (RFC 9457) (Problem) |
PUT /zones/coverage
Cambiar qué hace el bot fuera de cobertura (owner/manager, CSRF)
Aplica a una dirección fuera de todas las zonas y a una entrega (reach_zone_ids) que no llega a la zona de la dirección. take (default): el bot ofrece la entrega y toma el pedido, la tarea lleva la etiqueta fuera-de-cobertura y aparece en «Necesita tu atención». reject: el bot no ofrece esa entrega, responde que por ahora no llega a esa zona y no crea nada. Auditado (coverage.updated).
- Authentication: API key or dashboard session
- Scopes: None
Request body (required)
application/json: CoverageInput
Responses
| Status | Description |
|---|---|
200 | OK (Coverage) |
422 | Error (RFC 9457) (Problem) |
default | Error (RFC 9457) (Problem) |
GET /zones/match
Qué zona cubre un destino
Compara barrio, ciudad, código postal o dirección normalizados (sin tildes, mayúsculas ni signos). Prioridad: código postal (por prefijo), barrio, ciudad, provincia, país; ante varias gana la coincidencia más larga y luego el nombre. zone: null = sin zona (fuera de cobertura si el negocio tiene zonas).
- Authentication: API key or dashboard session
- Scopes: None
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
neighborhood | query | No | string | |
city | query | No | string | |
postal_code | query | No | string | |
address | query | No | string | |
lat | query | No | number | Latitud del destino; va junto con lng. Con coordenadas gana el área dibujada más chica que contiene el punto; sin coincidencia geométrica queda el respaldo por texto. |
lng | query | No | number | Longitud del destino; va junto con lat. |
Responses
| Status | Description |
|---|---|
200 | OK (object) |
default | Error (RFC 9457) (Problem) |