Skip to content
This repository has been archived by the owner on Sep 3, 2024. It is now read-only.

Latest commit

 

History

History
32 lines (29 loc) · 3.07 KB

RedemptionEntry.md

File metadata and controls

32 lines (29 loc) · 3.07 KB

# RedemptionEntry

Properties

Name Type Description Notes
id string [optional]
object string [optional]
date \DateTime Timestamp representing the date and time when the object was created. The value is shown in the ISO 8601 format. [optional]
customer_id string Unique customer ID of the redeeming customer. [optional]
tracking_id string Hashed customer source ID. [optional]
metadata object [optional]
amount int 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. [optional]
redemption string Unique redemption ID of the parent redemption. [optional]
result string Redemption result. [optional]
status string [optional]
related_redemptions \OpenAPI\Client\Model\RedemptionEntryRelatedRedemptions [optional]
failure_code string If the result is `FAILURE`, this parameter will provide a generic reason as to why the redemption failed. [optional]
failure_message string If the result is `FAILURE`, this parameter will provide a more expanded reason as to why the redemption failed. [optional]
order \OpenAPI\Client\Model\RedemptionEntryOrder [optional]
channel \OpenAPI\Client\Model\RedemptionEntryChannel [optional]
customer \OpenAPI\Client\Model\RedemptionEntryCustomer [optional]
related_object_type string Defines the related object. [optional]
related_object_id string [optional]
voucher \OpenAPI\Client\Model\RedemptionEntryVoucher [optional]
promotion_tier \OpenAPI\Client\Model\RedemptionEntryPromotionTier [optional]
reward \OpenAPI\Client\Model\RedemptionRewardResult [optional]
gift \OpenAPI\Client\Model\RedemptionEntryGift [optional]
loyalty_card \OpenAPI\Client\Model\RedemptionEntryLoyaltyCard [optional]
reason string System generated cause for the redemption being invalid in the context of the provided parameters. [optional]

[Back to Model list] [Back to API list] [Back to README]