Voucher
Representation of a Voucher Voucher
export interface Voucher {
'appliedValue'?: Price;
'code'?: string;
'currency'?: Currency;
'description'?: string;
'freeShipping'?: boolean;
'name'?: string;
'value'?: number;
'valueFormatted'?: string;
'valueString'?: string;
'voucherCode'?: string;
}Properties
| Name | Required | Type | Description |
|---|---|---|---|
appliedValue | Optional | Price | {Price} Voucher |
code | Optional | string | The identifier of the Voucher. This is the first part of voucher code which holds first 3 letters, like: 123 {string} Voucher |
currency | Optional | Currency | {Currency} Voucher |
description | Optional | string | Description of the voucher {string} Voucher |
freeShipping | Optional | boolean | Specifies if the order this voucher is applied to is shipped for free (true) or not (false). Defaults to false. {boolean} Voucher |
name | Optional | string | Name of the voucher {string} Voucher |
value | Optional | number | Value of the voucher. Example of such value is: 15.0d {number} Voucher |
valueFormatted | Optional | string | Formatted value of the voucher {string} Voucher |
valueString | Optional | string | The value of the voucher to display. Example: 15.0% {string} Voucher |
voucherCode | Optional | string | Voucher code, is the holder for keeping specific occasional voucher related to business usage. It can be generated and looks like: 123-H8BC-Y3D5-34AL {string} Voucher |