Toast · JSON Structure

Orders Applicable Discount Structure

A wrapper object that contains information about a discount that you can apply to an order, and which checks or menu item selections you can apply it to.

Type: object Properties: 3 Required: 1
Food ServicePoint of SaleRestaurantsHospitality

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

Properties

discount applicableChecks applicableSelections

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/refs/heads/main/json-structure/orders-applicable-discount-structure.json",
  "name": "ApplicableDiscount",
  "description": "A wrapper object that contains information about a discount that you\ncan apply to an order, and which checks or menu item selections\nyou can apply it to.\n",
  "type": "object",
  "required": [
    "discount"
  ],
  "properties": {
    "discount": {
      "x-toast-read-only": true,
      "description": "A `ToastReference` object containing the identifiers of the discount.\nResponse only.\n",
      "type": "object",
      "$ref": "#/definitions/ToastReference"
    },
    "applicableChecks": {
      "description": "If the discount is applicable to a check, this value holds an\narray of `ExternalReference` objects containing the identifiers of the checks.\n",
      "type": "array",
      "items": {
        "$ref": "#/definitions/ExternalReference"
      }
    },
    "applicableSelections": {
      "description": "If the discount is applicable to a menu item selection, this\nvalue holds an array of `ExternalReference` objects containing\nthe identifiers of the menu items.\n",
      "type": "array",
      "items": {
        "$ref": "#/definitions/ExternalReference"
      }
    }
  }
}