Otter · JSON Structure

Public Api Item Status Structure

Represents whether an Item is for sale, indefinitely not for sale, or not for sale until a specific time.

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

ItemStatus 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

saleStatus 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-item-status-structure.json",
  "name": "ItemStatus",
  "description": "Represents whether an Item is for sale, indefinitely not for sale, or not for sale until a specific time.",
  "type": "object",
  "properties": {
    "saleStatus": {
      "type": "string",
      "description": "The sale status of the item.",
      "example": "TEMPORARILY_NOT_FOR_SALE",
      "enum": [
        "FOR_SALE",
        "INDEFINITELY_NOT_FOR_SALE",
        "TEMPORARILY_NOT_FOR_SALE"
      ]
    },
    "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": [
    "saleStatus"
  ]
}