Toast · Schema

AppliedDiscountTrigger

The Selection that triggered the application of this discount

RestaurantsPoint Of SalePaymentsOnline OrderingDeliveryLoyaltyGift CardsMenusOrdersKitchenLaborSchedulingInventoryHospitalityPartner Integrations

Properties

Name Type Description
selection object
quantity number The amount of the selection used to trigger the applied discount.
View JSON Schema on GitHub

JSON Schema

orders-applied-discount-trigger-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/toast-tab/refs/heads/main/json-schema/orders-applied-discount-trigger-schema.json",
  "title": "AppliedDiscountTrigger",
  "description": "The Selection that triggered the application of this discount",
  "type": "object",
  "properties": {
    "selection": {
      "$ref": "#/$defs/ExternalReference"
    },
    "quantity": {
      "type": "number",
      "format": "double",
      "description": "The amount of the selection used to trigger the applied discount.",
      "example": 1.0
    }
  },
  "$defs": {
    "ExternalReference": {
      "type": "object",
      "description": "A wrapper object with fields that allow reference to a Toast platform entity by Toast GUID or a partner's identifier.",
      "allOf": [
        {
          "$ref": "#/$defs/ToastReference"
        },
        {
          "type": "object",
          "properties": {
            "externalId": {
              "description": "External identifier string that is prefixed by the naming authority. You can use the orders API to set an `externalId` for an order and then GET the order with that `externalId`.",
              "type": "string"
            }
          }
        }
      ]
    }
  }
}