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

Offer Detail

Will include the detailed details of an offer.  This is returned for from the Offer - By Id method.

Fields:

  offerId - The offer Id of this offer.
  headline - The headline for the offer.
  subtitle - The subtitle for the offer.
  copy - Any copy associated with the offer.
  redemptionInstructions - Any special redemption instructions to redeem the offer.
  hasSoldOut - Bool that determines if the offer is currently sold out.
  maxQuantityPerBuyer - If there is a maximum quantity each buyer can purchase.  -1 implies no max.
  images - List of Offer Image
  url - The permalink for the offer.
  fineprint - Html of the fine print of the offer.
  highlights - Html of the highlights for the offer.
  hasEnded - Bool that determines if the offer has ended.
  startDate - UTC start date.
  endDate - UTC of the end date.
  merchant - The merchant information for the offer.
  locations - List of Address the offer applies to.  Typically only one.
  options - List of Offer Options.
  segments - List of all segments the offer is running in.
  rank - The relative view order for the offer.
  customFields - A key/value collection of custom text fields defined by the publisher.  eg AdditionalCopy, AdditionalCopy1, EmailSubjectLine
  numberSold - The total number of vouchers sold across all options.
  demandStrategy - The demand strategy defined in the Publisher Admin tool for the offer.
  pricingStrategy - The pricing strategy defined in the Publisher Admin tool for the offer.
  offerKey - The url fragment of the title for the deal.
  video - The video information on the offer.
  maxGiftQuantityPerBuyer - The maximum number of items that can be gifted per purchase.
  classifications - List of classifications for the offer.

 
Sample XML Response:
<offerDetail>
    <copy>&lt;p&gt;Description&lt;/p&gt;</copy>
    <customFields>
        <field>
            <key>AdditionalCopy</key>
            <value i:nil="true"/>
        </field>
        <field>
            <key>AdditionalCopy2</key>
            <value i:nil="true"/>
        </field>
        <field>
            <key>AdditionalCopy3</key>
            <value i:nil="true"/>
        </field>
        <field>
            <key>EmailSubjectLine</key>
            <value>email subject line</value>
        </field>
    </customFields>
    <endDate>2012-01-30T05:00:00</endDate>
    <fineprint>&lt;p&gt;Fine print&lt;/p&gt;</fineprint>
    <hasEnded>false</hasEnded>
    <hasSoldOut>false</hasSoldOut>
    <headline>This is the DEAL title</headline>
    <highlights>
        &lt;ol&gt;&#xD;
        &lt;li&gt;highlights&lt;/li&gt;&#xD;
        &lt;/ol&gt;
    </highlights>
    <images>
        <image>
            <caption i:nil="true"/>
            <displayOrder>1</displayOrder>
            <isOfferImage>True</isOfferImage>
            <size>620x270</size>
            <tags/>
            <url>http://gcs-dev.s3.amazonaws.com/shared/images/deals/114/174/hatch.png</url>
        </image>
    </images>
    <locations>
        <address>
            <city>New York</city>
            <country>US</country>
            <latitude>4</latitude>
            <longitude>5</longitude>
            <name i:nil="true"/>
            <postalCode>x</postalCode>
            <state>NY</state>
            <street1>x</street1>
            <street2 i:nil="true"/>
        </address>
    </locations>
    <maxQuantityPerBuyer>100</maxQuantityPerBuyer>
   
<maxGiftQuantityPerBuyer>50</maxGiftQuantityPerBuyer>
    <merchant>
        <address>
            <city>New York</city>
            <country>US</country>
            <latitude>4</latitude>
            <longitude>5</longitude>
            <name i:nil="true"/>
            <postalCode>x</postalCode>
            <state>NY</state>
            <street1>x</street1>
            <street2 i:nil="true"/>
        </address>
        <companyName>Manhattan Kayak Company</companyName>
        <id>6</id>
        <phone>x</phone>
        <website>http://www.manhattankayak.com/blogs/</website>
    </merchant>
    <offerId>174</offerId>
    <rank>0</rank>
    <redemptionInstructions i:nil="true"/>
    <segments>
        <segment>
            <key>new-york</key>
            <name>New York</name>
        </segment>
    </segments>
    <startDate>2010-12-21T05:00:00</startDate>
    <subtitle>This is the subtitle</subtitle>
    <url>http://dealstest.dailycandy.com/deal/174/this-is-the-deal-title</url>
    <classifications>
        <classification>
            <key>no_sub_classification</key>
            <parentKey>no_classification</parentKey>
        </classification>
        <classification>
            <key>amateursportsteams</key>
            <parentKey>active</parentKey>
        </classification>
    </categories>
    <demandStrategy>NotSpecified</demandStrategy>
    <numberSold>10</numberSold>
    <options>
        <option>
            <blurb>&lt;p&gt;Description&lt;/p&gt;</blurb>
            <hasSoldOut>false</hasSoldOut>
            <inventoryRemaining>990</inventoryRemaining>
            <maxQuantity>1000</maxQuantity>
            <numberSold>10</numberSold>
            <offerOptionId>125</offerOptionId>
            <pricing>
                <currency>USD</currency>
                <originalPrice>100</originalPrice>
                <price>15</price>
                <promotionalPrice i:nil="true"/>
            </pricing>
            <title>This is the DEAL title</title>
        </option>
    </options>
    <offerKey>this-is-the-deal-title</offerKey>
    <pricingStrategy>NotSpecified</pricingStrategy>
    <video i:nil="true"/>
</offerDetail>


Sample JSON Response:
{
    "offerDetail": {
        "copy": "<p>Description<\/p>",
        "customFields": [
            {
                "Key": "AdditionalCopy",
                "Value": null
            },
            {
                "Key": "AdditionalCopy2",
                "Value": null
            },
            {
                "Key": "AdditionalCopy3",
                "Value": null
            },
            {
                "Key": "EmailSubjectLine",
                "Value": "email subject line"
            }
        ],
        "endDate": "\/Date(1327917600000-0500)\/",
        "fineprint": "<p>Fine print<\/p>",
        "hasEnded": false,
        "hasSoldOut": false,
        "headline": "This is the DEAL title",
        "highlights": "<ol>\u000d\u000a<li>highlights<\/li>\u000d\u000a<\/ol>",
        "images": [
            {
                "caption": null,
                "displayOrder": "1",
                "isOfferImage": "True",
                "size": "620x270",
                "tags": [
                    
                ],
                "url": "http: \/\/gcs-dev.s3.amazonaws.com\/shared\/images\/deals\/114\/174\/hatch.png"
            }
        ],
        "locations": [
            {
                "city": "New York",
                "country": "US",
                "latitude": 4,
                "longitude": 5,
                "name": null,
                "postalCode": "x",
                "state": "NY",
                "street1": "x",
                "street2": null
            }
        ],
        "maxQuantityPerBuyer": 100,
       
"maxGiftQuantityPerBuyer": 50,
        "merchant": {
            "address": {
                "city": "New York",
                "country": "US",
                "latitude": 4,
                "longitude": 5,
                "name": null,
                "postalCode": "x",
                "state": "NY",
                "street1": "x",
                "street2": null
            },
            "companyName": "Manhattan Kayak Company",
            "id": 6,
            "phone": "x",
            "website": "http: \/\/www.manhattankayak.com\/blogs\/"
        },
        "offerId": 174,
        "rank": 0,
        "redemptionInstructions": null,
        "segments": [
            {
                "key": "new-york",
                "name": "New York"
            }
        ],
        "startDate": "\/Date(1292925600000-0500)\/",
        "subtitle": "This is the subtitle",
        "url": "http: \/\/dealstest.dailycandy.com\/deal\/174\/this-is-the-deal-title",
        "classifications":[{
                    "key":"no_sub_classification",
                    "parentKey":"no_classification"
                },
                {
                    "key":"sportgoods",
                    "parentKey":""
                },
                {
                    "key":"amateursportsteams",
                    "parentKey":"active"
                }
            ],
        "demandStrategy": "NotSpecified",
        "numberSold": 10,
        "options": [
            {
                "blurb": "<p>Description<\/p>",
                "hasSoldOut": false,
                "inventoryRemaining": 990,
                "maxQuantity": 1000,
                "numberSold": 10,
                "offerOptionId": 125,
                "pricing": {
                    "currency": "USD",
                    "originalPrice": 100,
                    "price": 15,
                    "promotionalPrice": null
                },
                "title": "This is the DEAL title"
            }
        ],
        "offerKey": "this-is-the-deal-title",
        "pricingStrategy": "NotSpecified",
        "video": null
    }
}

Comments