Key to field values
| Fieldname | Description | Example value | Req |
|---|---|---|---|
| VoucherID | The ID of your template voucher (must be in the "READY" state) Mandatory | R1PP-F9WI-3F5Q-PM17-3E23 | Y |
| SerialID | The SerialID of your template voucher (optional) | 13Oct0023 | N |
| CustTitle |
Customer's title Optional, but gives a good impression to the customer |
Mr, Mrs, Ms, Prof | N |
| CustCName | Customer's Forename | Fred | N |
| CustSName | Customer's surname | Smith | N |
| CustEmail | Customer's Email address - this will form the basis of their identity in dmClub Mandatory | fred@thesmiths.com | Y |
| CustPhone | Customer's phone number | 07777-123-456 | N |
| CustAddr1 | Customer's address (this makes it easier for when they setup billing) | 70 Acacia Avenue | N |
| CustAddr2 | Customer's address line 2 | Toytown | N |
| CustAddr3 | Customer's address line 3 | Hamleyshire | N |
| CustCountry | Customer's address country | United Kingdom | N |
| CustPostcode | Customer's postcode (eg. ) | EC1Y 4HG | N |
| DlrCampaign | Your dealership campaign code (useful for tracking the success of various sales and marketing initiatives) | PetShowMar14 | N |
| DlrRef1 | Your own reference 1 (eg. The customer's account reference on your own systems) This is purely for your own use, but might be good for analysis | DG4556 | N |
| DlrRef2 | Your own reference 2 (eg. Who closed the sale) This is purely for your own use, but might be good for analysis | HGD | N |
| SendVoucherEmail | Should the system send an email (to Customer and Dealer) indicating that a voucher has been issued and basic instructions on how to redeem it. | N | N |
Debug mode
In normal operation, the Voucher API will return pure XML to the server that made the request.
The Debug option converts the XML into HTML to display in the Response frame to allow for easy human inspection.