Otter · JSON Structure

Public Api Simulate Rewards Response Structure

Response body for SimulateRewards API call.

Type: object Properties: 2
RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

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

Properties

transactionId rewardEffect

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-simulate-rewards-response-structure.json",
  "name": "SimulateRewardsResponse",
  "description": "Response body for SimulateRewards API call.",
  "type": "object",
  "properties": {
    "transactionId": {
      "type": "string",
      "description": "The id of the transaction.",
      "example": "someidstring"
    },
    "rewardEffect": {
      "type": "object",
      "description": "Effect after applying the reward.",
      "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-reward-effect-schema.json"
    }
  }
}