Otter · Schema

UpdateStorelinkStatusRequest

UpdateStorelinkStatusRequest schema from Public API (Otter Public API).

RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

Properties

Name	Type	Description
status	string	The new status of the store. ACTIVE: store ready to perform operations again; SUSPENDED: temporarily disables the store; INVALID: current credentials will no longer work, new credentials needed.
message	string	Optional message to explain the reason of the status update.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "UpdateStorelinkStatusRequest",
  "description": "UpdateStorelinkStatusRequest schema from Public API (Otter Public API).",
  "$id": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-update-storelink-status-request-schema.json",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "The new status of the store. ACTIVE: store ready to perform operations again; SUSPENDED: temporarily disables the store; INVALID: current credentials will no longer work, new credentials needed.",
      "enum": [
        "ACTIVE",
        "SUSPENDED",
        "INVALID"
      ],
      "example": "SUSPENDED"
    },
    "message": {
      "nullable": true,
      "type": "string",
      "description": "Optional message to explain the reason of the status update.",
      "example": "Authentication is failing with current credentials.  Suspending store while the retry process is in progress."
    }
  },
  "required": [
    "status"
  ]
}