Consultar periodos de servicio
Este endpoint permite consultar los periodos y los horarios de un servicio.
GET /api/v1/businesses/{businessId}/services/{serviceId}/periodsSi los datos incluidos en la petición son correctos —businessId y serviceId—, la respuesta contendrá la siguiente información definida para cada periodo dentro del servicio.
Ejemplo de respuesta
[
{
"serviceTimes": [
{
"dayType": {
"name": "ALL"
},
"type": "OPEN",
"openingHours": {
"start": 0,
"end": 0
},
"serviceHours": {
"start": 540,
"end": 1260
},
"restHours": [
{
"start": 840,
"end": 900
}
]
}
],
"name": "General",
"id": "STGE",
"from": "--01-01",
"to": "--12-31",
"year": 2026
}
]Detalles
-
serviceTimes: conjunto de horarios de servicio según el tipo de día.
-
dayType: tipo de día. Puede ser un tipo de día del sistema o uno creado a nivel de negocio.
-
name: nombre del tipo de día.
-
-
type: tipo de horario del servicio. Puede tomar uno de los siguientes valores:
OPEN,CLOSE,OPEN_HOLIDAYyCLOSE_HOLIDAY. TantoCLOSEcomoCLOSE_HOLIDAYaplican a todo el día, es decir, de0a1440. -
openingHours: horario de apertura del servicio. El valor se expresa en minutos desde la medianoche (00:00 hora local).
-
start: inicio del intervalo expresado en minutos desde la medianoche.
-
end: fin del intervalo expresado en minutos desde la medianoche.
-
-
serviceHours: horario de servicio al público. El valor se expresa en minutos desde la medianoche (00:00 hora local).
-
start: inicio del intervalo expresado en minutos desde la medianoche.
-
end: fin del intervalo expresado en minutos desde la medianoche.
-
-
restHours: intervalo, si procede, en el que el servicio estará cerrado. El valor se expresa en minutos desde la medianoche (00:00 hora local).
-
start: inicio del intervalo expresado en minutos desde la medianoche.
-
end: fin del intervalo expresado en minutos desde la medianoche.
-
-
-
name: nombre del intervalo.
-
id: identificador externo del periodo. Orquest define uno por defecto que puede cambiarse manualmente a través de la aplicación.
-
from: fecha de inicio del periodo en formato
--MM-DD. -
to: fecha de fin del periodo en formato
--MM-DD. -
year: año para el que se ha definido el periodo, si aplica.
El ejemplo indica que, durante todo el año 2026, para todos los días (ALL), el servicio está abierto 24 horas, atienda al público de 09:00 a 21:00 y tiene una pausa de 14:00 a 15:00. Por tanto, el horario efectivo real de atención al público es de 09:00–14:00 y de 15:00–21:00.
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 tienen en cuenta la zona horaria del servicio. Por ejemplo, si el servicio está en UTC+2, 540 hace referencia a las 9:00 UTC+2.
Si no hay periodos definidos para el servicio indicado, la petición devolverá un array vacío [].