LoyaltiesMembersRedemptionRedeemResponseBody.md

LoyaltiesMembersRedemptionRedeemResponseBody

Response body schema for POST /loyalties/{campaignId}/members/{memberId}/redemption and for POST /loyalties/members/{memberId}/redemption.

Properties

Name	Type	Description
id	String	Unique redemption ID.
_object	ObjectEnum	The type of the object represented by the JSON
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.
redemption	String	Unique redemption ID of the parent redemption.
result	ResultEnum	Redemption result.
status	StatusEnum	Redemption status.
relatedRedemptions	RedemptionRelatedRedemptions
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	OrderCalculatedNoCustomerData
channel	RedemptionChannel
customer	SimpleCustomer
relatedObjectType	RelatedObjectTypeEnum	Defines the related object.
relatedObjectId	String	Unique related object ID assigned by Voucherify, i.e. v_lfZi4rcEGe0sN9gmnj40bzwK2FH6QUno for a voucher.
voucher	RedemptionVoucher
promotionTier	PromotionTier
reward	RedemptionRewardResult
gift	RedemptionGift
loyaltyCard	RedemptionLoyaltyCard

Enum: ObjectEnum

Name	Value
REDEMPTION	"redemption"

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"