Consultar plantillas de necesidades por servicio

Este endpoint devuelve las plantillas de necesidades que se han aplicado en un servicio en un periodo no superior a 30 días.

GET /api/v1/businesses/{business_id}/services/{service_id}/needs-templates?fromDate={yyyy-MM-dd}&toDate={yyyy-MM-dd}

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

  • Identificador de negocio (business_id).

  • Identificador del servicio o tienda (service_id).

  • Intervalo para el que se realiza la consulta (fromDate/toDate) en formato yyyy-MM-dd.

Si los datos incluidos en la URL son correctos, la respuesta contendrá las plantillas de necesidades aplicadas en el servicio cada uno de los días especificados en el intervalo de la petición.

A continuación, se expone un ejemplo:

GET /api/v1/businesses/BUSINESSID/services/0001/needs-templates?fromDate=2024-05-31&toDate=2024-06-01
[
    {
        "productId": "0001-HD",
        "date": "2024/05/31",
        "id": "42157",
        "templateName": "HD-Template"
    },
    {
        "productId": "0001-G",
        "date": "2024/05/31",
        "id": "17536",
        "templateName": "General"
    },
    {
        "productId": "0001-HD",
        "date": "2024/06/01",
        "id": "42157",
        "templateName": "HD-Template"
    },
    {
        "productId": "0001-G",
        "date": "2024/06/01",
        "id": "17537",
        "templateName": "Summer"
    }
]

Como se puede ver en el ejemplo, la petición devuelve las plantillas de necesidades aplicadas a cada producto o sección del servicio en los días especificados en la petición.

Aspectos que tener en cuenta

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 el intervalo de tiempo indicado en la URL es superior a 30 días, la petición devolverá un error 400 Bad Request, especificando en el mensaje Period between dates cannot be longer than 30 days.

Si no hay plantillas de necesidades aplicadas para el periodo de tiempo indicado, la petición devolverá un error 404 Not Found, especificando en el mensaje There is not needs template on the requested information. También devolverá este error si no hay plantillas de necesidades definidas en el servicio.

Enlaces de interés

¿Qué son las necesidades?

¿Qué son las plantillas de necesidades?

¿Cómo es la estructura de una plantilla de necesidades?