Skip to content

Latest commit

 

History

History
74 lines (50 loc) · 3.67 KB

RedemptionsListResponseBodyRedemptionsItem.md

File metadata and controls

74 lines (50 loc) · 3.67 KB
Raw

RedemptionsListResponseBodyRedemptionsItem

Properties

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
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 RedemptionsListResponseBodyRedemptionsItemRelatedRedemptions
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 RedemptionsListResponseBodyRedemptionsItemOrder
channel RedemptionsListResponseBodyRedemptionsItemChannel
customer RedemptionsListResponseBodyRedemptionsItemCustomer
relatedObjectType RelatedObjectTypeEnum Defines the related object.
relatedObjectId String
voucher RedemptionsListResponseBodyRedemptionsItemVoucher
promotionTier RedemptionsListResponseBodyRedemptionsItemPromotionTier
reward RedemptionRewardResult
gift RedemptionsListResponseBodyRedemptionsItemGift
loyaltyCard RedemptionsListResponseBodyRedemptionsItemLoyaltyCard
reason String System generated cause for the redemption being invalid in the context of the provided parameters.

Enum: ObjectEnum

Name Value
REDEMPTION "redemption"
REDEMPTION_ROLLBACK "redemption_rollback"

Enum: ResultEnum

Name Value
SUCCESS "SUCCESS"
FAILURE "FAILURE"

Enum: StatusEnum

Name Value
SUCCEEDED "SUCCEEDED"
FAILED "FAILED"
ROLLED_BACK "ROLLED_BACK"

Enum: RelatedObjectTypeEnum

Name Value
VOUCHER "voucher"
PROMOTION_TIER "promotion_tier"
REDEMPTION "redemption"