View
 

Campaigns API Methods


campaigns/quicklink (deeplink)

Creates a Quick Link. This method was created so it won't make a call to get each Affiliate Link. You may need to get some data before using it. 

 

// Code

campaign_quicklink($campaign_id, $aff_code, $redirect)
 

Parameters:

  • category_id. Required. A Campaign ID or Unique Code.
  • aff_code. Required. Affiliate Unique Code.
  • redirect. Required. Where to redirect.

campaigns/list

Lists active campaigns.

 

  GET /campaigns.xml 

 

// Code
campaigns_list($category_id=null, $page=1, $perpage=6) 
 

Parameters:

  • category_id. Optional. A Category ID.
  • page. Optional. The desired page.
  • perpage. Optional. How many items per page.

campaigns/search

Search for campaigns.

 

 GET /campaigns/search.xml 

 

// Code
 campaigns_search($search, $page=1, $perpage=6) 

 

Parameters:

  • search. Required. Desired keywords.
  • page. Optional. The desired page.
  • perpage. Optional. How many items per page.

campaigns/show

Show the public available data about a campaign.

 

 GET /campaigns/#{campaign_id}.xml 

 

// Code
campaign_show($campaign_id) 

 

Parameters:

  • campaign_id. Required. A  Campaign ID.

campaigns/showforowner

Merchants: Show all the information available about a campaign.

 

  GET /campaigns/#{campaign_id}/showforowner.xml 

 

// Code

campaign_showforowner($campaign_id) 

 

Parameters:

  • campaign_id. Required. Campaign ID.

campaigns/listforaffiliate

Affiliates: List the Campaigns where the affiliate has been approved.

 

  GET /campaigns/listforaffiliate.xml 

 

// Code

campaigns_listforaffiliate() 

campaigns/listforowner

Merchants: List campaigns created by a merchant.

 

  GET /campaigns/listforowner.xml 

 

// Code

campaigns_listforowner() 

campaigns/update

Merchants: Update a campaign.

 

 PUT /campaigns/#{campaign_id}.xml 

 

// Code

campaign_update($campaign_id, $campaign) 

 

Parameters:

  • campaign_id. Required. A Campaign ID.
  • campaign. Required. An XML formatted updated campaign.