WSDL Page:  http://<your_domain_here>/api/5/export.asmx?op=Offers

 

Parameter Summary:

api_key / STRING = Admin API Key {See get.asmx > GetAPIKey}

offer_id / INT = Offer ID ["0" = ALL Offers] {See export.asmx > Offers}

offer_name / STRING = Freeform Offers Search

advertiser_id / INT = Advertiser ID ["0" = ALL Advertisers] {See export.asmx > Advertisers}

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

offer_type_id / INT (unsignedByte) = Offer Type ID ["1" = Hosted, "2" = Host-n-Post, "3" = 3rd Party, "0" = ALL Offer Types]

media_type_id / INT (unsignedByte) = Media Type ID ["0" = ALL Media Types] {See get.asmx > GetMediaTypes}

offer_status_id / INT (unsignedByte) = Offer Status ID ["1" = Public, "2" = Private, "3" = Apply To Run, "4" = Inactive, "0" = ALL Offer Statuses]

tag_id / STRING = Tag ID ["0" = ALL Tags] {See get.asmx > AffiliateTags}

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]

sort_field / STRING = Sort Field ["offer_id", "offer_name", "date_created", "expiration_date"]

sort_descending / BOOL = Sort Descending? ["TRUE", "FALSE"]

 

Parameter Types:

api_key - ID

offer_id - ID

offer_name - ID

advertiser_id - ID

vertical_id - ID

offer_type_id - ID

media_type_id - ID

offer_status_id - ID

tag_id - ID

start_at_row - ID

row_limit - ID

sort_field - ID

sort_descending - ID

 

Sample GET Call:

http://demo.cakemarketing.com/api/5/export.asmx/Offers?api_key=dNJFmId9rI&offer_id=10&offer_name=&advertiser_id=1&vertical_id=0&offer_type_id=0&media_type_id=15&offer_status_id=0&tag_id=0&start_at_row=1&row_limit=3&sort_field=offer_id&sort_descending=FALSE

 

Sample XML Response:

<offer_export_response>
   <success>true</success>
   <row_count>1</row_count>
   <offers>
      <offer>
         <offer_id>10</offer_id>
         <offer_name>Rename Offer Again</offer_name>
         <advertiser>
            <advertiser_id>1</advertiser_id>
            <advertiser_name>Rename Advertiser</advertiser_name>
         </advertiser>
         <vertical>
            <vertical_id>1</vertical_id>
            <vertical_name>Marketing Technology</vertical_name>
         </vertical>
         <offer_type>
            <offer_type_id>1</offer_type_id>
            <offer_type_name>Hosted</offer_type_name>
         </offer_type>
         <offer_status>
            <offer_status_id>2</offer_status_id>
            <offer_status_name>Private</offer_status_name>
         </offer_status>
         <hidden>false</hidden>
         <offer_image_link />
         <default_offer_contract_id>158</default_offer_contract_id>
         <offer_contracts>
            <offer_contract_info>
               <offer_contract_id>158</offer_contract_id>
               <offer_contract_name>WEbsite</offer_contract_name>
               <price_format>
                  <price_format_id>1</price_format_id>
                  <price_format_name>CPA</price_format_name>
               </price_format>
               <payout>
                  <is_percentage>false</is_percentage>
                  <amount>14.0000</amount>
                  <formatted_amount>$14.00</formatted_amount>
               </payout>
               <received>
                  <is_percentage>false</is_percentage>
                  <amount>0.0000</amount>
                  <formatted_amount>$0.00</formatted_amount>
               </received>
               <offer_link>http://getCAKE.com</offer_link>
               <thankyou_link>http://getCAKE.com</thankyou_link>
               <hidden>false</hidden>
               <submission_payment_options>
                  <pay_on_available_buyers_only>false</pay_on_available_buyers_only>
                  <host_post>
                     <pay_on_post>false</pay_on_post>
                  </host_post>
               </submission_payment_options>
               <targeting_method>
                  <targeting_method_id>2</targeting_method_id>
                  <targeting_method_name>Geo</targeting_method_name>
               </targeting_method>
               <geo_targeting>
                  <allowed_countries>
                     <geo_target>
                        <country>
                           <country_code>AF</country_code>
                           <country_name>Afghanistan</country_name>
                        </country>
                     </geo_target>
                     <geo_target>
                        <country>
                           <country_code>AG</country_code>
                           <country_name>Antigua and Barbuda</country_name>
                        </country>
                     </geo_target>
                     <geo_target>
                        <country>
                           <country_code>AR</country_code>
                           <country_name>Argentina</country_name>
                        </country>
                     </geo_target>
                     <geo_target>
                        <country>
                           <country_code>AM</country_code>
                           <country_name>Armenia</country_name>
                        </country>
                     </geo_target>
                     <geo_target>
                        <country>
                           <country_code>US</country_code>
                           <country_name>United States</country_name>
                        </country>
                     </geo_target>
                     <geo_target>
                        <country>
                           <country_code>VU</country_code>
                           <country_name>Vanuatu</country_name>
                        </country>
                     </geo_target>
                  </allowed_countries>
                  <disallowed_countries />
               </geo_targeting>
            </offer_contract_info>
            <offer_contract_info>
               <offer_contract_id>1159</offer_contract_id>
               <offer_contract_name>Call center</offer_contract_name>
               <price_format>
                  <price_format_id>1</price_format_id>
                  <price_format_name>CPA</price_format_name>
               </price_format>
               <payout>
                  <is_percentage>false</is_percentage>
                  <amount>14.0000</amount>
                  <formatted_amount>$14.00</formatted_amount>
               </payout>
               <received>
                  <is_percentage>false</is_percentage>
                  <amount>0.0000</amount>
                  <formatted_amount>$0.00</formatted_amount>
               </received>
               <offer_link>http://www.cakemarketing.com</offer_link>
               <thankyou_link />
               <hidden>false</hidden>
               <submission_payment_options>
                  <pay_on_available_buyers_only>false</pay_on_available_buyers_only>
                  <host_post>
                     <pay_on_post>false</pay_on_post>
                  </host_post>
               </submission_payment_options>
               <targeting_method>
                  <targeting_method_id>4</targeting_method_id>
                  <targeting_method_name>None</targeting_method_name>
               </targeting_method>
            </offer_contract_info>
         </offer_contracts>
         <tiers />
         <tags />
         <allowed_media_types />
         <currency>
            <currency_id>1</currency_id>
            <currency_symbol>$</currency_symbol>
            <currency_name>US Dollar</currency_name>
            <currency_abbr>USD</currency_abbr>
         </currency>
         <ssl>false</ssl>
         <suppression_amount />
         <click_cap>
            <limit>0</limit>
            <cap_interval>
               <cap_interval_id>0</cap_interval_id>
               <cap_interval_name>None</cap_interval_name>
            </cap_interval>
            <start_date />
            <review_no_redirect>true</review_no_redirect>
         </click_cap>
         <conversion_cap>
            <limit>0</limit>
            <cap_interval>
               <cap_interval_id>0</cap_interval_id>
               <cap_interval_name>None</cap_interval_name>
            </cap_interval>
            <start_date />
            <review_no_redirect>true</review_no_redirect>
         </conversion_cap>
         <click_cookie_days>30</click_cookie_days>
         <impression_cookie_days>30</impression_cookie_days>
         <enable_view_thru_conversions>false</enable_view_thru_conversions>
         <click_trumps_impression>true</click_trumps_impression>
         <disable_click_deduplication>false</disable_click_deduplication>
         <last_touch>false</last_touch>
         <enable_transaction_id_deduplication>false</enable_transaction_id_deduplication>
         <conversions_from_whitelist_only>false</conversions_from_whitelist_only>
         <pixel_info>
            <pixel_html />
            <postback_url />
            <postback_delay_ms />
         </pixel_info>
         <fire_global_pixel>true</fire_global_pixel>
         <fire_pixel_on_non_paid_conversions>false</fire_pixel_on_non_paid_conversions>
         <disable_prepop_appending>false</disable_prepop_appending>
         <redirect_404>false</redirect_404>
         <session_regeneration_seconds />
         <suppression_list>
            <suppression_list_id>73</suppression_list_id>
            <suppression_list_name>Suppression List 73</suppression_list_name>
            <suppression_list_type>
               <suppression_list_type_id>3</suppression_list_type_id>
               <suppression_list_type_name>Optizmo</suppression_list_type_name>
            </suppression_list_type>
            <md5_only>false</md5_only>
            <date_created>2012-07-01T09:58:28.25</date_created>
            <date_updated />
         </suppression_list>
         <unsubscribe_link />
         <preview_link />
         <offer_description />
         <restrictions />
         <advertiser_extended_terms />
         <testing_instructions />
         <from_lines />
         <subject_lines />
         <upsells />
         <thankyou_html />
         <submission_options>
            <sell_only_to_listed_buyers>false</sell_only_to_listed_buyers>
            <ping_first>false</ping_first>
            <asynchronous_ping>false</asynchronous_ping>
            <sell_exclusive_only>false</sell_exclusive_only>
         </submission_options>
         <date_created>2010-02-06T00:00:00</date_created>
         <expiration_date />
         <notes>booya!</notes>
      </offer>
   </offers>
</offer_export_response>