AppliedLoyaltyInfo

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

• accrualFamilyGuid:
  string

  An internal Toast POS identifier for loyalty program transactions.

• accrualText:
  string

  A description of the loyalty program transaction that will be printed on the customer's reciept. For example, "Earned 27 points." The maximum length of the description string is 255 characters.

• entityType required:
  string

  The type of object this is.

• guid required:
  string

  The GUID maintained by Toast.

• loyaltyIdentifier required:
  string

  An identifier for the loyalty program account.

• vendor required:
  string

  The specific loyalty program service provider that supports the loyalty account. For all interactions with the Loyalty Integration API, this value will be INTEGRATION.

  Value: "INTEGRATION"

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