Otter · JSON Structure

Public Api Required Event Result Metadata Structure

Information about the result of a storefront event.

Type: object Properties: 3
RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

RequiredEventResultMetadata is a JSON Structure definition published by Otter, describing 3 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

operationStatus additionalInformation operationFinishedAt

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-required-event-result-metadata-structure.json",
  "name": "RequiredEventResultMetadata",
  "description": "Information about the result of a storefront event.",
  "type": "object",
  "properties": {
    "operationStatus": {
      "type": "string",
      "description": "Status of the operation requested by an event.",
      "enum": [
        "SUCCEEDED",
        "INTERNAL_ERROR",
        "AUTHENTICATION_FAILURE",
        "AUTHORIZATION_FAILURE",
        "UNKNOWN_FAILURE",
        "INVALID_STORE_STATE",
        "INVALID_STORE_CONFIGURATION",
        "OPERATION_NOT_SUPPORTED",
        "IGNORED_ALREADY_IN_REQUESTED_STATE",
        "INVALID_REQUEST"
      ],
      "example": "SUCCEEDED"
    },
    "additionalInformation": {
      "type": "string",
      "nullable": true,
      "description": "Additional details about the event result, if available.",
      "example": "Completed without problems."
    },
    "operationFinishedAt": {
      "type": "datetime",
      "description": "Time when the processing of the event finished.",
      "example": "2007-12-03T10:15:30+01:00"
    }
  }
}