Flipdish · JSON Structure

Platform Voucher Structure

Voucher

Type: object Properties: 33

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

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

Properties

VoucherId Status VoucherType Currency StoreNames PromotionDetails CreditNoteDetails LumpDiscountDetails PercentDiscountDetails Code Description Stores ValidOnOrdersOver TakesPriority IsEnabled IsAutomaticallyApplied IncludeDeliveryFee IsValidForDeliveryOrders IsValidForPickupOrders IsValidForOrdersPayedOnline IsValidForOrdersPayedByCash IsValidForFirstOrderOnly IsValidOncePerCustomer IsValidOnlyOnce IsDiscoverable ForceDiscount StartDate ExpiryDate ChannelRestrictions ValidityPeriods VoucherSubType CustomerId MaxRedemptions

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/flipdish/refs/heads/main/json-structure/platform-voucher-structure.json",
  "name": "Voucher",
  "description": "Voucher",
  "type": "object",
  "properties": {
    "VoucherId": {
      "description": "Voucher Id",
      "type": "int32",
      "example": 500123
    },
    "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"
    },
    "Currency": {
      "description": "Currency of the voucher",
      "enum": [
        "EUR",
        "USD",
        "GBP",
        "CAD",
        "AUD",
        "DJF",
        "ZAR",
        "ETB",
        "AED",
        "BHD",
        "DZD",
        "EGP",
        "IQD",
        "JOD",
        "KWD",
        "LBP",
        "LYD",
        "MAD",
        "OMR",
        "QAR",
        "SAR",
        "SYP",
        "TND",
        "YER",
        "CLP",
        "INR",
        "AZN",
        "RUB",
        "BYN",
        "BGN",
        "NGN",
        "BDT",
        "CNY",
        "BAM",
        "CZK",
        "DKK",
        "CHF",
        "MVR",
        "BTN",
        "XCD",
        "BZD",
        "HKD",
        "IDR",
        "JMD",
        "MYR",
        "NZD",
        "PHP",
        "SGD",
        "TTD",
        "XDR",
        "ARS",
        "BOB",
        "COP",
        "CRC",
        "CUP",
        "DOP",
        "GTQ",
        "HNL",
        "MXN",
        "NIO",
        "PAB",
        "PEN",
        "PYG",
        "UYU",
        "VEF",
        "IRR",
        "XOF",
        "CDF",
        "XAF",
        "HTG",
        "ILS",
        "HRK",
        "HUF",
        "AMD",
        "ISK",
        "JPY",
        "GEL",
        "KZT",
        "KHR",
        "KRW",
        "KGS",
        "LAK",
        "MKD",
        "MNT",
        "BND",
        "MMK",
        "NOK",
        "NPR",
        "PKR",
        "PLN",
        "AFN",
        "BRL",
        "MDL",
        "RON",
        "RWF",
        "SEK",
        "LKR",
        "SOS",
        "ALL",
        "RSD",
        "KES",
        "TJS",
        "THB",
        "ERN",
        "TMT",
        "BWP",
        "TRY",
        "UAH",
        "UZS",
        "VND",
        "MOP",
        "TWD",
        "BMD"
      ],
      "type": "string",
      "example": "EUR"
    },
    "StoreNames": {
      "description": "Stores that this voucher applies to",
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "Example Name"
      ]
    },
    "PromotionDetails": {
      "$ref": "#/components/schemas/PromotionDetails"
    },
    "CreditNoteDetails": {
      "$ref": "#/components/schemas/CreditNoteDetails"
    },
    "LumpDiscountDetails": {
      "$ref": "#/components/schemas/LumpDiscountDetails"
    },
    "PercentDiscountDetails": {
      "$ref": "#/components/schemas/PercentDiscountDetails"
    },
    "Code": {
      "description": "Voucher Code",
      "type": "string",
      "example": "string"
    },
    "Description": {
      "description": "Voucher Description (Visible on printout)",
      "type": "string",
      "example": "string"
    },
    "Stores": {
      "description": "Stores that this voucher applies to",
      "type": "array",
      "items": {
        "type": "int32"
      },
      "example": [
        1
      ]
    },
    "ValidOnOrdersOver": {
      "description": "Valid on orders on or above",
      "type": "double",
      "example": 1.0
    },
    "TakesPriority": {
      "description": "Takes priority",
      "type": "boolean",
      "example": true
    },
    "IsEnabled": {
      "description": "Is voucher enabled",
      "type": "boolean",
      "example": true
    },
    "IsAutomaticallyApplied": {
      "description": "Is voucher automatically applied",
      "type": "boolean",
      "example": true
    },
    "IncludeDeliveryFee": {
      "description": "Include delivery fees",
      "type": "boolean",
      "example": true
    },
    "IsValidForDeliveryOrders": {
      "description": "Valid for delivery orders",
      "type": "boolean",
      "example": true
    },
    "IsValidForPickupOrders": {
      "description": "Valid for pickup orders",
      "type": "boolean",
      "example": true
    },
    "IsValidForOrdersPayedOnline": {
      "description": "Valid for orders payed online",
      "type": "boolean",
      "example": true
    },
    "IsValidForOrdersPayedByCash": {
      "description": "Valid for orders payed in cash",
      "type": "boolean",
      "example": true
    },
    "IsValidForFirstOrderOnly": {
      "description": "Valid only on the first order by the customer",
      "type": "boolean",
      "example": true
    },
    "IsValidOncePerCustomer": {
      "description": "Valid once per customer",
      "type": "boolean",
      "example": true
    },
    "IsValidOnlyOnce": {
      "description": "Valid only once, by any customer (once used cannot be used again by any other customer)",
      "type": "boolean",
      "example": true
    },
    "IsDiscoverable": {
      "description": "Enables the voucher to be offered in the Voucher Discoverability feature",
      "type": "boolean",
      "example": true
    },
    "ForceDiscount": {
      "description": "Force the discount to be applied which bypasses some menu restrictions",
      "type": "boolean",
      "example": true
    },
    "StartDate": {
      "description": "Voucher Starts On (Time in UTC)",
      "type": "datetime",
      "example": "2026-06-02T12:00:00Z"
    },
    "ExpiryDate": {
      "description": "Voucher Expires On (Time in UTC)",
      "type": "datetime",
      "example": "2026-06-02T12:00:00Z"
    },
    "ChannelRestrictions": {
      "description": "Limit the channels this voucher can be used on",
      "type": "array",
      "items": {
        "enum": [
          "Ios",
          "Android",
          "Web",
          "Kiosk",
          "Pos",
          "Google"
        ],
        "type": "string"
      },
      "example": [
        "Ios"
      ]
    },
    "ValidityPeriods": {
      "description": "Periods in which the voucher is valid.\r\nAn empty list means the voucher is valid at all times.\r\nWhen updating the voucher, if this is set to null, the validity periods won't be updated.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ValidityPeriod"
      },
      "example": []
    },
    "VoucherSubType": {
      "description": "Voucher Subtype",
      "enum": [
        "None",
        "SignUp",
        "Loyalty",
        "Loyalty25",
        "Retention",
        "SecondaryRetention",
        "Custom"
      ],
      "type": "string",
      "example": "None"
    },
    "CustomerId": {
      "description": "Customer UserID",
      "type": "int32",
      "nullable": true,
      "example": 500123
    },
    "MaxRedemptions": {
      "description": "Maximum number of times the voucher can be redeemed (used)",
      "type": "int32",
      "nullable": true,
      "example": 1
    }
  }
}