| Name | Type | Description |
|---|---|---|
| id | String | |
| _object | ObjectEnum | |
| date | OffsetDateTime | Timestamp representing the date and time when the object was created. The value is shown in the ISO 8601 format. |
| customerId | String | Unique customer ID of the redeeming customer. |
| trackingId | String | Hashed customer source ID. |
| metadata | Object | The metadata object stores all custom attributes assigned to the redemption. |
| amount | Integer | For gift cards, this is a positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the number of redeemed credits. For loyalty cards, this is the number of loyalty points used in the transaction. and For gift cards, this represents the number of the credits restored to the card in the rolledback redemption. The number is a negative integer in the smallest currency unit, e.g. -100 cents for $1.00 added back to the card. For loyalty cards, this represents the number of loyalty points restored to the card in the rolledback redemption. The number is a negative integer. |
| redemption | String | Unique redemption ID of the parent redemption. |
| result | ResultEnum | Redemption result. |
| status | StatusEnum | |
| relatedRedemptions | RedemptionEntryRelatedRedemptions | |
| failureCode | String | If the result is `FAILURE`, this parameter will provide a generic reason as to why the redemption failed. |
| failureMessage | String | If the result is `FAILURE`, this parameter will provide a more expanded reason as to why the redemption failed. |
| order | RedemptionEntryOrder | |
| channel | RedemptionEntryChannel | |
| customer | RedemptionEntryCustomer | |
| relatedObjectType | RelatedObjectTypeEnum | Defines the related object. |
| relatedObjectId | String | |
| promotionTier | RedemptionEntryPromotionTier | |
| reward | RedemptionRewardResult | |
| gift | RedemptionEntryGift | |
| loyaltyCard | RedemptionEntryLoyaltyCard | |
| voucher | RedemptionEntryVoucher | |
| reason | String | System generated cause for the redemption being invalid in the context of the provided parameters. |
| Name | Value |
|---|---|
| REDEMPTION | "redemption" |
| REDEMPTION_ROLLBACK | "redemption_rollback" |
| Name | Value |
|---|---|
| SUCCESS | "SUCCESS" |
| FAILURE | "FAILURE" |
| Name | Value |
|---|---|
| SUCCEEDED | "SUCCEEDED" |
| FAILED | "FAILED" |
| ROLLED_BACK | "ROLLED_BACK" |
| Name | Value |
|---|---|
| VOUCHER | "voucher" |
| PROMOTION_TIER | "promotion_tier" |
| REDEMPTION | "redemption" |