Discount

A discount configured in Toast Web. Discounts are always applied before taxes, but after service charges are calculated.

• active:
  boolean

  Indicates whether the discount is available and can be applied by restaurant employees.

• amount:
  number <double>

  The currency amount of the discount when the amountType is FIXED. This value will be greater than 0.

• entityType required:
  string

  The type of object this is.

• fixedTotal:
  number <double>

  The total price of items discounted by a combo discount. This value is null for discounts that are not combo discounts.

• guid required:
  string

  The GUID maintained by the Toast POS.

• itemPickingPriority:
  string

  Indicates which menu item selections are discounted when you apply a BOGO discount. An item that is discounted by a BOGO discount is a "get" item.

  • FIRST - the BOGO discount applies to the first matching item selection in the check or the discount is not a BOGO discount.

  • LEAST_EXPENSIVE - the BOGO discount applies to the least expensive matching item selection in the check. LEAST_EXPENSIVE is the default itemPickingPriority value for discounts that are not BOGO discounts.

  • MOST_EXPENSIVE - the BOGO discount applies to the most expensive matching item selection in the check.

  Enum: "FIRST" "LEAST_EXPENSIVE" "MOST_EXPENSIVE"
• name:
  string

  The human-readable name of the discount.

• nonExclusive:
  boolean

  Indicates whether you can apply the discount with other discounts. This value is always false for item and combo discounts. Set this value for check and BOGO discounts by selecting Allow with other discounts in the Discounts Rules section of the discounts configuration page of Toast Web.

• percentage:
  number <double>

  Percent discount applied when the amountType is PERCENT. This value will be greater than 0 and at most 100.

• promoCodes:
  Array of objects (PromoCode)

  A list of promotion identifiers associated with this discount.

• selectionType:
  string

  • CHECK - the discount can be applied to a check.
  • BOGO - a buy one get one (BOGO) discount.
  • ITEM - the discount can be applied to an item selection in a check.

  Enum: "CHECK" "ITEM" "BOGO"
• type:
  string

  • PERCENT - the discount reduces the price by a preconfigured percent.
  • FIXED - the discount reduces the price by a preconfigured currency amount.
  • OPEN_PERCENT - the discount reduces the price by a percent entered by a restaurant employee.
  • OPEN_FIXED - the discount reduces the price by a currency amount entered by a restaurant employee.
  • BOGO - a buy one get one (BOGO) discount.
  • FIXED_TOTAL - a combo discount that reduces the price of all eligible items to a preconfigured currency amount.

  Enum: "PERCENT" "FIXED" "OPEN_PERCENT" "OPEN_FIXED" "BOGO" "FIXED_TOTAL"

{
  "guid": "string",
  "entityType": "string",
  "name": "string",
  "active": true,
  "type": "PERCENT",
  "percentage": 0,
  "amount": 0,
  "selectionType": "CHECK",
  "nonExclusive": true,
  "itemPickingPriority": "FIRST",
  "fixedTotal": 0,
  "promoCodes": [
    {
      "guid": "string",
      "entityType": "string",
      "code": "string",
      "name": "string",
      "usageType": "SINGLE_USE_PHONE"
    }
  ]
}