RedemptionRollback.md

RedemptionRollback

This is an object representing a redemption rollback.

Properties

Name	Type	Description	Notes
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.	[optional]
trackingId	String	Hashed customer source ID.	[optional]
metadata	Object	The metadata object stores all custom attributes assigned to the redemption.	[optional]
amount	Integer	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]
reason	String	System generated cause for the redemption being invalid in the context of the provided parameters.	[optional]
result	ResultEnum	Redemption result.
status	StatusEnum	Redemption status.
relatedRedemptions	RedemptionRollbackRelatedRedemptions		[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	OrderCalculatedNoCustomerData		[optional]
channel	RedemptionChannel
customer	SimpleCustomer		[optional]
relatedObjectType	RelatedObjectTypeEnum	Defines the related object.
relatedObjectId	String	Unique related object ID assigned by Voucherify, i.e. v_lfZi4rcEGe0sN9gmnj40bzwK2FH6QUno for a voucher.
voucher	Voucher		[optional]
promotionTier	PromotionTier		[optional]
reward	RedemptionRewardResult		[optional]
gift	RedemptionGift		[optional]
loyaltyCard	RedemptionLoyaltyCard		[optional]

Enum: ObjectEnum

Name	Value
REDEMPTION_ROLLBACK	"redemption_rollback"

Enum: ResultEnum

Name	Value
SUCCESS	"SUCCESS"
FAILURE	"FAILURE"

Enum: StatusEnum

Name	Value
SUCCEEDED	"SUCCEEDED"
FAILED	"FAILED"

Enum: RelatedObjectTypeEnum

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