Welcome‎ > ‎Version 3‎ > ‎Broadcast Api (Read Only)‎ > ‎Data Structures‎ > ‎

Broadcast 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 broadcast 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.
customFields list Y
Contains a list of broadcast custom fields as defined in pub admin.
demandStrategy
DemandStrategy
Y
The demand strategy used to configure display of the offer.
endDate datetime

The date and time the offer ends.
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.
images list

Contains a list of broadcast offer images.
locations list

The list of broadcast addresses the merchant has for the offer.
maxQuantityPerBuyer
int  Y The total number of items that can be purchased.  Null is no limit.
merchant
broadcast merchant   The merchant the offer applies to.
offerId
int
  The id of the offer.
options
list
  List of broadcast offer options.
pricingStrategy
PricingStrategy
Y The pricing strategy used to configure display of the offer.
redemptionInstructions
string
  The html of the redemption instructions.
redemptionType
RedemptionType
  The type of redemption for the offer.
segments
 list   A list of segments defined as { key, name, externalRefId }. For a fuller explanation see the broadcast offer segment object.
startDate
datetime
  The date and time the offer becomes available.
subtitle
string
  The subtitle for the offer.
url
string
  The url to the landing page for the offer.
variants
list   Contains a list of broadcast offer variants.


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

    "classifications": [
        {
            // see broadcast offer classification
        }
    ],
    "copy": "Description",
    "customFields": [
        {
            // see
broadcast custom field
        },
        {
            // see
broadcast custom field
        }
    ],
      "demandStrategy": "NotSpecified",
    "endDate": "/Date(1320270803000)/",
    "fineprint": null,
    "hasEnded": true,
    "hasSoldOut": false,
    "headline": "PublisherDealOptionTitleDealID8069PublisherID34",
    "highlights": "Highlights",
    "images": [
        {
            // see
broadcast offer image
        },
        {
            // see
broadcast offer image
        },
    ],
    "locations": [
        {
            // see
broadcast address
        },
        {
            // see
broadcast address
        }
    ],
    "maxQuantityPerBuyer": 100,
    "merchant": {
        // see
broadcast merchant
    },
    "offerId": 7754,
    "options": [
        {
            // see
broadcast offer option
        },
        {
            // see
broadcast offer option
        }
    ],

    "pricingStrategy": "NotSpecified",    
    "redemptionInstructions": null,
    "redemptionType": "Online",
    "segments": [
        {
            // see broadcast offer segment
        }
    ],
    "startDate": "/Date(1320098003000)/",
    "subtitle": null,
    "url":"http:\/\/dailyvoice.groupcommerce.com\/deal\/6644\/fantastic-test-offer-sold-out-example",
    "variants": [
        {
            // see 
broadcast offer variant
        },
        {
           
// see 
broadcast offer variant
        }
    ],

}


Sample XML Response:
<offer>
    <attributes>
        <offerAttribute>
            <!-- see broadcast offer attribute -->
        </offerAttribute>
        <offerAttribute>
           
<!-- see broadcast offer attribute -->
        </offerAttribute>
    </attributes>
    <classifications>
        <classification>
            <!--
see broadcast offer classification -->
        </classification>
    </classifications>

    <copy>Description</copy>
    <customFields>
        <customField>
            <!-- see broadcast custom field -->
        </customField>
        <customField>
            <!-- see broadcast custom field -->
        </customField>
    </customFields>
    <demandStrategy>NotSpecified</demandStrategy>
    <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>
    <images>
        <image>
               <!-- see broadcast offer image -->
        </image>
        <image>
               <!-- see broadcast offer image -->
        </image>
    </images>
    <locations>
        <address>
            
<!-- see broadcast address -->
        </address>
    </locations>
    <maxQuantityPerBuyer>100</maxQuantityPerBuyer>
    <merchant>
        <!-- see broadcast merchant -->
    </merchant>
    <offerId>7754</offerId>
    <options>
        <option>
               <!-- see broadcast offer option -->       
        </option>
        <option>
               <!-- see broadcast offer option -->       
        </option>
    </options>
      <pricingStrategy>NotSpecified</pricingStrategy>  
    <redemptionInstructions i:nil="true"/>
    <redemptionType>Online</redemptionType>
    <segments>
        <segment>
           
<!-- see broadcast offer segment -->
        </segment>
    </segments>
    <startDate>2011-10-31T21:53:23Z</startDate>
    <subtitle i:nil="true"/>
    <url>http://dailyvoice.groupcommerce.com/deal/6644/fantastic-test-offer-sold-out-example</url>

    <variants>
        <
offerVariant>
            <!-- see broadcast offer variant -->
        </offerVariant>
        <offerVariant>
           
<!-- see broadcast offer variant -->
        </offerVariant>
    </variants>
</offer>

Comments