Note: The custom_date field is required in order to submit this request. It will only be used when an effective_date_option is equal to "custom".

WSDL Page:  http://<your_domain_here>/api/2/track.asmx?op=MassConversionAdjustment

 

Parameter Summary:

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

get_current_totals_only / BOOL = Show Totals or Run Adjustment Query? ["TRUE" = Show Totals/DO NOT RUN QUERY, "FALSE" = Run Adjustment Query]

start_date / DATETIME = Mass Adjustment Start Date [MM/DD/YYYY HH:MM:SS]

end_date / DATETIME = Mass Adjustment End Date [MM/DD/YYYY HH:MM:SS]

affiliate_id / INT = Affiliate ID {See export.asmx > Affiliates}

offer_id / INT = Offer ID {See export.asmx > Offers}

campaign_id / INT = Campaign ID {See export.asmx > Campaigns}

sub_affiliate / STRING = SubAffiliate Name

creative_id / INT = Creative ID {See export.asmx > Creatives}

affiliate_payment_type / STRING = Conversion Affiliate Payment Type ["paid_only", "unpaid_only", "paid_and_unpaid"]

advertiser_payment_type / STRING = Conversion Advertiser Payment Type ["paid_only", "unpaid_only", "paid_and_unpaid"]

total_to_adjust / INT = Total Conversions to Adjust

payout / DECIMAL = Price Paid Per Conversion

payout_currency_id / INT (unsignedByte) = Payout Currency ID {See get.asmx > Currencies}

received / DECIMAL = Price Received Per Conversion

received_currency_id / INT (unsignedByte) = Received Currency ID {See get.asmx > Currencies}

return_option / STRING = Mark the Conversions as Returned? ["mark_as_returned", "mark_as_unreturned", "do_not_change"]

note / STRING = Freeform Notes

effective_date_option /STRING =  The effective date these changes should be applied to. ["today", "conversion_date", "custom"]
custom_date /DATETIME = This date field is only used on effective_date_option = custom, otherwise this date is ignored.[MM/DD/YYYY HH:MM:SS]

 

Parameter Types:

api_key - ID

get_current_totals_only - ASSIGNABLE

start_date - ID

end_date - ID

affiliate_id - ID

offer_id - ID

campaign_id - ID

sub_affiliate - ID

creative_id - ID

affiliate_payment_type - ASSIGNABLE

advertiser_payment_type - ASSIGNABLE

total_to_adjust - ASSIGNABLE

payout - ASSIGNABLE

payout_currency_id - ID

received - ASSIGNABLE

received_currency_id - ID

return_option - ASSIGNABLE

note - ASSIGNABLE

effective_date_option - ASSIGNABLE

custom_date - ASSIGNABLE

 

Sample GET Call:

http://demo.cakemarketing.com/api/2/track.asmx/MassConversionAdjustment?api_key=dNJFmId9rI&get_current_totals_only=false&start_date=02%2F01%2F2014+&end_date=02%2F21%2F2014+&affiliate_id=1&offer_id=1001278&campaign_id=0&sub_affiliate=%5BEmpty%5D&creative_id=1132936&affiliate_payment_type=paid_and_unpaid&advertiser_payment_type=paid_and_unpaid&total_to_adjust=1&payout=20&payout_currency_id=1&received=2&received_currency_id=1&return_option=do_not_change&note=Appended+notes&effective_date_option=conversion_date&custom_date=1%2F2%2F2006

 

Sample XML Response:

<?xml version="1.0" encoding="utf-8"?>
<mass_conversion_adjustment_response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://cakemarketing.com/api/1/">
  <success>true</success>
  <message>1 Conversion(s) Adjusted</message>
  <conversions_found>1</conversions_found>
  <conversions_adjusted>1</conversions_adjusted>
  <total_payout_old>20.0000</total_payout_old>
  <total_received_old>2.0000</total_received_old>
  <total_payout_new>20.0000</total_payout_new>
  <total_received_new>2.0000</total_received_new>
  <max_cdh_date>2014-02-20T12:52:31.127</max_cdh_date>
</mass_conversion_adjustment_response>