Update the applied loyalty information for a check

Updates the applied loyalty information for a specific check.

Securityoauth2 or oauth2
Request
path Parameters
checkGuid
required
string

The GUID of the check to update the applied loyalty information for.

header Parameters
Toast-Restaurant-External-ID
required
string

The identifier of the restaurant.

Request Body schema: application/json

AppliedLoyaltyInfo object containing the updated applied loyalty information.

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"
Responses
200

Check

400

Invalid check GUID or applied loyalty information supplied.

404

Check not found.

patch/checks/{checkGuid}/appliedLoyaltyInfo
Request samples
application/json
{
  • "guid": "string",
  • "entityType": "string",
  • "loyaltyIdentifier": "string",
  • "maskedLoyaltyIdentifier": "string",
  • "vendor": "TOAST",
  • "accrualFamilyGuid": "string",
  • "accrualText": "string"
}
Response samples
application/json
{
  • "guid": "string",
  • "entityType": "string",
  • "externalId": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "openedDate": "2019-08-24T14:15:22Z",
  • "closedDate": "2019-08-24T14:15:22Z",
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "deletedDate": "2019-08-24T14:15:22Z",
  • "deleted": true,
  • "createdByClientName": "string",
  • "splitOrigin": {
    },
  • "selections": [
    ],
  • "customer": {
    },
  • "appliedLoyaltyInfo": {
    },
  • "taxExempt": false,
  • "displayNumber": "string",
  • "appliedServiceCharges": [
    ],
  • "amount": 0,
  • "taxAmount": 0,
  • "totalAmount": 0,
  • "payments": [
    ],
  • "tabName": "string",
  • "paymentStatus": "OPEN",
  • "appliedDiscounts": [
    ],
  • "voided": true,
  • "voidDate": "2019-08-24T14:15:22Z",
  • "voidBusinessDate": 0,
  • "paidDate": "2019-08-24T14:15:22Z",
  • "createdDevice": {
    },
  • "lastModifiedDevice": {
    },
  • "duration": 0,
  • "openedBy": {
    }
}