Toast · JSON Structure

Orders Applied Discount Reason Structure

AppliedDiscountReason schema from Toast Orders API

Type: object Properties: 4 Required: 1
RestaurantsPoint Of SalePaymentsOnline OrderingDeliveryLoyaltyGift CardsMenusOrdersKitchenLaborSchedulingInventoryHospitalityPartner Integrations

AppliedDiscountReason is a JSON Structure definition published by Toast, describing 4 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

name description comment discountReason

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/toast-tab/refs/heads/main/json-structure/orders-applied-discount-reason-structure.json",
  "name": "AppliedDiscountReason",
  "description": "AppliedDiscountReason schema from Toast Orders API",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the reason for the applied discount.",
      "example": "Example Name"
    },
    "description": {
      "type": "string",
      "description": "An optional description for the reason for the applied discount.",
      "example": "string"
    },
    "comment": {
      "type": "string",
      "description": "An optional comment on the reason for the applied discount.",
      "example": "string"
    },
    "discountReason": {
      "type": "object",
      "description": "A ToastReference object that contains the GUID for the discount reason configured for the discount.",
      "$ref": "#/$defs/ToastReference"
    }
  },
  "required": [
    "name"
  ],
  "definitions": {
    "ToastReference": {
      "type": "object",
      "description": "A wrapper object with fields that allow reference to a Toast entity by Toast GUID.",
      "required": [
        "guid",
        "entityType"
      ],
      "properties": {
        "guid": {
          "description": "The GUID maintained by the Toast platform.",
          "type": "string",
          "example": "5a401af8-d2e2-4090-8c45-9f87b8b6c4d1"
        },
        "entityType": {
          "x-toast-read-only": true,
          "description": "The type of object this is. Response only.",
          "type": "string",
          "example": "string"
        }
      },
      "name": "ToastReference"
    }
  }
}