GET /incentives

Updated on
 
Returns a list of publicly available, non-exclusive incentiveItems. See incentiveItem element definition in WSDL/XSD
This resource does not require a signed request, only a connect ID. See Authentication documentation for REST and SOAP. Passing connectid as query parameter in REST is supported.

Notes

  • Public, non-exclusive incentives are visible to all zanox publishers, whether or not you have applied to the program offering the incentive.
  • If the incentive is for a program you belong to, you get a tracking link for each ad space you used to apply.
  • Some zanox programs participate in a public ad media pool; if the incentive is in one of these programs, you get a tracking link for each of your ad spaces.
  • If you are not applied to the program and the program does not participate in the ad media pool, you get the incentive without a tracking link.
  • Paging is turned off for this resource, and all items in the result are returned if no page or item are set.

Resource URL

XML:   http://api.zanox.com/xml/2011-03-01/incentives
JSON: http://api.zanox.com/json/2011-03-01/incentives

Parameters

program
optional

Limits results to a particular program.

Value Type: Integer program ID
Example Value: 1222

adspace
optional

Limits results to incentives that have tracking links associated with this AdSpace.

Value Type: Integer AdSpace ID
Example Value: 12345

incentiveType
optional

Limits results to one of the following incentive types.

Value Type: String

Example Value"coupons", "samples", "bargains",
"freeProducts", "noShippingCosts", "lotteries"

region
optional

Limits results to a region.

Value Type: String
Example Value"DE", "FR", "IT"

items
optional

See Paging.

Value Type: 
Example Value

page
optional

See Paging.

Value Type: 

Example Value

Example Request

Get one of the publicly available coupon incentives in Germany: 
https://api.zanox.com/xml/2011-03-01/incentives?connectid=580599047DF8F5311043&incentiveType=coupons&region=DE&items=1

Example Response

<SearchIncentivesResponse xmlns="http://api.zanox.com/namespace/2011-03-01/">
    <page>0</page>
    <items>1</items>
    <total>268</total>
    <incentiveItems>
        <incentiveItem id="305919">
            <name>10 Euro geschenkt und Versandkosten grat</name>
            <program id="418">OTTO DE</program>
            <admedia>
                <admediumItem id="7884">
                    <name>OTTO Logo-120x34_2</name>
                    <adrank>6.0</adrank>
                    <admediumType>image</admediumType>
                    <program id="418">OTTO DE</program>
                    <title>Vielfalt gibt's bei Otto!</title>
                    <height>34</height>
                    <width>120</width>
                    <category id="168">009_Logos</category>
                    <trackingLinks>
                        <trackingLink adspaceId="1187906">
                            <ppv>
                                http://www.zanox-affiliate.de/ppv/?19917355C47360784&zpar9=[[580599047DF8F5311043]]
                            </ppv>
                            <ppc>
                                http://www.zanox-affiliate.de/ppc/?19917355C47360784&zpar9=[[580599047DF8F5311043]]
                            </ppc>
                        </trackingLink>
                    </trackingLinks>
                </admediumItem>
            </admedia>
            <incentiveType>coupons</incentiveType>
            <regions>
                <region>DE</region>
            </regions>
            <createDate>2013-08-02T13:03:58.107+02:00</createDate>
            <modifiedDate>2013-08-05T17:43:47.790+02:00</modifiedDate>
            <startDate>2013-08-02T00:00:00+02:00</startDate>
            <endDate>2013-08-12T23:59:59+02:00</endDate>
            <info4publisher>
                Inhalt: 10 Euro geschenkt und Versandkosten gratis Gutscheincode: 81302 Wert: 10 Euro und 5,95 Euro Versand Mindestbestellwert: 20 Euro Einschränkungen: Nur für Neukunden und Kunden die seit 3 Jahren nicht mehr bei OTTO bestellt haben gültig Laufzeit: Bis zum 12.08.2013
            </info4publisher>
            <info4customer>
                Inhalt: 10 Euro geschenkt und Versandkosten gratis Gutscheincode: 81302 Wert: 10 Euro und 5,95 Euro Versand Mindestbestellwert: 20 Euro Einschränkungen: Nur für Neukunden und Kunden die seit 3 Jahren nicht mehr bei OTTO bestellt haben gültig Laufzeit: Bis zum 12.08.2013
            </info4customer>
            <couponCode>81302</couponCode>
            <total>10.0</total>
            <currency>EUR</currency>
            <restrictions>
                Inhalt: 10 Euro geschenkt und Versandkosten gratis Gutscheincode: 81302 Wert: 10 Euro und 5,95 Euro Versand Mindestbestellwert: 20 Euro Einschränkungen: Nur für Neukunden und Kunden die seit 3 Jahren nicht mehr bei OTTO bestellt haben gültig Laufzeit: Bis zum 12.08.2013
            </restrictions>
            <newCustomerOnly>false</newCustomerOnly>
            <minimumBasketValue>20.0</minimumBasketValue>
            <prizes/>
        </incentiveItem>
    </incentiveItems>
</SearchIncentivesResponse>

 

Resource Information

Rate Limited? No
Authentication Requires connect ID. See
REST Authentication
SOAP Authentication
Response Formats json, xml
HTTP Methods GET
Resource family Incentives
Response Object incentiveItems
API Version 2011-03-01