PromotionRequest

A request to verify, revalidate, apply, or void a Promotion to a Check. There are three types (VERIFY, APPLY, and VOID), which have different required fields for their respective requests.

VERIFY requests contain check, appliedPromotions, requestDateTime, and requestUser.

required
Array of objects (AppliedPromotion)

A list of promotions applied on the check, linked to their AppliedDiscount. Includes metadata about promotions.

required
object (Check)

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

checkGuid
string

The unique identifier of the check to which the promotions were applied.

object (PromotionObject)

An object to encapsulate information about a promotion.

orderOpenedBusinessDate
integer

The business date (yyyyMMdd) on which this order was opened.

orderOpenedDate
string <date-time>

The date the corresponding Order was opened.

Array of objects (AppliedPromotion)

Specific promotions that a request should act on (such as void or apply all of the supplied promotions).

requestBusinessDate
integer

The business date (yyyyMMdd) on which this request was created.

requestDateTime
required
string <date-time>

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

object (ExternalReference)

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

{
  • "check": {
    },
  • "checkGuid": "string",
  • "appliedPromotions": [
    ],
  • "newPromotion": {
    },
  • "promotionsToActOn": [
    ],
  • "requestDateTime": "2019-08-24T14:15:22Z",
  • "requestBusinessDate": 0,
  • "requestUser": {
    },
  • "orderOpenedDate": "2019-08-24T14:15:22Z",
  • "orderOpenedBusinessDate": 0
}