AppliedDiscount

A wrapper object with fields that allow reference to a Toast entity by Toast GUID.

appliedPromoCode
string

The promo code that was applied for this discount.

object (ExternalReference)

A wrapper object with fields that allow reference to a Toast entity by Toast GUID.

Array of objects (ExternalReference)

A List of Menu Item Selections that this discount is applied to (empty for NonCombo Discounts).

object (ToastReference)

A wrapper object with fields that allow reference to a Toast entity by Toast GUID.

discountAmount
number <double>

The discount amount in USD. This amount will be subtracted from the check or item.

entityType
required
string

The type of object this is.

guid
required
string

The GUID maintained by Toast.

object (LoyaltyDetails)

Information about the loyalty program discount applied to a check. The loyalty program account is identified in the AppliedLoyaltyInfo value for the check.

name
string

The name of the applied discount.

nonTaxDiscountAmount
number <double>

The amount that a discount reduces a menu item price, excluding any discount amount applied to taxes. In most cases, a discount only applies to the menu item price and the nonTaxDiscountAmount is the same as the discountAmount. If you apply a discount to a menu item that includes tax in its price, the nonTaxDiscountAmount is less than the full discount amount.

processingState
string

Applies to loyalty program discounts only. Loyalty program reward discounts are validated and then applied, or redeemed, by the third-party loyalty program service provider depending on the state of the Toast POS order. This value indicates the state of the discount in that validation and application process. Response only. The processingState may be one of the following enumerated values.

  • PENDING_APPLIED - The loyalty program service provider has confirmed that the reward discount is valid for the order and customer. The reward has not been redeemed, or applied to the customer's loyalty account.
  • APPLIED - The reward discount has been redeemed. The reward is no longer available from the customer's loyalty program account.
  • PENDING_VOID - The reward discount has been removed from the Toast POS order. The reward is not available from the customer's loyalty program account until the loyalty program service provider processes the void operation.
  • VOID - The reward discount has been removed from the Toast POS order and the reward is available from the customer's loyalty program account again.
Enum: "PENDING_APPLIED" "APPLIED" "PENDING_VOID" "VOID"
Array of objects (AppliedDiscountTrigger)

Optional items which triggered this discount.

{
  • "guid": "string",
  • "entityType": "string",
  • "name": "string",
  • "discountAmount": 0,
  • "nonTaxDiscountAmount": 0,
  • "discount": {
    },
  • "triggers": [
    ],
  • "approver": {
    },
  • "processingState": "PENDING_APPLIED",
  • "loyaltyDetails": {
    },
  • "comboItems": [
    ],
  • "appliedPromoCode": "string"
}