Thanx · JSON Structure

Consumer Api Reward Structure

Reward schema from Thanx Consumer API

Type: object Properties: 16

RestaurantLoyaltyGuest EngagementMarketingCRMOnline OrderingWebhooksPointsRewardsCampaigns

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

Properties

id olo_uid user_id merchant_id campaign_id state earn redeem coupon_code fine_print instructions available_at activated_at retire_at used_at uses_dynamic_coupon_codes

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-structure.json",
  "name": "Reward",
  "description": "Reward schema from Thanx Consumer API",
  "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
    }
  }
}