Flipdish · Schema

OrderVoucherSummary

Voucher summary

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

Properties

Name Type Description
VoucherId integer Voucher ID
Name string Voucher name
Description string Voucher description
Code string Voucher code
Amount number Voucher amount
Type string Voucher type
SubType string Voucher sub type
View JSON Schema on GitHub

JSON Schema

orders-order-voucher-summary-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/orders-order-voucher-summary-schema.json",
  "title": "OrderVoucherSummary",
  "description": "Voucher summary",
  "type": "object",
  "properties": {
    "VoucherId": {
      "format": "int32",
      "description": "Voucher ID",
      "type": "integer",
      "example": 500123
    },
    "Name": {
      "description": "Voucher name",
      "type": "string",
      "example": "Example Name"
    },
    "Description": {
      "description": "Voucher description",
      "type": "string",
      "example": "string"
    },
    "Code": {
      "description": "Voucher code",
      "type": "string",
      "example": "string"
    },
    "Amount": {
      "format": "double",
      "description": "Voucher amount",
      "type": "number",
      "example": 12.5
    },
    "Type": {
      "description": "Voucher type",
      "enum": [
        "PercentageDiscount",
        "LumpDiscount",
        "AddItem",
        "CreditNote",
        "FreeDelivery"
      ],
      "type": "string",
      "example": "PercentageDiscount"
    },
    "SubType": {
      "description": "Voucher sub type",
      "enum": [
        "None",
        "SignUp",
        "Loyalty",
        "Loyalty25",
        "Retention",
        "SecondaryRetention",
        "Custom"
      ],
      "type": "string",
      "example": "None"
    }
  }
}