Las reglas recurrentes definen cómo se repite automáticamente una expedición en el tiempo (por ejemplo, todos los días o cada semana en días concretos). Este endpoint devuelve la regla de recurrencia asociada a una expedición.
GET https://api.app.vonzu.es/api/v2/recurrentRules?expeditionReference={referencia}
Cabeceras
secret-api-key: TU_API_KEY Authorization-Domain: TU_DOMINIO
Parámetros de consulta (query)
Parámetro | Tipo | Obligatorio | Descripción |
| string | Sí | Referencia de la expedición cuya regla de recurrencia querés obtener. |
Ejemplo de petición
curl --location 'https://api.app.vonzu.es/api/v2/recurrentRules?expeditionReference=Some-Expedition-Reference' \ --header 'secret-api-key: TU_API_KEY' \ --header 'Authorization-Domain: TU_DOMINIO'
Ejemplo de respuesta
{
"name": "Regla de ejemplo",
"start": "2022-12-01",
"end": "2023-01-01",
"periodicity": {
"type": "week",
"repeatNum": 1,
"executionCount": 0,
"repeatCount": 1,
"weekCount": 0,
"days": ["thursday"]
},
"service": {
"type": "delivery",
"clientUsername": "CLIENTENOTIF",
"address": { "...": "..." },
"origin": { "...": "..." },
"contact": { "...": "..." },
"schedules": [ ["00:30:00", "01:45:00"] ]
}
}
Estructura de la respuesta
Campo | Descripción |
| Nombre de la regla recurrente. |
| Fecha de inicio de la recurrencia. |
| Fecha de fin de la recurrencia. |
| Objeto que define cada cuánto se repite. Ver abajo. |
| Plantilla de la expedición que se genera en cada repetición (misma estructura que una expedición). |
Objeto periodicity
Campo | Tipo | Descripción |
| string | Unidad de repetición: |
| number | Cada cuántas unidades se repite (por ejemplo, cada 1 semana). |
| array de string | Días de la semana en los que aplica (por ejemplo |
| number | Número de ejecuciones realizadas. |
| number | Número de repeticiones previstas. |
| number | Contador de semanas (uso interno de la periodicidad semanal). |
El objeto service reproduce la estructura de una expedición (ver Crear una expedición): es la plantilla a partir de la cual se genera cada nueva expedición del ciclo.