Information needed to complete an inquire, redeem, or accrue transaction. Included if the toastTransactionType is one of LOYALTY_INQUIRE, LOYALTY_REDEEM, or LOYALTY_ACCRUE, absent otherwise.
object (Check) A wrapper object with fields that allow reference to a Toast entity by Toast GUID. | |
loyaltyIdentifier | string Unique identifier of the loyalty account. Format will vary by provider. |
orderGuid | string The Toast POS system identifier for the order that contains the check. |
Array of objects (Redemption) List of offers to be redeemed, or already redeemed on a check. If this is the
first time this particular Redemption has been present in a request (as part of
this customer interaction), it will be present in this list but not on the Check.
If a Redemption has been previously validated, it will be present both in this list
and on the Check as an |
{- "loyaltyIdentifier": "string",
- "orderGuid": "string",
- "check": {
- "guid": "string",
- "entityType": "string",
- "externalId": "string",
- "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,
- "selections": [
- {
- "guid": "string",
- "entityType": "string",
- "externalId": "string",
- "item": {
- "guid": "string",
- "entityType": "string",
- "multiLocationId": null,
- "externalId": "string"
}, - "itemGroup": {
- "guid": "string",
- "entityType": "string",
- "multiLocationId": null,
- "externalId": "string"
}, - "optionGroup": {
- "guid": "string",
- "entityType": "string",
- "multiLocationId": null,
- "externalId": "string"
}, - "preModifier": {
- "guid": "string",
- "entityType": "string",
- "multiLocationId": null,
- "externalId": "string"
}, - "quantity": 0,
- "unitOfMeasure": "NONE",
- "selectionType": "NONE",
- "salesCategory": {
- "guid": "string",
- "entityType": "string",
- "multiLocationId": null,
- "externalId": "string"
}, - "appliedDiscounts": [
- {
- "guid": "string",
- "entityType": "string",
- "name": "string",
- "discountAmount": 0,
- "nonTaxDiscountAmount": 0,
- "discount": {
- "guid": "string",
- "entityType": "string"
}, - "triggers": [
- {
- "selection": null,
- "quantity": null
}
], - "approver": {
- "guid": "string",
- "entityType": "string",
- "externalId": "string"
}, - "processingState": "PENDING_APPLIED",
- "loyaltyDetails": {
- "vendor": "INTEGRATION",
- "referenceId": "string"
}, - "comboItems": [
- {
- "guid": null,
- "entityType": null,
- "externalId": null
}
], - "appliedPromoCode": "string"
}
], - "deferred": true,
- "preDiscountPrice": 0,
- "price": 0,
- "tax": 0,
- "voided": true,
- "voidDate": "2019-08-24T14:15:22Z",
- "voidBusinessDate": 0,
- "voidReason": {
- "guid": "string",
- "entityType": "string",
- "externalId": "string"
}, - "displayName": "string",
- "createdDate": "2019-08-24T14:15:22Z",
- "modifiedDate": "2019-08-24T14:15:22Z",
- "modifiers": [
- { }
], - "fulfillmentStatus": "NEW",
- "taxInclusion": "INCLUDED",
- "appliedTaxes": [
- {
- "guid": "string",
- "entityType": "string",
- "taxRate": {
- "guid": "string",
- "entityType": "string"
}, - "name": "string",
- "rate": 0,
- "taxAmount": 0,
- "type": "PERCENT"
}
]
}
], - "appliedLoyaltyInfo": {
- "guid": "string",
- "entityType": "string",
- "loyaltyIdentifier": "string",
- "vendor": "INTEGRATION",
- "accrualFamilyGuid": "string",
- "accrualText": "string"
}, - "taxExempt": false,
- "displayNumber": "string",
- "appliedServiceCharges": [
- {
- "guid": "string",
- "entityType": "string",
- "externalId": "string",
- "chargeAmount": 0,
- "serviceCharge": {
- "guid": "string",
- "entityType": "string",
- "externalId": "string"
}, - "chargeType": "FIXED",
- "name": "string",
- "delivery": true,
- "gratuity": true,
- "taxable": true,
- "appliedTaxes": [
- {
- "guid": "string",
- "entityType": "string",
- "taxRate": {
- "guid": "string",
- "entityType": "string"
}, - "name": "string",
- "rate": 0,
- "taxAmount": 0,
- "type": "PERCENT"
}
]
}
], - "amount": 0,
- "taxAmount": 0,
- "totalAmount": 0,
- "payments": [
- {
- "guid": "string",
- "entityType": "string",
- "externalId": "string",
- "paidDate": "2019-08-24T14:15:22Z",
- "paidBusinessDate": 0,
- "type": "CASH",
- "cardEntryMode": "SWIPED",
- "amount": 0,
- "tipAmount": 0,
- "amountTendered": 0,
- "cardType": "VISA",
- "last4Digits": "string",
- "originalProcessingFee": 0,
- "server": {
- "guid": "string",
- "entityType": "string",
- "externalId": "string"
}, - "cashDrawer": {
- "guid": "string",
- "entityType": "string",
- "externalId": "string"
}, - "refundStatus": "NONE",
- "refund": {
- "refundAmount": 0,
- "tipRefundAmount": 0,
- "refundDate": "2019-08-24T14:15:22Z",
- "refundBusinessDate": 0
}, - "paymentStatus": "OPEN",
- "voidInfo": {
- "voidUser": {
- "guid": "string",
- "entityType": "string",
- "externalId": "string"
}, - "voidApprover": {
- "guid": "string",
- "entityType": "string",
- "externalId": "string"
}, - "voidDate": "2019-08-24T14:15:22Z",
- "voidBusinessDate": 0,
- "voidReason": {
- "guid": "string",
- "entityType": "string",
- "externalId": "string"
}
}, - "houseAccount": {
- "guid": "string",
- "entityType": "string",
- "externalId": "string"
}, - "otherPayment": {
- "guid": "string",
- "entityType": "string",
- "externalId": "string"
}, - "createdDevice": {
- "id": "string"
}, - "lastModifiedDevice": {
- "id": "string"
}, - "mcaRepaymentAmount": 0
}
], - "tabName": "string",
- "paymentStatus": "OPEN",
- "appliedDiscounts": [
- {
- "guid": "string",
- "entityType": "string",
- "name": "string",
- "discountAmount": 0,
- "nonTaxDiscountAmount": 0,
- "discount": {
- "guid": "string",
- "entityType": "string"
}, - "triggers": [
- {
- "selection": {
- "guid": "string",
- "entityType": "string",
- "externalId": "string"
}, - "quantity": 0
}
], - "approver": {
- "guid": "string",
- "entityType": "string",
- "externalId": "string"
}, - "processingState": "PENDING_APPLIED",
- "loyaltyDetails": {
- "vendor": "INTEGRATION",
- "referenceId": "string"
}, - "comboItems": [
- {
- "guid": "string",
- "entityType": "string",
- "externalId": "string"
}
], - "appliedPromoCode": "string"
}
], - "voided": true,
- "voidDate": "2019-08-24T14:15:22Z",
- "voidBusinessDate": 0,
- "paidDate": "2019-08-24T14:15:22Z",
- "createdDevice": {
- "id": "string"
}, - "lastModifiedDevice": {
- "id": "string"
}
}, - "redemptions": [
- {
- "identifier": "string",
- "selectionGuid": "string",
- "appliedDiscountGuid": "string",
- "multiItemDiscountGuid": "string",
- "amount": 0,
- "itemApplication": [
- {
- "selectionIdentifier": "string",
- "amount": 0,
- "appliedDiscountIdentifier": null
}
], - "quantity": 0
}
]
}