Flipdish · Schema

UpdateVoucherUsage

Update Voucher Usage

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

Properties

Name	Type	Description
IsUsed	boolean	Flag indicating whether the voucher is used
UsedByCustomerId	integer	Indicates Customer that used the voucher.
TransactionKey	string	An opaque string, to ensure idempotency. This allows for safely retrying requests without accidentally performing the same stamp operation twice. This will typically contain the the ID of the sale ord

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/json-schema/marketing-update-voucher-usage-schema.json",
  "title": "UpdateVoucherUsage",
  "description": "Update Voucher Usage",
  "type": "object",
  "properties": {
    "IsUsed": {
      "description": "Flag indicating whether the voucher is used",
      "type": "boolean",
      "example": true
    },
    "UsedByCustomerId": {
      "format": "int32",
      "description": "Indicates Customer that used the voucher.",
      "type": "integer",
      "nullable": true,
      "example": 500123
    },
    "TransactionKey": {
      "description": "An opaque string, to ensure idempotency. This allows for safely retrying requests without accidentally performing the same stamp operation twice. \r\nThis will typically contain the the ID of the sale order.",
      "type": "string",
      "example": "string"
    }
  }
}