Welcome‎ > ‎Version 3‎ > ‎Publisher Api‎ > ‎Data Structures‎ > ‎

Offer

Will contain information about an offer.  Includes options, images, and pricing.  These fields can be localized based on the accept-language header.

Fields:
Field Data Type Nulls Description
attributes
list   Contains a list of offer attributes.
classifications list

Contains a list of  { key, parentKey } elements about the classification of the offer.  See the classification object.
copy
string
Y
Any copy associated with the offer.
creditSpendEnabled bool    Whether or not consumers' credits can be applied towards purchases of this offer 
customFields list Y
Contains a list of custom fields as defined in pub admin.
demandStrategy DemandStrategy
Y
The demand strategy for displaying the offer.
endDate datetime

The date and time (in UTC)  the offer ends.
expirationDate datetime
 Y The expiration date for any vouchers for this offer.   If this value is null the expiration date might be defined in the fine print.
fineprint string

Html of the fine print of the offer.
hasEnded bool

A value whether the offer has ended.
hasSoldOut bool

A value whether the offer has been sold out across all options.
headline string

The headline for the offer.
highlights string

Html of the highlights for the offer.
howToRedeemVoucher string
  The default redemption instructions as defined by the group commerce defaults.
images list

Contains a list of offer images.
locations list

The list of addresses the merchant has for the offer.
maxGiftQuantityPerBuyer int  Y The max number of gifts that can be given.  Null is no limit.
maxQuantityPerBuyer
int  Y The total number of items that can be purchased.  Null is no limit.
merchant
merchant   The merchant the offer applies to.
numberSold
int   The number of vouchers sold for the offer.
offerId
int
  The id of the offer.
offerKey
string
  The key for the offer. The title turned into a url.
options
list
  List of offer options.
pricingStrategy
PricingStrategy   The pricing strategy for displaying the offer.
redemptionInstructions
string
  The html of the redemption instructions.
redemptionType
RedemptionType
  The type of redemption for the offer.
requiresShippingAddress
bool
  A value that determines if the shipping address should be captured during a purchase.
segments
 list   A list of segments defined as { key, name, externalRefId }. For a fuller explanation see the Offer Segment object.
sourcingPartners
list
 Y A list of sourcing partners for the offer  { sourcingPartnerKey, allowSubscribe }. These are used for showing additional subscription functionality on the UI and through the AddEmailLead method.  See the sourcing partner object.
startDate
datetime
  The date and time (in UTC) the offer becomes available.
subtitle
string
  The subtitle for the offer.
tags
list
  The list of tags the publisher has defined for the offer.
url
string
  The url for the offer.
variants
list
 
Contains a list of offer variants.
video
video
Y
Information about the video for the offer { height, url, width} .  See the video object.
voucherInstructions
string Y
The instructions to be displayed on the voucher page. If this is null, use the redemption instructions.


Sample JSON Response:
{
   
"attributes": [
        {
            // see 
offer attribute
        },
        {
           
// see  offer attribute
        }
    ],

    "classifications": [
        {
            "key": "active",
            "parentkey": null
        },
        {
            "key": "bowling,
            "parentkey": "active"
        },
    ],
    "copy": "Description",
    "creditSpendEnabled": true,
    "customFields": [
        {
            // see 
offer custom field 
        },
        {
            // see 
offer custom field 
        }
    ],
    "demandStrategy": "NotSpecified",
    "endDate": "/Date(1320270803000)/",
    "expirationDate": null,
    "fineprint": null,
    "hasEnded": true,
    "hasSoldOut": false,
    "headline": "PublisherDealOptionTitleDealID8069PublisherID34",
    "highlights": "Highlights",
    "howToRedeemVoucher": "Just show up",
    "images": [
        {
            // see
 offer image 
        },
        {
            // see 
offer image 
        },
    ],
    "locations": [
        {
            // see 
address 
        },
        {
            // see 
address 
        }
    ],
    "maxGiftQuantityPerBuyer": 100,
    "maxQuantityPerBuyer": 100,
    "merchant": {
        // see 
merchant 
    },
    "numberSold": 0,
    "offerId": 7754,
    "offerKey": "deal-option-title",
    "options": [
        {
            // see 
offer option 
        },
        {
            // see 
offer option 
        }
    ],
    "pricingStrategy": "NotSpecified",
    "redemptionInstructions": null,
    "redemptionType": "Online",
    "requiresShippingAddress": false,
    "segments": [
        {
            "externalRefId": "",
            "key": "national",
            "name": "National"
        }
    ],
    "sourcingPartners": [],
    "startDate": "/Date(1320098003000)/",
    "subtitle": null,
    "tags": [],

    "url": "http: //dailyvoicetest.groupcommerce.com/deal/7754/deal-option-title",

   
"variants": [
        {
            // see 
offer variant
        },
        {
           
// see  offer variant
        }
    ],

    "video": {
        "height": 1080
        "url": "http://www.youtube.com/watch?v=Xbp6umQT58A",
        "width": 1920
    },
    "voucherInstructions": "How to redeem the voucher"
}


Sample XML Response:
<offer>
   
<attributes>
        <offerAttribute>
            <!-- see offer attribute -->
        </offerAttribute>
        <offerAttribute>
           
<!-- see offer attribute -->
        </offerAttribute>
    </attributes>
    <classifications>
        <classification>
            <key>active</key>
            <parentKey></parentKey>
        </classification>
        <classification>
            <key>bowling/key>
            <parentKey>active</parentKey>
        </classification>
    </classifications>
    <copy>Description</copy>
    <creditSpendEnabled>false</creditSpendEnabled>
    <customFields>
        <customField>
            <!-- see offer custom field -->
        </customField>
        <customField>
            <!-- see offer custom field -->
        </customField>
    </customFields>
    <demandStrategy>NotSpecified</demandStrategy>
    <expirationDate>2011-11-02T21:53:23Z</expirationDate>
    <endDate>2011-11-02T21:53:23Z</endDate>
    <fineprint i:nil="true"/>
    <hasEnded>true</hasEnded>
    <hasSoldOut>false</hasSoldOut>
    <headline>PublisherDealOption Title DealID 8069 PublisherID 34</headline>
    <highlights>Highlights</highlights>
    <howToRedeemVoucher>Just show up with the paper.</howToRedeemVoucher>
    <images>
        <image>
               <!-- see offer image -->
        </image>
        <image>
               <!-- see offer image -->
        </image>
    </images>
    <locations>
        <address>
            
<!-- see address -->
        </address>
    </locations>
    <maxGiftQuantityPerBuyer>100</maxGiftQuantityPerBuyer>
    <maxQuantityPerBuyer>100</maxQuantityPerBuyer>
    <merchant>
        <!-- see merchant -->
    </merchant>
    <numberSold>0</numberSold>
    <offerId>7754</offerId>
    <offerKey>deal-option-title</offerKey>
    <options>
        <option>
               <!-- see offer option -->       
        </option>
        <option>
               <!-- see offer option -->       
        </option>
    </options>
    <pricingStrategy>NotSpecified</pricingStrategy>
    <redemptionInstructions i:nil="true"/>
    <redemptionType>Online</redemptionType>
    <requiresShippingAddress>false</requiresShippingAddress>
    <segments>
        <segment>
            <externalRefId/>
            <key>national</key>
            <name>National</name>
        </segment>
    </segments>
    <sourcingPartners/>
    <startDate>2011-10-31T21:53:23Z</startDate>
    <subtitle i:nil="true"/>
    <tags/>
    <url>http://dailyvoicetest.groupcommerce.com/deal/7754/deal-option-title</url>

   
<variants>
        <
offerVariant>
            <!-- see offer variant -->
        </offerVariant>
        <offerVariant>
           
<!-- see offer variant -->
        </offerVariant>
    </variants>
    <video>
        <height>1080</height>
        <url>http://www.youtube.com/watch?v=Xbp6umQT58A</url>
        <width>1920></width>
    </video>
    <
voucherInstructions>How to redeem the voucher</voucherInstructions>
</offer>

Comments