Otter · JSON Structure

Public Api Special Hours Structure

Describes the configuration of special store hours.

Type: object Properties: 3 Required: 3
RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

SpecialHours is a JSON Structure definition published by Otter, describing 3 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

date timeRanges type

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-structure/public-api-special-hours-structure.json",
  "name": "SpecialHours",
  "description": "Describes the configuration of special store hours.",
  "type": "object",
  "properties": {
    "date": {
      "type": "date",
      "description": "Date the special hour configuration applies.",
      "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"
  ]
}