Welcome‎ > ‎Version 2‎ > ‎Publisher Api (Read/Write)‎ > ‎Data Structures‎ > ‎

Voucher

Includes the details of a voucher to display a printable voucher.

Fields:

  expirationDate - The date the voucher expires.  This data might also be found in html fields.
  fineprint - Html of the fine print for the offer.
  headline - The headline for the offer.
  howToText - Special how to redeem instructions.  Can be the same as redemption instructions.
  merchant - The merchant information for the offer.
  nameOnVoucher - The name displayed on the voucher
  offerId - The id for the offer.
  offerOptionId - The id of the offer option purchased.
  pricing - Pricing information for the offer option purchased
  redemptionInstructions - Html of the redemption instructions. Normally shown on the deal page.
  segmentKey - The segment key offer was purchased for.
  subtitle - The subtitle for the offer.
  voucherCode - The voucher code for the voucher to be given to the merchant.  Also the input for barcode method.
  voucherInstructions - Html of the voucher instructions.  Normally displayed on the preview voucher page.
  voucherTitle - The title that should appear on the voucher.

Sample XML Response:
<voucher>
    <expirationDate>2012-04-10T00:00:00</expirationDate>
    <fineprint>&lt;p&gt;The offer is final and nonrefundable. Redemption of this offer is subject to normal availability; please call at least two days in advance of desired dates. Offer must be redeemed by March 1, 2011. Must be at least 21 years of age to consume alcohol. Offer does not include tax and gratuity. Tax will be calculated at checkout. You're getting a sick deal so please make sure to tip on the full value, you cheap bastard.&lt;/p&gt;</fineprint>
    <headline>Haircut Concierge from Frank's Chop Shop</headline>
    <howToText>
        &lt;p&gt;What's Next:&lt;br /&gt;&#xD;
        1. Purchase.&lt;br /&gt;&#xD;
        2. Contact Frank&amp;rsquo;s Chop Shop using the number provided on your Rewards certificate to make your reservation.&lt;br /&gt;&#xD;
        3. Enjoy your cut, cocktail, and FCS experience&lt;/p&gt;
    </howToText>
    <merchant>
        <address>
            <city>New York</city>
            <country>US</country>
            <latitude>37.21</latitude>
            <longitude>-87.3</longitude>
            <name i:nil="true"/>
            <postalCode>10002</postalCode>
            <state>NY</state>
            <street1>19 Essex St </street1>
            <street2>b/w Hester and Canal St.</street2>
        </address>
        <companyName>Frank's Chop Shop</companyName>
        <id>1013</id>
        <phone>212-555-1211</phone>
        <website>http://www.frankschopshop.com</website>
    </merchant>
    <nameOnVoucher>noahfriend </nameOnVoucher>
    <offerId>126</offerId>
    <offerOptionId>82</offerOptionId>
    <pricing>
        <currency>USD</currency>
        <originalPrice>140</originalPrice>
        <price>70</price>
        <promotionalPrice>0</promotionalPrice>
    </pricing>
    <redemptionInstructions>
        &lt;p&gt;What's Next:&lt;br /&gt;&#xD;
        1. Purchase.&lt;br /&gt;&#xD;
        2. Contact Frank&amp;rsquo;s Chop Shop using the number provided on your Rewards certificate to make your reservation.&lt;br /&gt;&#xD;
        3. Enjoy your cut, cocktail, and FCS experience&lt;/p&gt;
    </redemptionInstructions>
    <segmentKey>ny</segmentKey>
    <subtitle>Half-off Cuts, free scotch &amp; a table reservation at Milk and Honey</subtitle>
    <voucherCode>F-1ED-00-5D5</voucherCode>
    <voucherInstructions>
        &lt;p&gt;What's Next:&lt;br /&gt;&#xD;
        1. Purchase.&lt;br /&gt;&#xD;
        2. Contact Frank&amp;rsquo;s Chop Shop using the number provided on your Rewards certificate to make your reservation.&lt;br /&gt;&#xD;
        3. Enjoy your cut, cocktail, and FCS experience&lt;/p&gt;
    </voucherInstructions>
    <voucherTitle>Frank's Chop Shop</voucherTitle>
</voucher>


Sample JSON Response:
{
    "voucher" : {
        "expirationDate": "\/Date(1334030400000-0400)\/",
        "fineprint": "<p>The offer is final and nonrefundable. Redemption of this offer is subject to normal availability; please call at least two days in advance of desired dates. Offer must be redeemed by March 1, 2011. Must be at least 21 years of age to consume alcohol. Offer does not include tax and gratuity. Tax will be calculated at checkout. You're getting a sick deal so please make sure to tip on the full value, you cheap bastard.<\/p>",
        "headline": "Haircut Concierge from Frank's Chop Shop",
        "howToText": "<p>What's Next:<br \/>\u000d\u000a1. Purchase.<br \/>\u000d\u000a2. Contact Frank&rsquo;s Chop Shop using the number provided on your Rewards certificate to make your reservation.<br \/>\u000d\u000a3. Enjoy your cut, cocktail, and FCS experience<\/p>",
        "merchant": {
            "address": {
                "city": "New York",
                "country": "US",
                "latitude": -63.2,
                "longitude": 74.3,
                "name": null,
                "postalCode": "10002",
                "state": "NY",
                "street1": "19 Essex St ",
                "street2": "b\/w Hester and Canal St."
            },
            "companyName": "Frank's Chop Shop",
            "id": 1013,
            "phone": "212-555-1211",
            "website": "http:\/\/www.frankschopshop.com"
        },
        "nameOnVoucher": "noahfriend ",
        "offerId": 126,
        "offerOptionId": 82,
        "pricing": {
            "currency": "USD",
            "originalPrice": 140,
            "price": 70,
            "promotionalPrice": 0
        },
        "redemptionInstructions": "<p>What's Next:<br \/>\u000d\u000a1. Purchase.<br \/>\u000d\u000a2. Contact Frank&rsquo;s Chop Shop using the number provided on your Rewards certificate to make your reservation.<br \/>\u000d\u000a3. Enjoy your cut, cocktail, and FCS experience<\/p>",
        "segmentKey": "ny",
        "subtitle": "Half-off Cuts, free scotch & a table reservation at Milk and Honey",
        "voucherCode": "F-1ED-00-5D5",
        "voucherInstructions": "<p>What's Next:<br \/>\u000d\u000a1. Purchase.<br \/>\u000d\u000a2. Contact Frank&rsquo;s Chop Shop using the number provided on your Rewards certificate to make your reservation.<br \/>\u000d\u000a3. Enjoy your cut, cocktail, and FCS experience<\/p>",
        "voucherTitle": "Frank's Chop Shop"
    }
}
Comments