Flipdish · Schema

Voucher

Voucher

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

Properties

Name Type Description
VoucherId integer Voucher Id
Status string Voucher Status
VoucherType string Voucher Type
Currency string Currency of the voucher
StoreNames array Stores that this voucher applies to
PromotionDetails object
CreditNoteDetails object
LumpDiscountDetails object
PercentDiscountDetails object
Code string Voucher Code
Description string Voucher Description (Visible on printout)
Stores array Stores that this voucher applies to
ValidOnOrdersOver number Valid on orders on or above
TakesPriority boolean Takes priority
IsEnabled boolean Is voucher enabled
IsAutomaticallyApplied boolean Is voucher automatically applied
IncludeDeliveryFee boolean Include delivery fees
IsValidForDeliveryOrders boolean Valid for delivery orders
IsValidForPickupOrders boolean Valid for pickup orders
IsValidForOrdersPayedOnline boolean Valid for orders payed online
IsValidForOrdersPayedByCash boolean Valid for orders payed in cash
IsValidForFirstOrderOnly boolean Valid only on the first order by the customer
IsValidOncePerCustomer boolean Valid once per customer
IsValidOnlyOnce boolean Valid only once, by any customer (once used cannot be used again by any other customer)
IsDiscoverable boolean Enables the voucher to be offered in the Voucher Discoverability feature
ForceDiscount boolean Force the discount to be applied which bypasses some menu restrictions
StartDate string Voucher Starts On (Time in UTC)
ExpiryDate string Voucher Expires On (Time in UTC)
ChannelRestrictions array Limit the channels this voucher can be used on
ValidityPeriods array Periods in which the voucher is valid. An empty list means the voucher is valid at all times. When updating the voucher, if this is set to null, the validity periods won't be updated.
VoucherSubType string Voucher Subtype
CustomerId integer Customer UserID
MaxRedemptions integer Maximum number of times the voucher can be redeemed (used)
View JSON Schema on GitHub

JSON Schema

marketing-voucher-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/json-schema/marketing-voucher-schema.json",
  "title": "Voucher",
  "description": "Voucher",
  "type": "object",
  "properties": {
    "VoucherId": {
      "format": "int32",
      "description": "Voucher Id",
      "type": "integer",
      "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": {
        "format": "int32",
        "type": "integer"
      },
      "example": [
        1
      ]
    },
    "ValidOnOrdersOver": {
      "format": "double",
      "description": "Valid on orders on or above",
      "type": "number",
      "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": {
      "format": "date-time",
      "description": "Voucher Starts On (Time in UTC)",
      "type": "string",
      "example": "2026-06-02T12:00:00Z"
    },
    "ExpiryDate": {
      "format": "date-time",
      "description": "Voucher Expires On (Time in UTC)",
      "type": "string",
      "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": {
      "format": "int32",
      "description": "Customer UserID",
      "type": "integer",
      "nullable": true,
      "example": 500123
    },
    "MaxRedemptions": {
      "format": "int32",
      "description": "Maximum number of times the voucher can be redeemed (used)",
      "type": "integer",
      "nullable": true,
      "example": 1
    }
  }
}