Otter · JSON Structure

Public Api Suspension Status Structure

The type of suspension this will be.

Type: object Properties: 2 Required: 1
RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

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

Properties

isIndefinite suspendedUntil

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-suspension-status-structure.json",
  "name": "SuspensionStatus",
  "description": "The type of suspension this will be.",
  "type": "object",
  "properties": {
    "isIndefinite": {
      "type": "boolean",
      "description": "True if the suspension is indefinite",
      "example": true
    },
    "suspendedUntil": {
      "type": "datetime",
      "nullable": true,
      "description": "ISO-8601 timestamp representing the time the saleStatus value is supposed to change to FOR_SALE. Set only when current saleStatus value is TEMPORARILY_NOT_FOR_SALE. E.g.: 2020-11-23T21:33:51Z, 2007-12-03T10:15:30+01:00",
      "example": "2007-12-03T10:15:30+01:00"
    }
  },
  "required": [
    "isIndefinite"
  ]
}