Skip to main content

Voyado Engage

Voucher export (XML)

Voyado Engage can export vouchers as XML. By doing this, you can export both new (unused) and redeemed reward vouchers to third party systems.

Field descriptions

Only one contact field (marked with *) can be used together with contactKey.

Field

Example value

Description

checkNumber

0000000111751

An incremental number and the start value can be decided by the client and set by a product specialist.

contactKey

1000005760

The key value set in the environment for the client.

amount

40.0000

The monetary amount of the voucher. Applied as a payment method or discount on receipt.

validFrom

2020-04-21T00:00:00

Date and time from when the voucher is valid

expires

2021-04-21T00:00:00

Date and time when the voucher expires

bonusPoints

2000.0000

Amount of bonus points withdrawn to generate voucher.

usedDate

2020-06-21T00:00:00

Date and time when the voucher was redeemed in Voyado.

contactId*

67ea9958-0e09-484f-b4c4-aa3e00e1e24c

Voyado Contact ID number.

externalId*

1526235

Identification key from external systems. Used when Voyado isn’t master.

memberNumber*

12345678

Contact's member number.

socialSecurityNumber*

198205021789

Contact's social security number.

email*

jane.doe@example.com

Contact's email address.

mobilePhone*

+46702291216

Contact's mobile phone number.

Default XML-format

This export cannot be transformed or modified through an XSLT-transformation. The format is set.

New (unused) vouchers
<?xml version="1.0" encoding="utf-8"?>
<bonusChecks>
  <new>
    <checkNumber>0000000111751</checkNumber>
    <contactKey>1000005760</contactKey>
    <amount>40.0000</amount>
    <validFrom>2020-04-21T00:00:00</validFrom>
    <expires>2020-12-31T23:59:59</expires>
    <bonusPoints>2000.0000</bonusPoints>
    <mobilePhone>+46702291216 </mobilePhone>
  </new>
...
Redeemed vouchers
...
  <used>
    <checkNumber>0000000110099</checkNumber>
    <contactKey>7000247</contactKey>
    <usedDate>2020-04-23T10:27:27</usedDate>
  </used>
</bonusChecks>
Settings and limit

These are the settings for the export.

vouchers-xml-export.png

Caution

10,000 vouchers per file is considered the limit. Don't exceed this.