NOTICE:  THIS VERSION OF THE API HAS BEEN DEPRECATED.  IT WILL CONTINUE TO WORK INDEFINITELY, BUT HAS INCREASED FUNCTIONALITY IN NEWER VERSIONS.

 

WSDL Page:  http://<your_domain_here>/affiliate/api/2/offers.asmx?op=OfferFeed

 

Parameter Summary:

api_key / STRING = Affiliate API Key {See auth.asmx > Login}

affiliate_id / INT = Affiliate ID {See auth.asmx > Login}

campaign_name / STRING = Freeform Campaign Search

media_type_category_id / INT (unsignedByte) = Media Type Category ID ["0" = ALL Media Type Categories] {See offers.asmx > GetMediaTypeCategories}

vertical_category_id / INT (unsignedByte) = Vertical Category ID ["0" = ALL Vertical Categories] {See offers.asmx > GetVerticalCategories}

vertical_id / INT (short) = Vertical ID ["0" = ALL Verticals] {See offers.asmx > GetVerticals}

offer_status_id / INT (unsignedByte) = Offer Status ID ["1" = Public, "2" = Private, "3" = Apply To Run, "4" = Inactive, "0" = ALL Offers] {See offers.asmx > GetOfferStatuses}

tag_id / INT (short) = Tag ID ["0" = ALL Tags] {See offers.asmx > GetTags}

start_at_row / INT = Starting Row Number [Usually "1", unless doing incremental API Calls]

row_limit / INT = Maximum Rows Returned ["0" = ALL Rows, "100000" = Maximum]

 

Parameter Types:

api_key - ID

affiliate_id - ID

campaign_name - ID

media_type_category_id - ID

vertical_category_id - ID

vertical_id - ID

offer_status_id - ID

tag_id - ID

start_at_row - ASSIGNABLE

row_limit - ASSIGNABLE

 

Sample GET Call:

https://demo.cakemarketing.com/affiliates/api/2/offers.asmx/OfferFeed?api_key=OIohoAIOxMHZeo7EjB2IQg&affiliate_id=5969&campaign_name=&media_type_category_id=0&vertical_category_id=0&vertical_id=0&offer_status_id=0&tag_id=0&start_at_row=1&row_limit=3

 

Sample XML Response:

<offer_feed_response>
  <success>true</success>
  <row_count>3</row_count>
  <offers>
    <offer>
      <offer_id>1001418</offer_id>
      <offer_contract_id>2562</offer_contract_id>
      <campaign_id xsi:nil="true"/>
      <offer_name> FastFreeSavings Auto Insurance - Zip Submit - 1st Page</offer_name>
      <vertical_name>&#1050;&#1088;&#1077;&#1076;&#1080;&#1090;&#1085;</vertical_name>
      <offer_status>
        <status_id>2</status_id>
        <status_name>Public</status_name>
      </offer_status>
      <payout>$6.00</payout>
      <price_format>CPA</price_format>
      <preview_link>http://fastfreesavings.com/auto/index2.php</preview_link>
      <thumbnail_image_url/>
      <description>Converts on zip submit</description>
      <restrictions>Allows all traffic</restrictions>
      <allowed_countries>
        <country>
          <country_code>US</country_code>
          <country_name>United States</country_name>
        </country>
      </allowed_countries>
      <allowed_media_types>
        <media_type>
          <type_id>2</type_id>
          <type_name>Network</type_name>
          <category_id>4</category_id>
          <category_name>Other</category_name>
        </media_type>
        <media_type>
          <type_id>3</type_id>
          <type_name>Email</type_name>
          <category_id>3</category_id>
          <category_name>Email</category_name>
        </media_type>
        <media_type>
          <type_id>5</type_id>
          <type_name>SEO</type_name>
          <category_id>2</category_id>
          <category_name>Search</category_name>
        </media_type>
        <media_type>
          <type_id>6</type_id>
          <type_name>Co-Reg</type_name>
          <category_id>3</category_id>
          <category_name>Email</category_name>
        </media_type>
        <media_type>
          <type_id>7</type_id>
          <type_name>Banner</type_name>
          <category_id>1</category_id>
          <category_name>Display</category_name>
        </media_type>
        <media_type>
          <type_id>8</type_id>
          <type_name>Contextual</type_name>
          <category_id>1</category_id>
          <category_name>Display</category_name>
        </media_type>
        <media_type>
          <type_id>9</type_id>
          <type_name>Radio</type_name>
          <category_id>1</category_id>
          <category_name>Display</category_name>
        </media_type>
        <media_type>
          <type_id>10</type_id>
          <type_name>TV</type_name>
          <category_id>1</category_id>
          <category_name>Display</category_name>
        </media_type>
        <media_type>
          <type_id>11</type_id>
          <type_name>Upsell</type_name>
          <category_id>4</category_id>
          <category_name>Other</category_name>
        </media_type>
        <media_type>
          <type_id>12</type_id>
          <type_name>Incentivized</type_name>
          <category_id>4</category_id>
          <category_name>Other</category_name>
        </media_type>
        <media_type>
          <type_id>13</type_id>
          <type_name>Other</type_name>
          <category_id>4</category_id>
          <category_name>Other</category_name>
        </media_type>
        <media_type>
          <type_id>15</type_id>
          <type_name>Adware</type_name>
          <category_id>4</category_id>
          <category_name>Other</category_name>
        </media_type>
        <media_type>
          <type_id>16</type_id>
          <type_name>Social Media</type_name>
          <category_id>4</category_id>
          <category_name>Other</category_name>
        </media_type>
        <media_type>
          <type_id>17</type_id>
          <type_name>Linkout</type_name>
          <category_id>1</category_id>
          <category_name>Display</category_name>
        </media_type>
      </allowed_media_types>
      <expiration_date xsi:nil="true"/>
      <tags/>
    </offer>
    <offer>
      <offer_id>1001418</offer_id>
      <offer_contract_id>2686</offer_contract_id>
      <campaign_id xsi:nil="true"/>
      <offer_name> FastFreeSavings Auto Insurance - Zip Submit - 1st Page - Test</offer_name>
      <vertical_name>&#1050;&#1088;&#1077;&#1076;&#1080;&#1090;&#1085;</vertical_name>
      <offer_status>
        <status_id>2</status_id>
        <status_name>Public</status_name>
      </offer_status>
      <payout>6.00 %</payout>
      <price_format>RevShare</price_format>
      <preview_link>http://fastfreesavings.com/auto/index2.php</preview_link>
      <thumbnail_image_url/>
      <description>Converts on zip submit</description>
      <restrictions>Allows all traffic</restrictions>
      <allowed_countries/>
      <allowed_media_types>
        <media_type>
          <type_id>2</type_id>
          <type_name>Network</type_name>
          <category_id>4</category_id>
          <category_name>Other</category_name>
        </media_type>
        <media_type>
          <type_id>3</type_id>
          <type_name>Email</type_name>
          <category_id>3</category_id>
          <category_name>Email</category_name>
        </media_type>
        <media_type>
          <type_id>5</type_id>
          <type_name>SEO</type_name>
          <category_id>2</category_id>
          <category_name>Search</category_name>
        </media_type>
        <media_type>
          <type_id>6</type_id>
          <type_name>Co-Reg</type_name>
          <category_id>3</category_id>
          <category_name>Email</category_name>
        </media_type>
        <media_type>
          <type_id>7</type_id>
          <type_name>Banner</type_name>
          <category_id>1</category_id>
          <category_name>Display</category_name>
        </media_type>
        <media_type>
          <type_id>8</type_id>
          <type_name>Contextual</type_name>
          <category_id>1</category_id>
          <category_name>Display</category_name>
        </media_type>
        <media_type>
          <type_id>9</type_id>
          <type_name>Radio</type_name>
          <category_id>1</category_id>
          <category_name>Display</category_name>
        </media_type>
        <media_type>
          <type_id>10</type_id>
          <type_name>TV</type_name>
          <category_id>1</category_id>
          <category_name>Display</category_name>
        </media_type>
        <media_type>
          <type_id>11</type_id>
          <type_name>Upsell</type_name>
          <category_id>4</category_id>
          <category_name>Other</category_name>
        </media_type>
        <media_type>
          <type_id>12</type_id>
          <type_name>Incentivized</type_name>
          <category_id>4</category_id>
          <category_name>Other</category_name>
        </media_type>
        <media_type>
          <type_id>13</type_id>
          <type_name>Other</type_name>
          <category_id>4</category_id>
          <category_name>Other</category_name>
        </media_type>
        <media_type>
          <type_id>15</type_id>
          <type_name>Adware</type_name>
          <category_id>4</category_id>
          <category_name>Other</category_name>
        </media_type>
        <media_type>
          <type_id>16</type_id>
          <type_name>Social Media</type_name>
          <category_id>4</category_id>
          <category_name>Other</category_name>
        </media_type>
        <media_type>
          <type_id>17</type_id>
          <type_name>Linkout</type_name>
          <category_id>1</category_id>
          <category_name>Display</category_name>
        </media_type>
      </allowed_media_types>
      <expiration_date xsi:nil="true"/>
      <tags/>
    </offer>
    <offer>
      <offer_id>1001270</offer_id>
      <offer_contract_id>2429</offer_contract_id>
      <campaign_id xsi:nil="true"/>
      <offer_name>!andy - contract 2 CPC</offer_name>
      <vertical_name>Accurate Click Payday</vertical_name>
      <offer_status>
        <status_id>2</status_id>
        <status_name>Public</status_name>
      </offer_status>
      <payout>2.00 %</payout>
      <price_format>RevShare</price_format>
      <preview_link/>
      <thumbnail_image_url>http://demo.cakemarketing.com/thumbs/1001270/Screen_Shot_2013-04-05_at_9.12.15_AM.png</thumbnail_image_url>
      <description>Receive $1000 To Shop At The Grocery Store of your choice. Offers pays on first page zip submission. </description>
      <restrictions>US ONLY! No Incentives. No Co-Reg, No Social Currency.</restrictions>
      <allowed_countries>
        <country>
          <country_code>AL</country_code>
          <country_name>Albania</country_name>
        </country>
      </allowed_countries>
      <allowed_media_types>
        <media_type>
          <type_id>15</type_id>
          <type_name>Adware</type_name>
          <category_id>4</category_id>
          <category_name>Other</category_name>
        </media_type>
        <media_type>
          <type_id>16</type_id>
          <type_name>Social Media</type_name>
          <category_id>4</category_id>
          <category_name>Other</category_name>
        </media_type>
      </allowed_media_types>
      <expiration_date xsi:nil="true"/>
      <tags/>
    </offer>
  </offers>
</offer_feed_response>