Otter · JSON Structure

Public Api Metadata Object Structure

Information about the event.

Type: object Properties: 5
RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

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

Properties

storeId applicationId resourceId payload resourceHref

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-metadata-object-structure.json",
  "name": "MetadataObject",
  "description": "Information about the event.",
  "type": "object",
  "properties": {
    "storeId": {
      "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-store-id-schema.json"
    },
    "applicationId": {
      "type": "string",
      "description": "The plain-text Application ID, provided at partner onboarding, also available on Developer Portal.",
      "example": "ad4ff59d-04c0-4c7d-8ca3-e3a673f8443d"
    },
    "resourceId": {
      "type": "string",
      "description": "Identifier of the resource that this event refers to, if needed.",
      "example": "resource-id-if-needed"
    },
    "payload": {
      "type": "object",
      "description": "Object containing details of the given event, if needed."
    },
    "resourceHref": {
      "type": "string",
      "description": "The full endpoint to fetch the details of the resource, if needed.",
      "example": "resource-href-id-if-needed"
    }
  }
}