Documentation Portal

Description

String

Loyalty Voucher’s textual description

No

DiscountValue

Decimal

Value of the discount based on the Loyalty Voucher. This value should be specified in the end customer’s currency, after applying country coefficient, FX conversion and IncludeVAT handling.

IsApplied

Boolean

Indicates if the Loyalty Voucher is already applied by the end customer to the current cart

LocalVATRate

Decimal

The VAT rate to be applied to the discount based on this Loyalty Voucher if the order was placed by the local customer. This value must be specified if UseCountryVAT for the current Country is TRUE and therefore VATRate property actually denotes the VAT for the target country.

No

Name

String

Loyalty Voucher’s name

OriginalDiscountValue

Decimal

The discount value to which the end customer is entitled if this Loyalty Voucher is applied to the cart. This value should be specified in the original Merchant currency including the local VAT, before applying any price modifications. This property always denotes the discount value in the default Merchant’s country, regardless of UseCountryVAT for the end customer’s current country.

VATRate

Decimal

The VAT rate applied to the discount based on this Loyalty Voucher

VoucherCode

String

Code used to identify the Loyalty Voucher on the Merchant’s site