Thanx · JSON Structure

Consumer Api Reward Envelope Structure

RewardEnvelope schema from Thanx Consumer API

Type: object Properties: 1

RestaurantLoyaltyGuest EngagementMarketingCRMOnline OrderingWebhookPointsRewardsCampaigns

RewardEnvelope is a JSON Structure definition published by Thanx, describing 1 property. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

reward

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/thanx/refs/heads/main/json-structure/consumer-api-reward-envelope-structure.json",
  "name": "RewardEnvelope",
  "description": "RewardEnvelope schema from Thanx Consumer API",
  "type": "object",
  "properties": {
    "reward": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "example": "92b7b0dac4"
        },
        "olo_uid": {
          "type": "string",
          "example": "92b7b0dac4"
        },
        "user_id": {
          "type": "string",
          "example": "92b7b0dac4"
        },
        "merchant_id": {
          "type": "string",
          "example": "92b7b0dac4"
        },
        "campaign_id": {
          "type": "string",
          "example": "92b7b0dac4"
        },
        "state": {
          "type": "string",
          "enum": [
            "available",
            "active",
            "used"
          ],
          "example": "available"
        },
        "earn": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string"
            }
          }
        },
        "redeem": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string"
            },
            "text": {
              "type": "string"
            },
            "detail": {
              "type": "string"
            },
            "window": {
              "type": "string"
            },
            "venue": {
              "type": "string"
            }
          }
        },
        "coupon_code": {
          "type": "object",
          "properties": {
            "code": {
              "type": "string"
            },
            "type": {
              "type": "string"
            },
            "display": {
              "type": "string"
            }
          }
        },
        "fine_print": {
          "type": "string",
          "example": "Free coffee for loyal customers."
        },
        "instructions": {
          "type": "string",
          "example": "Free coffee for loyal customers."
        },
        "available_at": {
          "type": "datetime",
          "example": "2025-06-01T18:02:05Z"
        },
        "activated_at": {
          "type": "datetime",
          "example": "2025-06-01T18:02:05Z"
        },
        "retire_at": {
          "type": "datetime",
          "example": "2025-06-01T18:02:05Z"
        },
        "used_at": {
          "type": "datetime",
          "example": "2025-06-01T18:02:05Z"
        },
        "uses_dynamic_coupon_codes": {
          "type": "boolean",
          "example": true
        }
      }
    }
  }
}

Work with this as data

Every JSON Structure here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for json structure

4 MCP tools reach this

find_json_structuresBrowse and filter every JSON Structure in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This JSON Structure

curl "https://apis.io/api/v1/json-structures/consumer-api-reward-envelope-structure"

All json structure

curl "https://apis.io/api/v1/json-structures?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.