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

Offer Option

Data Structure containing information about an option on an offer.  This is the entity in the system that can be purchased. 

Fields:
Field Data Type Nulls Description
attributeValues
list

Contains a list of offer attribute values.
blurb string
Html information to be displayed about the offer option.
demandStrategy
DemandStrategy

The demand strategy for displaying this option.
displayOrder int

The display order when their are multiple options.
externalBuyUrl
string
Y
The url to a third party site where this offer option is purchased.  If this is null (as it is for most offer options), the purchase workflow should proceed as usual.  If it is set, any calls to purchase with this OfferOptionId will return an error.
hasSoldOut bool
Value on whether the option has been sold out.
hidden
bool
  Determines whether the option should be show in the deal listing page.
inventoryRemaining int
The number of units remaining for sale for this option.
isTaxable bool
Determines whether the option is taxable or not.
maxQuantity float

The maximum number of items that can be sold.
numberSold float

The number of options that have already been sold.
offerOptionId int

The id for the option.
pricing Pricing

The pricing information for purchasing this option.
pricingStrategy
PricingStrategy

The pricing strategy for displaying this option.
title     string

The title for the option.
variantValues
list

Contains a list of offer variant values.
vouchersPerQuantity
int
 The number of vouchers that the consumer receives per quantity purchased.  Default is 1.
voucherTitle string

The title that should appear on this voucher for this option.
 

Sample JSON Response:
{
    "attributeValues": [
        {
            // see offer attribute value
        },
       
{
            // see offer attribute value
        }

    ],
    "blurb": "Description",

    "demandStrategy": "NotSpecified",
    "displayOrder": 0,
    "externalBuyUrl": "http:\/\/groupcommerce.com?deal=38944",
    "hasSoldOut": false,
    "hidden": false,
    "inventoryRemaining": 1000,
    "isTaxable": true,
    "maxQuantity": 1000,
    "numberSold": 0,
    "offerOptionId": 7835,
    "pricing": {
        // see offer option pricing
    },
    "pricingStrategy": "NotSpecified",
    "title": "PublisherDealOption Title DealID 8069 PublisherID 34",
    "variantValues": [
        {
            // see offer variant value
        },
       
{
           
// see offer variant value
        }

    ],

    "vouchersPerQuantity": 2,
    "voucherTitle": "PublisherDealOption Voucher Title DealID 8069 PublisherID 34"
}


Sample XML Response:
<option>
    <attributeValues>

        <offerAttributeValue>
            <!--
see offer attribute value -->
        <offerAttributeValue>
    </attributeValues>

    <blurb>Description</blurb>
    <demandStrategy>NotSpecified</demandStrategy>
    <displayOrder>0</displayOrder>
    <externalBuyUrl>http://groupcommerce.com?somedeal=389483</externalBuyUrl>
    <hasSoldOut>false</hasSoldOut>
    <hidden>true</hidden>
    <inventoryRemaining>1000</inventoryRemaining>
    <isTaxable>true</isTaxable>
    <maxQuantity>1000</maxQuantity>
    <numberSold>0</numberSold>
    <offerOptionId>7835</offerOptionId>
    <pricing>
        <currency>USD</currency>
        <currencySymbol>$</currencySymbol>
        <discountPercent>49.23</discountPercent>
        <originalPrice>100</originalPrice>
        <price>50.77</price>
        <promotionalPrice i:nil="true"/>
        <savings>49.23</savings>
    </pricing>
    <pricingStrategy>NotSpecified</pricingStrategy>
    <title>PublisherDealOption Title DealID 8069 PublisherID 34</title>

    <variantValues>

        <offerVariantValue>
            <!--
see offer variant value -->
        <offerVariantValue>
    </variantValues>

    <vouchersPerQuantity>2</vouchersPerQuantity>
    <voucherTitle>PublisherDealOption Voucher Title DealID 8069 PublisherID 34</voucherTitle>
</option>
Comments