Otter · Schema

PauseRequest

Pause request parameters

RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

Properties

Name Type Description
start string Start time for the pause. Executed immediately if not set.
end string Time when the pause should expire. If not provided, uses the default which is 4 AM at store timezone.
comment string Comment for the pause
reason object
View JSON Schema on GitHub

JSON Schema

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