Skip to content

API reference · Schema

V1OutletCalendar

V1OutletCalendarcontract v1.outlet.calendar

outlet_idUuid7required
tzstringrequired
pattern ^[A-Za-z]+\/[A-Za-z_]+$
rowsarray of objectrequired
- calendar_idUuid7required
- kindenum (2)required
  weeklyoverride
- weekdayinteger | nullrequired
  ≥ 0≤ 6
- on_datestring (date) | nullrequired
  pattern ^(?:(?:[0-9][0-9][2468][048]|[0-9][0-9][13579][26]|[0-9][0-9]0[48]|[02468][048]00|[13579][26]00)-02-29|[0-9]{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12][0-9]|3[01])|(?:0[469]|11)-(?:0[1-9]|[12][0-9]|30)|(?:02)-(?:0[1-9]|1[0-9]|2[0-8])))$
- opens_atstring | nullrequired
  pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$
- closes_atstring | nullrequired
  pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$
- closedbooleanrequired

Used by

get/v1/outlets/{id}/calendarAn outlet's weekly hours and dated overrides (holidays), in the outlet's own zone; an outlet outside the caller's scope is 404