Otter · JSON Structure

Public Api Simulate Rewards Request Structure

Request body for SimulateRewards API call.

Type: object Properties: 3 Required: 3
RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

SimulateRewardsRequest is a JSON Structure definition published by Otter, describing 3 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

userId order selectedRewards

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-request-structure.json",
  "name": "SimulateRewardsRequest",
  "description": "Request body for SimulateRewards API call.",
  "type": "object",
  "properties": {
    "userId": {
      "type": "string",
      "description": "The id of the user.",
      "example": "someidstring"
    },
    "order": {
      "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-order-2-schema.json"
    },
    "selectedRewards": {
      "type": "array",
      "description": "Selected rewards, currently only support one reward, if multiple rewards are passed it will throw an error.",
      "items": {
        "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-selected-reward-schema.json"
      }
    }
  },
  "required": [
    "userId",
    "order",
    "selectedRewards"
  ]
}