Redemption Details (Object)
The redemption_details object returns information about a redemption done by a user.
- campaignType: string
_name Name of the campaign through which the guest received the offer
- createdType: string
_at Date/time when the redemption was created in the system
- expiringType: string
_at Date/time when the redemption_tracking_code expires and the user cannot use it at the POS
- locationType: integer
_id Location ID at which the redemption code is generated. If no location ID is provided, then it returns the ID of the default location.
- redeemableType: string
_description Description of the redeemable
- redeemableType: integer
_id Unique ID of the redeemable
- redeemableType: string
_name Name of the redeemable
- redeemedType: string
_value In case of a business with banked_currency, a currency value will be returned. For example, a value of 10 would mean $10.
In case of a business without banked_currency, points will be returned. For example, a value of 10 would mean 10 points.
- redemptionType: integerFormat: int64
_id Unique ID of the redemption
- redemptionType: string
_image _url URL of the image depicting the redeemable. It can be displayed in the app.
- redemptionType: string
_message A descriptive message that tells the user what has been redeemed
- redemptionType: string
_status Status of the redemption. The values returned can be:
-
redeemable: The redemption can be redeemed at the POS.
-
expired: The redemption has expired and becomes unusable for the user.
-
honoured: The redemption has already been processed successfully and redeemed by the user at the POS.
-
cancelled: The redemption can be voided by a user at the POS in case a redemption is done by mistake and the user wants to cancel it.
-
- redemptionType: string
_tracking _code Code that a user must submit at the POS to receive the redeemed reward
- updatedType: string
_at Date/time at which the redemption was updated in the system
