Otter · Schema

ItemPriceOverride

Price override for an item

RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

Properties

Name Type Description
rules array Override rules for when this price override should be applied.
currencyCode string The 3-letter currency code (ISO 4217) to use for all monetary values.
amount number Amount the Item costs
View JSON Schema on GitHub

JSON Schema

public-api-item-price-override-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ItemPriceOverride",
  "description": "Price override for an item",
  "$id": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-item-price-override-schema.json",
  "type": "object",
  "properties": {
    "rules": {
      "type": "array",
      "minItems": 1,
      "description": "Override rules for when this price override should be applied.",
      "items": {
        "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-override-rule-schema.json"
      }
    },
    "currencyCode": {
      "maxLength": 3,
      "minLength": 3,
      "type": "string",
      "description": "The 3-letter currency code (ISO 4217) to use for all monetary values.",
      "example": "EUR"
    },
    "amount": {
      "type": "number",
      "description": "Amount the Item costs",
      "example": 25.21
    }
  },
  "required": [
    "amount",
    "currencyCode",
    "rules"
  ]
}