MassConversionInsert API Version 1

Updated on 2014-04-11
Current Version: V2

Requests Allowed: GET/SOAP

 

Summary:

This API will allow you to add conversions into your instance. 

 

Resource/WSDL Page:

http://yourdomainhere.com/api/1/track.asmx?op=MassConversionInsert

 

Parameters

api_key
Required
Type: STRING
Length (Max/Min): 50

Must be a valid API key (existing and NOT expired)

Example Value: Fo35NRAqvFLXoZxqB4aViaiYM7iVMhh

conversion_date
Required
Type: DATE
Length (Max/Min): N/A

Allowed formats: "YYYY-mm-dd","dd-mm-YYYY"

Example Values: 2014-04-11

affiliate_id
Required
Type: INT
Length (Max/Min): N/A

Must be an exisiting Affiliate ID

Example Values: 10343

campaign_id
Required
Type: INT
Length (Max/Min): N/A

Must be an existing Campaign ID

Example Values: 1134

sub_affiliate
Required
Type: STRING
Length (Max/Min): N/A

Enter in the Sub Affiliate name

Example Values: Empty

creative_id
Required
Type: INT
Length (Max/Min): N/A

Must be an existing Creative ID

Example Values: 1234

affiliate_payment_type
Required
Type: STRING
Length (Max/Min): N/A

Accepts "paid_only","unpaid_only", "paid_and_unpaid"

Example Values: paid_and_unpaid

advertiser_payment_type
Required
Type: STRING
Length (Max/Min): N/A

Accepts "paid_only","unpaid_only", "paid_and_unpaid"

Example Values: paid_and_unpaid

total_to_adjust
Required
Type: INT
Length (Max/Min): N/A


Example Values:

payout
Required
Type: DECIMAL
Length (Max/Min): N/A

Price Paid Per Conversion

payout_currency_id
Required Value/Optional?
Type: BYTE
Length (Max/Min): N/A

Max value is 255, min value is 1, no negative values accepted.

Example Values: 1

received
Required Value/Optional?
Type: DECIMAL
Length (Max/Min): N/A

Price Received Per Conversion

Example Values: 2.5

received_currency_id
Required Value/Optional?
Type: BYTE
Length (Max/Min): N/A

Max value is 255, min value is 1, no negative values accepted.

Example Values: 1

return_option
Required
Type: STRING
Length (Max/Min): N/A

Mark the Conversions as Returned? ["mark_as_returned", "mark_as_unreturned", "do_not_change"]

Example Values: do_not_change

note
Optional
Type: STRING
Length (Max/Min): N/A

Free form Notes. This can be anything you want it to be.

Example: banana

billing_option
Required
Type: STRING
Length (Max/Min): N/A

Accepts "ignore_billing", "next_generated_bill" or "latest_generated_bill"

Example Value: latest_generated_bill

 **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

GET

http://demo.cakemarketing.com/api/1/track.asmx/MassConversionInsert?
api_key=dNJFmId9rI&conversion_date=12/25/2012&affiliate_id=4401&
campaign_id=4904&sub_affiliate=andysub1&creative_id=1130010&
total_to_insert=15&payout=2.25&received=3.35&note=Here+is+where+I%27m+putting+my+notes&
billing_option=next_generated_bill

 

Sample XML Response:

<mass_conversion_insert_response> true Conversions Inserted  

 

Example Error Messages: 

Error Message

Likely Cause

Invalid API Key

API key does not exist or is expired.

Affiliate Not Found

Affiliate ID provided does not exist or is invalid.

Campaign Not Found

Campaign ID provided does not exist or is invalid.

Creative Not Found

Creative ID provided does not exist or is invalid.

SubAffiliate Not Found

SubAffiliate ID provided does not exist or is invalid.