Otter · JSON Structure

Public Api Refund Rewards Request Structure

Request body for RefundRewards API call.

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

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

Properties

userId orderId

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-refund-rewards-request-structure.json",
  "name": "RefundRewardsRequest",
  "description": "Request body for RefundRewards API call.",
  "type": "object",
  "properties": {
    "userId": {
      "type": "string",
      "description": "The id of the user.",
      "example": "someidstring"
    },
    "orderId": {
      "type": "string",
      "description": "The id of the order.",
      "example": "someidstring"
    }
  },
  "required": [
    "userId",
    "orderId"
  ]
}