Otter · JSON Structure

Public Api Pause Request Structure

Pause request parameters

Type: object Properties: 4
RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

PauseRequest is a JSON Structure definition published by Otter, describing 4 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

start end comment reason

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-pause-request-structure.json",
  "name": "PauseRequest",
  "description": "Pause request parameters",
  "type": "object",
  "properties": {
    "start": {
      "type": "datetime",
      "nullable": true,
      "description": "Start time for the pause. Executed immediately if not set.",
      "example": "2007-12-03T10:15:30+01:00"
    },
    "end": {
      "type": "datetime",
      "nullable": true,
      "description": "Time when the pause should expire. If not provided, uses the default which is 4 AM at store timezone.",
      "example": "2007-12-03T10:15:30+01:00"
    },
    "comment": {
      "type": "string",
      "nullable": true,
      "description": "Comment for the pause",
      "example": "Some comment"
    },
    "reason": {
      "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-pause-reason-schema.json"
    }
  }
}