The YYYYMMDD integer for the business date that the promotion was applied at the given restaurant.

The date when this promotion was applied. If not specified, set to the current system time. Use ISO 8601 date and time format for all Toast APIs.

This GUID corresponds to an AppliedDiscount.guid contained in Check.appliedDiscounts, and indicates the applied discount that is associated with the promotion.

Internal-only message that developers can use to better understand the error.

The dollar amount of the discount that was applied. Please note that this amount should not include tax. Toast handles all tax calculations for discounts.

A specific type for well-known error states.

• INVALID_REQUEST - Request does not contain proper or expected parameters or is otherwise malformed.
• CODE_ALREADY_USED - The promotion code has already been used the maximum number of times.
• CODE_NOT_EXIST - The promotion code does not exist.
• CODE_NOT_APPLY - The promotion code does not apply to the given check.
• CODE_INACTIVE - The promotion code was never activated for usage or was otherwise deactivated.
• OTHER - The error cannot be categorized as one of the types listed above.

The Toast-Transaction-GUID from the VERIFY request made to produce this applied promotion. This field should be populated by the provider in the response for verify requests.

The name of the applied discount. The name must be supplied by vendor and be guest-friendly, as it will appear on both the POS and the receipt.

The promotion code that was applied for this discount.

A string field that can be used by partners to store some id. Can only be filled on the VERIFY request; the response value will be included on the promotion for future requests.