Get the upcoming business hours schedule.

Request

Get the resolved business hours schedule for the next number of days, applying recurring rules and exceptions. Each entry in businessHours describes one upcoming day (see its nextDate). An entry with status: Open lists the intervals during which the business is open on that day; between and outside those intervals it is closed. An entry with status: Closed is a day explicitly configured as closed and has no intervals. Days without any configured business hours are omitted from the response entirely, so businessHours can be empty when no day in the requested window has configured hours. In short: the business is open only during the intervals of status: Open entries, and closed at all other times.

Security

ApiKeyAuth

Path

scheduleIdstring, (uuid)required

Query

daysinteger, (int32), [ 1 .. 90 ]

Number of upcoming days to include in the response. Must be between 1 and 90.

Default:7

GET

/beta/business-hours/schedules/{scheduleId}/upcoming

curl -i -X GET \
  'https://dev.dixa.io/beta/business-hours/schedules/{scheduleId}/upcoming?days=7' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json

dataobject(GetUpcomingBusinessHoursScheduleResult)required

Response

{
  "data": {
    "schedule": { … }
  }
}