Flipdish · JSON Structure

Orders Order Voucher Summary Structure

Voucher summary

Type: object Properties: 7
RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

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

Properties

VoucherId Name Description Code Amount Type SubType

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/orders-order-voucher-summary-structure.json",
  "name": "OrderVoucherSummary",
  "description": "Voucher summary",
  "type": "object",
  "properties": {
    "VoucherId": {
      "description": "Voucher ID",
      "type": "int32",
      "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": {
      "description": "Voucher amount",
      "type": "double",
      "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"
    }
  }
}