Obtener resumen de necesidades por producto

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

GET /api/v1/businesses/{businessId}/products/{productId}/needs/summary/{yyyy-MM-dd}

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

  • Identificador de negocio (businessId).

  • Identificador del producto o sección (productId).

  • 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 producto o sección con toda la información definida para ellas.

A continuación, se exponen algunos ejemplos (fragmentos de respuesta):

  • Ejemplo 1

  • Ejemplo 2

[
    {
        "location": "HD",
        "locationId": "HD",
        "locationType": "VARIABLE",
        "product": "0001_HD",
        "service": "0001",
        "timeSlots": [
            {
                "from": "2024-07-18T17:00:00.000Z",
                "to": "2024-07-18T17:15:00.000Z",
                "applied": 1,
                "real": 1,
                "reference": 1
            },
            {
                "from": "2024-07-18T17:15:00.000Z",
                "to": "2024-07-18T17:30:00.000Z",
                "applied": 1,
                "real": 1,
                "reference": 1
            }
        ]
    }
]
[
    {
        "location": "SALES",
        "locationId": "03",
        "locationType": "VARIABLE",
        "product": "0001-G",
        "service": "0001",
        "timeSlots": [
            {
                "from": "2024-07-19T08:00:00.000Z",
                "to": "2024-07-19T08:15:00.000Z",
                "real": 5
            },
            {
                "from": "2024-07-19T08:15:00.000Z",
                "to": "2024-07-19T08:30:00.000Z",
                "real": 5
            }
        ]
    },
    {
        "location": "FITTING ROOMS",
        "locationId": "06",
        "locationType": "VARIABLE",
        "product": "0001-G",
        "service": "0001",
        "timeSlots": [
            {
                "from": "2024-07-19T07:00:00.000Z",
                "to": "2024-07-19T07:15:00.000Z",
                "real": 2
            },
            {
                "from": "2024-07-19T07:15:00.000Z",
                "to": "2024-07-19T07:30:00.000Z",
                "real": 2
            }
        ]
    }
]

Tal y como se aprecia en los ejemplos, 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 producto 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?

¿Cómo es la estructura del resumen de necesidades?