EXPORT Affiliates API Version 5
Updated on 2014-03-26
Current Version: Version 5
Depricated Version: V2, V3, V4, V5
Requests Allowed: GET & SOAP
Summary:
Returns an array of affiliates potentially filtered by affiliate id, affiliate name, account manager id or tag id.
You can also obtain this from within your CAKE instance by going to affiliates tab >> affiliates >> export.
Resource/WSDL Page:
http://<your_domain_here>/api/5/export.asmx?op=Affiliates
Parameters
| api_key Required Type: STRING Length (Max/Min): 50 | This api_key will provide you with the ability to export Campaigns for your instance. You can obtain this api_key from within CAKE >> Setup >> Permissions in the API Key list. Example Value: Fo35NRAqvFLXoZxqB4aViaiYM7iVMhh |
| affiliate_id Required Type: INTEGER Length (Max/Min): N/A | This is the identifier for a unique Affiliate. If passing anything <= 0 the result will include all affiliates.Example Values: 1234 |
| affiliate_name Optional Type: STRING Length (Max/Min): 50 | Not required and can accept blank value. Used to filter records matching the value or will return all records if blank. Example Values: John Smith |
| account_manager_id Required Type: INTEGER Length (Max/Min): N/A | If passing anything <= 0 the result will include all affiliates regardless if account manager assignment Example Values: 1234 |
| start_at_row Required Type: INTEGER Length (Max/Min): N/A | Must pass at least 0 as value, which means start at the beginning of the data set. Example Values: 3 |
| row_limit Required Type: INTEGER Length (Max/Min): N/A | Must pass at least 0 as value, which means no limit. Example Values: 3 |
| sort_field Required Type: INTEGER Length (Max/Min): N/A | Accepts "affiliate_id", "affiliate_name", "date_created" or 0 to ignore this filter. Example Values: 3 |
| sort_descending Required Type: BOOL Length (Max/Min): N/A | The following values can only be used for this parameter (TRUE or FALSE). Example Values: TRUE |
| tag_id Required Type: INTEGER Length (Max/Min): N/A | Passing a zero (0) value will return all records. Passing an actual value will filter records matching the value. Obtained via GET AffiliateTags API Example Values: 3 |
**Note all optional parameters still need to be passed through in the actual call. These parameters do not need a value (therefore you can use a null value).
Example Request
Sample XML Response:
<affiliate_export_response> <success>true</success> <row_count>1140</row_count> <affiliates> <affiliate> <affiliate_id>1</affiliate_id> <affiliate_name>Performance + Media Network</affiliate_name> <tier> <affiliate_tier_id>1</affiliate_tier_id> <affiliate_tier_name>Bronze</affiliate_tier_name> </tier> <account_managers> <contact> <contact_id>2660</contact_id> <contact_name>Jodi Warner</contact_name> </contact> </account_managers> <account_status> <account_status_id>1</account_status_id> <account_status_name>Active</account_status_name> </account_status> <address> <street_1>1234 W. Some Street</street_1> <street_2/> <city>Los Angeles</city> <state/> <zip_code>90120</zip_code> <country/> </address> <website>www.cakemarketing.com</website> <payment_type> <payment_type_id xsi:nil="true"/> <payment_type_name/> <payment_type_info/> </payment_type> <contacts> <contact_info> <contact_id>1175</contact_id> <contact_type> <contact_type_id>1</contact_type_id> <contact_type_name>Account Manager</contact_type_name> </contact_type> <role> <role_id>6</role_id> <role_name>Affiliate</role_name> </role> <department> <department_id xsi:nil="true"/> <department_name/> </department> <first_name>John</first_name> <middle_name/> <last_name>Doe</last_name> <email_address>[email protected]</email_address> <title/> <phone_work>555-1212</phone_work> <phone_cell>555-1212</phone_cell> <phone_fax/> <im_service/> <im_name/> <include_in_mass_emails>true</include_in_mass_emails> <notes/> </contact_info> <contact_info> <contact_id>1237</contact_id> <contact_type> <contact_type_id xsi:nil="true"/> <contact_type_name/> </contact_type> <role> <role_id>6</role_id> <role_name>Affiliate</role_name> </role> <department> <department_id xsi:nil="true"/> <department_name/> </department> <first_name>John</first_name> <middle_name/> <last_name>Doe</last_name> <email_address>[email protected]</email_address> <title/> <phone_work>555-1212</phone_work> <phone_cell>555-1212</phone_cell> <phone_fax/> <im_service/> <im_name/> <include_in_mass_emails>true</include_in_mass_emails> <notes/> </contact_info> <contact_info> <contact_id>1860</contact_id> <contact_type> <contact_type_id>1</contact_type_id> <contact_type_name>Account Manager</contact_type_name> </contact_type> <role> <role_id>6</role_id> <role_name>Affiliate</role_name> </role> <department> <department_id xsi:nil="true"/> <department_name/> </department> <first_name>John</first_name> <middle_name/> <last_name>Doe</last_name> <email_address>[email protected]</email_address> <title/> <phone_work>555-1212</phone_work> <phone_cell>555-1212</phone_cell> <phone_fax/> <im_service/> <im_name/> <include_in_mass_emails>true</include_in_mass_emails> <notes/> </contact_info> <contact_info> <contact_id>2165</contact_id> <contact_type> <contact_type_id>1</contact_type_id> <contact_type_name>Account Manager</contact_type_name> </contact_type> <role> <role_id>6</role_id> <role_name>Affiliate</role_name> </role> <department> <department_id xsi:nil="true"/> <department_name/> </department> <first_name>John</first_name> <middle_name/> <last_name>Doe</last_name> <email_address>[email protected]</email_address> <title/> <phone_work>555-1212</phone_work> <phone_cell>555-1212</phone_cell> <phone_fax/> <im_service/> <im_name/> <include_in_mass_emails>true</include_in_mass_emails> <notes/> </contact_info> <contact_info> <contact_id>3128</contact_id> <contact_type> <contact_type_id>3</contact_type_id> <contact_type_name>Tech</contact_type_name> </contact_type> <role> <role_id>6</role_id> <role_name>Affiliate</role_name> </role> <department> <department_id xsi:nil="true"/> <department_name/> </department> <first_name>4</first_name> <middle_name/> <last_name>5</last_name> <email_address>2</email_address> <title/> <phone_work>6</phone_work> <phone_cell/> <phone_fax/> <im_service/> <im_name/> <include_in_mass_emails>true</include_in_mass_emails> <notes/> </contact_info> <contact_info> <contact_id>3129</contact_id> <contact_type> <contact_type_id>3</contact_type_id> <contact_type_name>Tech</contact_type_name> </contact_type> <role> <role_id>6</role_id> <role_name>Affiliate</role_name> </role> <department> <department_id xsi:nil="true"/> <department_name/> </department> <first_name>4</first_name> <middle_name/> <last_name>5</last_name> <email_address>2</email_address> <title/> <phone_work>6</phone_work> <phone_cell/> <phone_fax/> <im_service/> <im_name/> <include_in_mass_emails>true</include_in_mass_emails> <notes/> </contact_info> </contacts> <tags> <tag> <tag_id>2</tag_id> <tag_name>External</tag_name> </tag> <tag> <tag_id>63</tag_id> <tag_name>Affiliate Summit Accts</tag_name> </tag> </tags> <traffic_types> <price_formats/> <media_types/> <vertical_categories/> <countries/> </traffic_types> <minimum_payment_threshold xsi:nil="true"/> <auto_payment_fee xsi:nil="true"/> <pay_vat>false</pay_vat> <referrals_enabled>false</referrals_enabled> <referral_info/> <billing_cycle> <billing_cycle_id>3</billing_cycle_id> <billing_cycle_name>Monthly</billing_cycle_name> </billing_cycle> <currency_settings> <currency> <currency_id>1</currency_id> <currency_symbol>$</currency_symbol> <currency_name>US Dollar</currency_name> <currency_abbr>USD</currency_abbr> </currency> <payment_setting> <payment_setting_id>1</payment_setting_id> <payment_setting_name>Pay affiliate in system default currency</payment_setting_name> </payment_setting> </currency_settings> <quickbooks_id xsi:nil="true"/> <online_signup>false</online_signup> <signup_ip_address/> <pay_for_conversions>true</pay_for_conversions> <review>false</review> <review_new_subaffiliates>false</review_new_subaffiliates> <suppression>true</suppression> <suppression_cap xsi:nil="true"/> <pixel_info> <pixel_html>affiliate Pixel</pixel_html> <postback_url>http://postbackurl.com/something</postback_url> <postback_delay_ms>6969</postback_delay_ms> </pixel_info> <fire_global_pixel>true</fire_global_pixel> <blacklists/> <auto_approve_campaigns>false</auto_approve_campaigns> <auto_approve_pixels>false</auto_approve_pixels> <hide_offers>false</hide_offers> <api_key>d6lc5EmTFX8</api_key> <date_created>2010-09-05T17:34:15.53</date_created> <date_last_accepted_terms xsi:nil="true"/> <notes/> </affiliate> </affiliates> </affiliate_export_response>
Example Error Messages:
| Error Message | Likely Cause |
| Invalid API Key | API Key does not exist or is expired |