AppliedLoyaltyInfo

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

• accrualFamilyGuid:
  string

  Response only. An internal Toast platform identifier for loyalty program transactions.

  This is not returned from the initial POST order request and is available at a later time.

• accrualText:
  string

  Response only. A description of the loyalty program transaction to print on the customer's receipt. For example, "Earned 27 points."

  The maximum length of the description string is 255 characters.

  This is not returned from the initial POST order request and is available at a later time.

• entityType required:
  string

  The type of object this is. Response only.

• guid required:
  string

  The GUID maintained by the Toast platform.

• loyaltyIdentifier required:
  string

  An identifier for the loyalty program account. For POST orders, this identifier is transmitted to the loyalty program service provider to associate the check with the loyalty account.

• maskedLoyaltyIdentifier:
  string

  A representation of the identifier of the loyalty program account that can be displayed securely. For example: ************1234. The Toast POS displays this string to restaurant employees and guests.

  You can optionally include this value when you POST an order. It is available in response data when you GET the order.

  If you do not provide a maskedLoyaltyIdentifier when you POST an order, this value is null in response data.

  The Toast POS app displays a masked representation of the loyaltyIdentifier. All characters except the last four are hidden.

• vendor required:
  string

  The specific loyalty program service provider that supports the loyalty account.

  Enum: "TOAST" "PUNCHH" "PUNCHH2" "PAYTRONIX" "APPFRONT" "INTEGRATION"

{
  "guid": "string",
  "entityType": "string",
  "loyaltyIdentifier": "string",
  "maskedLoyaltyIdentifier": "string",
  "vendor": "TOAST",
  "accrualFamilyGuid": "string",
  "accrualText": "string"
}