Flipdish · JSON Structure

Marketing Voucher Summary Structure

Voucher Summary

Type: object Properties: 9
RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

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

Properties

VoucherId Code Status VoucherType VoucherSubType Description IsEnabled StoreNames IsAvailableOnAllStores

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/flipdish/refs/heads/main/json-structure/marketing-voucher-summary-structure.json",
  "name": "VoucherSummary",
  "description": "Voucher Summary",
  "type": "object",
  "properties": {
    "VoucherId": {
      "description": "Voucher Id",
      "type": "int32",
      "example": 500123
    },
    "Code": {
      "description": "Voucher Code",
      "type": "string",
      "example": "string"
    },
    "Status": {
      "description": "Voucher Status",
      "enum": [
        "Valid",
        "NotYetValid",
        "Expired",
        "Used",
        "Disabled"
      ],
      "type": "string",
      "example": "Valid"
    },
    "VoucherType": {
      "description": "Voucher Type",
      "enum": [
        "PercentageDiscount",
        "LumpDiscount",
        "AddItem",
        "CreditNote",
        "FreeDelivery"
      ],
      "type": "string",
      "example": "PercentageDiscount"
    },
    "VoucherSubType": {
      "description": "Voucher Sub Type",
      "enum": [
        "None",
        "SignUp",
        "Loyalty",
        "Loyalty25",
        "Retention",
        "SecondaryRetention",
        "Custom"
      ],
      "type": "string",
      "example": "None"
    },
    "Description": {
      "description": "Voucher Description (Visible on printout)",
      "type": "string",
      "example": "string"
    },
    "IsEnabled": {
      "description": "Is voucher enabled",
      "type": "boolean",
      "example": true
    },
    "StoreNames": {
      "description": "Store names associated with this voucher",
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "Example Name"
      ]
    },
    "IsAvailableOnAllStores": {
      "description": "True if the voucher is available on all active stores in the app",
      "type": "boolean",
      "example": true
    }
  }
}