Otter · Schema

SimulateRewardsResponse

Response body for SimulateRewards API call.

RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

Properties

Name Type Description
transactionId string The id of the transaction.
rewardEffect object Effect after applying the reward.
View JSON Schema on GitHub

JSON Schema

public-api-simulate-rewards-response-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "SimulateRewardsResponse",
  "description": "Response body for SimulateRewards API call.",
  "$id": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-simulate-rewards-response-schema.json",
  "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"
    }
  }
}