Consultar horarios de servicio

Este endpoint permite consultar los horarios aplicados en un servicio según el tipo de día.

GET /api/v1/businesses/{businessId}/services/{serviceId}/servicetimes/from/{yyyy-MM-dd}/to/{yyyy-MM-dd}

Si los datos incluidos en la petición son correctos —businessId y serviceId—, la respuesta contendrá los horarios aplicados a un servicio durante el rango de fechas especificado.

  • date: fecha a la que corresponden el horario.

  • dayType: tipo de día aplicado. Puede ser un tipo de día del sistema o uno creado a nivel de negocio.

  • openingMinute: minuto del día en que la tienda abre. El valor se expresa en minutos desde la medianoche (00:00 hora local).

  • closingMinute: minuto del día en que la tienda cierra. El valor se expresa en minutos desde la medianoche (00:00 hora local).

  • serviceStartMinute: minuto del día en que comienza el horario de servicio al público. El valor se expresa en minutos desde la medianoche (00:00 hora local).

  • serviceEndMinute: minuto del día en que termina el horario de servicio al público. El valor se expresa en minutos desde la medianoche (00:00 hora local).

  • restStartMinute: minuto del día en que comienza el periodo de descanso del servicio. Si no existe un periodo de descanso, este valor será 0.

  • restEndMinute: minuto del día en que termina el periodo de descanso del servicio. Si no existe un periodo de descanso, este valor será 0.

  • type: tipo de horario del servicio. Puede tomar uno de los siguientes valores: open, close, open_holiday y close_holiday. Tanto close como close_holiday aplican a todo el día, es decir, de 0 a 1440.

Ver ejemplo

Para consultar los horarios que se aplican al servicio entre el 2024-09-22 y el 2024-09-24, se realiza la siguiente petición:

GET /api/v1/businesses/BUSINESSID/services/SERVICEID/servicetimes/from/2024-09-22/to/2024-09-24

La respuesta recibida es la siguiente:

[
    {
        "date": "2024-09-22",
        "dayType": "SUNDAY",
        "openingMinute": 0,
        "closingMinute": 1440,
        "serviceStartMinute": 0,
        "serviceEndMinute": 1440,
        "restStartMinute": 0,
        "restEndMinute": 0,
        "type": "close"
    },
    {
        "date": "2024-09-23",
        "dayType": "ALL",
        "openingMinute": 0,
        "closingMinute": 1440,
        "serviceStartMinute": 540,
        "serviceEndMinute": 1260,
        "restStartMinute": 0,
        "restEndMinute": 0,
        "type": "open"
    },
    {
        "date": "2024-09-24",
        "dayType": "ALL",
        "openingMinute": 0,
        "closingMinute": 1440,
        "serviceStartMinute": 540,
        "serviceEndMinute": 1260,
        "restStartMinute": 0,
        "restEndMinute": 0,
        "type": "open"
    }
]

  • Día 22: tipo cerrado que aplica a todo el día, por tanto, desde las 00:00 (0 minutos) a las 24:00 (1440 minutos).

  • Días 23 y 24: tipo abierto con horario de trabajo desde las 00:00 (0 minutos) a las 24:00 (1440 minutos) y horario de servicio al público de 9:00 (540 minutos) a 21:00 (1260 minutos).

Aspectos que tener en cuenta

Si el servicio no existe, la petición devolverá un error 404 Not Found indicando not exists.

Los campos que consideran los minutos desde la medianoche (openingMinute, closingMinute, serviceStartMinute, serviceEndMinute, restStartMinute, restEndMinute) tienen en cuenta la zona horaria del servicio. Por ejemplo, si la tienda está en UTC+2, 540 minutos haría referencia a las 9:00 en UTC+2.

Enlaces de interés

¿Qué es un servicio?

¿Qué es un horario de servicio?

¿Qué es un tipo de día?