Obtener resumen de necesidades por servicio

Este endpoint devuelve el resumen de las necesidades de un servicio para un día concreto.

GET /api/v1/businesses/{businessId}/services/{serviceId}/needs/summary/{yyyy-MM-dd}

En la URL de la petición, deben especificarse los siguientes parámetros:

Identificador externo del negocio (businessId).
Identificador externo del servicio o tienda (serviceId).
Fecha para la que se realiza la consulta yyyy-MM-dd.

Si los datos incluidos en la URL de la petición son correctos, la respuesta contendrá las necesidades del servicio con toda la información definida para ellas.

Ejemplo de respuesta

[
    {
        "service": "0001",
        "product": "0001-GENERAL",
        "zone": "ZG",
        "locationType": "VARIABLE",
        "locationId": "05",
        "location": "RESTOCKING",
        "timeSlots": [
            {
                "from": "2026-04-07T11:00:00.000Z",
                "to": "2026-04-07T11:15:00.000Z",
                "real": 4,
                "applied": 1,
                "reference": 0
            },
            {
                "from": "2026-04-07T11:15:00.000Z",
                "to": "2026-04-07T11:30:00.000Z",
                "real": 4,
                "applied": 1,
                "reference": 0
            }
        ]
    },
    {
        "service": "0001",
        "product": "0001-GENERAL",
        "zone": "ZG",
        "locationType": "FIXED",
        "locationId": "02",
        "location": "CLOSING",
        "timeSlots": [
            {
                "from": "2026-04-07T18:30:00.000Z",
                "to": "2026-04-07T18:45:00.000Z",
                "real": 0,
                "applied": 1,
                "reference": 1
            },
            {
                "from": "2026-04-07T18:45:00.000Z",
                "to": "2026-04-07T19:00:00.000Z",
                "real": 0,
                "applied": 1,
                "reference": 1
            }
        ]
    }
]

Detalles

service: identificador externo del servicio o tienda.
product: identificador externo del producto o sección.
zone: identificador externo de la zona.
locationType: tipo de tarea, si es fija, variable o no planificable (FIXED, VARIABLE, UNPLANNED).
locationId: identificador externo de la tarea.
location: nombre de la tarea.
timeSlots: intervalos de tiempo que indican cuándo y durante cuánto tiempo se necesita que los empleados realicen la tarea. Cada intervalo de tiempo tiene una duración de 15 minutos y contiene la siguiente información:
- from: momento de inicio del intervalo en UTC.
- to: momento de finalización del intervalo en UTC.
- real: número de empleados que se utilizará para la tarea. Es el valor final que se considera en el motor.
- applied: número de empleados establecido al aplicar una propuesta de necesidades distinta a la de referencia. Si no se ha aplicado ninguna propuesta alternativa, el valor será 0.
- reference: número de empleados sugerido por la propuesta de referencia configurada en el negocio. Generalmente, proviene de VLH (Variable Labor Hour). Si no hay propuesta de referencia configurada, el valor será 0.

La respuesta dependerá de la configuración del negocio y de cómo se hayan generado las necesidades (de manera manual, vía integración, etc.).

Aspectos que tener en cuenta

Los intervalos de tiempo indican el periodo de tiempo en UTC, es decir, no se considera la zona horaria configurada para el servicio.

Si el servicio indicado en la URL no existe en el negocio, la petición devolverá un error 404 Not Found, especificando en el mensaje not exits.

Si no hay necesidades generadas para el día especificado en la URL, la petición devolverá un estado 204 No Content.

Enlaces de interés

¿Qué son las necesidades?