Otter · Schema

SuspendItemsRequest

SuspendItemsRequest schema from Public API (Otter Public API).

RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

Properties

Name	Type	Description
entityIds	array	Entity IDs to suspend. These should be the IDs as you represent them in your system.
note	string	The reason you are suspending the items.
status	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "SuspendItemsRequest",
  "description": "SuspendItemsRequest schema from Public API (Otter Public API).",
  "$id": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-suspend-items-request-schema.json",
  "type": "object",
  "properties": {
    "entityIds": {
      "type": "array",
      "description": "Entity IDs to suspend. These should be the IDs as you represent them in your system.",
      "example": [
        "9cc4bb5e-bc97-40d9-af28-c02ef1483610"
      ],
      "items": {
        "type": "string",
        "description": "Entity IDs to suspend.",
        "example": "[\"9cc4bb5e-bc97-40d9-af28-c02ef1483610\",\"9929290d-31eb-425d-8732-17c4074ac75e\"]"
      }
    },
    "note": {
      "type": "string",
      "description": "The reason you are suspending the items.",
      "example": "Out of item"
    },
    "status": {
      "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-suspension-status-schema.json"
    }
  },
  "required": [
    "entityIds",
    "note",
    "status"
  ]
}