Skip to content

RedemptionsGetResponseBody.md

Latest commit

 

History

History
74 lines (50 loc) · 3.5 KB

RedemptionsGetResponseBody.md

File metadata and controls

74 lines (50 loc) · 3.5 KB
Raw

RedemptionsGetResponseBody

Properties

Name Type Description Notes
id String Unique redemption ID.
_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. [optional]
trackingId String Hashed customer source ID. [optional]
metadata Object [optional]
amount Integer A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the amount of redeemed credits on a gift card. and A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts. [optional]
redemption String Unique redemption ID of the parent redemption. [optional]
result ResultEnum Redemption result.
status StatusEnum
relatedRedemptions RedemptionsGetResponseBodyRelatedRedemptions [optional]
failureCode String If the result is `FAILURE`, this parameter will provide a generic reason as to why the redemption failed. [optional]
failureMessage String If the result is `FAILURE`, this parameter will provide a more expanded reason as to why the redemption failed. [optional]
order RedemptionsGetResponseBodyOrder [optional]
channel RedemptionsGetResponseBodyChannel
customer RedemptionsGetResponseBodyCustomer [optional]
relatedObjectType RelatedObjectTypeEnum Defines the related object.
relatedObjectId String Unique related object ID assigned by Voucherify, i.e. v_lfZi4rcEGe0sN9gmnj40bzwK2FH6QUno for a voucher.
voucher RedemptionsGetResponseBodyVoucher [optional]
promotionTier RedemptionsGetResponseBodyPromotionTier [optional]
reward RedemptionRewardResult [optional]
gift RedemptionsGetResponseBodyGift [optional]
loyaltyCard RedemptionsGetResponseBodyLoyaltyCard [optional]
reason String System generated cause for the redemption being invalid in the context of the provided parameters. [optional]

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"