Skip to content

Voucher-V2 Properties

Overview

Scalar properties will always be included in a response, unless otherwise specified.

Generic Properties

Voucher Type

Key Name: voucherType

Example: "giftcard-provider"

The type of Voucher, mainly used for internal purposes. Currently in-use types are: tillo, wegift, stored and form-redemption.

Segment ID

Key Name: segment.id

Example: "b15b2302-abc7-11ea-bb37-0242ac130002"

This is the unique identifier for the segment that was claimed. E.g the Supermarket that the user chose when claiming their huggg.

Segment Name

Key Name: segment.name

Example: "Sainsbury's"

The friendly display name of the segment.

Segment voucherType

Key Name: segment.voucherType

Example: "giftcard-provider"

The type of voucher for the specific segment. Currently in-use types are: tillo, wegift, stored and form-redemption.

Expiry Date

Key Name: expiresAt

Example: "2022-05-30T21:34:30+0000"

The expiration date of this Voucher.

Created Date

Key Name: dateCreated

Example: "2022-05-30T21:34:30+0000"

The creation date of this Voucher (i.e when it was claimed).

Modified Date

Key Name: dateModified

Example: "2022-05-30T21:34:30+0000"

The modification date of this Voucher (i.e when it was update).

Huggg ID

Key Name: hugggId

Example: "a94b9f16-abc7-11ea-bb37-0242ac130002"

The identifier of the huggg for which this Voucher is associated with.

Data

Key Name: data

Example:

[{
    "type": "url",
    "label": "Click for your voucher",
    "value": "https://unique.link.to.your.giftcard/giftcard"
}]

This is an array containing a variety of different types of output for a voucher. These currently include: url, alpha/url, alpha/text and examples of these are shown below. The label property of each data entry is the label we display for that piece of data (in the case of 'url' this is the button label), the value is the actual piece of information whether that be a URL or a piece of text or a code.

Example url:

[{
    "type": "url",
    "label": "Click for your voucher",
    "value": "https://unique.link.to.your.giftcard/giftcard"
}]

url is a URL to claim the voucher.

Example alpha/url:

[{
    "type": "alpha/url",
    "value": "unique-voucher-code"
}]

alpha/url is a code associated with the URL.

Example alpha/text:

[{
    "type": "alpha/text",
    "label": "Dietary Choice",
    "value": "Regular Brownies"
}]

alpha/text is a piece of text.