Otter · JSON Structure

Public Api Promotion Details Structure

Order promotion details.

Type: object Properties: 3
RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

PromotionDetails 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

externalId name value

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-promotion-details-structure.json",
  "name": "PromotionDetails",
  "description": "Order promotion details.",
  "type": "object",
  "properties": {
    "externalId": {
      "type": "string",
      "description": "External promotion identifier.",
      "example": "store_123"
    },
    "name": {
      "type": "string",
      "description": "Promotion name.",
      "example": "20% off, up to $5"
    },
    "value": {
      "type": "double",
      "description": "Promotion value.",
      "example": 2
    }
  }
}