Otter · Schema

SpecialHours

Describes the configuration of special store hours.

RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

Properties

Name Type Description
date string Date the special hour configuration applies.
timeRanges array Hours range applied to configured date. For open days, the timeRanges field is required. For closed days, the timeRanges field is ignored.
type string Store state that should be applied during the configured special hour. If this field is set to CLOSED, the timeRanges field is ignored.
View JSON Schema on GitHub

JSON Schema

public-api-special-hours-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "SpecialHours",
  "description": "Describes the configuration of special store hours.",
  "$id": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-special-hours-schema.json",
  "type": "object",
  "properties": {
    "date": {
      "type": "string",
      "description": "Date the special hour configuration applies.",
      "format": "date",
      "example": "2021-10-01"
    },
    "timeRanges": {
      "type": "array",
      "minItems": 0,
      "description": "Hours range applied to configured date. For open days, the timeRanges field is required. For closed days, the timeRanges field is ignored.",
      "items": {
        "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-time-range-schema.json"
      }
    },
    "type": {
      "type": "string",
      "description": "Store state that should be applied during the configured special hour. If this field is set to CLOSED, the timeRanges field is ignored.",
      "enum": [
        "OPEN",
        "CLOSED"
      ],
      "example": "OPEN"
    }
  },
  "required": [
    "date",
    "timeRanges",
    "type"
  ]
}