Skip to main content
knowledgecenter.2checkout.com

Search affiliates

Overview

Use the searchAffiliates method to find out details about one or more affiliates.

Request Parameters

Parameters Required Type/Description

AffiliateCode

Required String. Unique, system-generated identifying code of the affiliate.
Status Optional String.  Merchant Affiliate relationship status. Can be ACTIVE or DISABLED.
RequestDateStart Optional Date. Format is YYYY-MM-DD. Affiliate Request start date.
RequestDateEnd Optional Date. Format is YYYY-MM-DD. Affiliate Request end date.
Page Optional Integer. Page number. Value = '1' to '9999'.
Limit Optional Integer. Number of results on a page. Value = '1' to '9999'.
Name Optional String. Affiliate name.
Country Optional Array. Affiliate country.
TargetCountry Optional Array. Countries where the affiliate sells into.
CommissionList Optional Array. Value = default. Affiliate commission list.
Type Optional Array. Affiliate type.

 

Request Example 


Response Parameters

Parameters Description

AffiliateCode

Unique, system-generated identifying code of the affiliate.
Status Merchant Affiliate relationship status.
AffiliateName Name of the affiliate.
Website Website of the affiliate.
CommissionList Affiliate commission list.
                                        ListName Name of the affiliate commission list.
                                        CommissionRate Value of the commission rate (in %).
RequestDate  
Categories Product category  of the affiliate.
NotifyUpdates Boolean. Value can be TRUE or FALSE.
TCSStatus  
AffiliateContact Affiliate contact details.
                                         FirstName Affiliate first name.
                                         LastName Affiliate last name.
                                        Phone Affiliate phone number.
                                        Email Affiliate email.
                                        Country Country of the affiliate.

Response Example

{  
   "AffiliateCode":"TFTF76455ee4YFCFCT6545465",
   "Status":"Active",
   "Affiliate Name":"Affiliate 1",
   "Website":"https://affiliate1.com",
   "CommissionLists":[  
      {  
         "ListName":"CommissionList1",
         "CommissionRate":"25%"
      }
   ],
   "RequestDate":"2018-10-05",
   "Categories":["PC security","Mobile security","Tablet security"],
   "NotifyUpdates":true,
   "TCStatus":"Accepted",
   "AffiliateContact":{  
      "FirstName":"FN",
      "LastName":"LN",
      "Phone":"0040723483987",
      "Email":"FN.LN@2AFFLT.COM",
      "Country":"Spain"
   }
},
{  
   "AffiliateCode":"TFTF76455ee4YFCFCT6545466",
   "Status":"Active",
   "Affiliate Name":"Affiliate2",
   "Website":"https://Affiliate2.com",
   "CommissionLists":[  
      {  
         "ListName":"CommissionList1",
         "CommissionRate":"25%"
      }
   ],
   "RequestDate":"2018-10-05",
   "Categories":["PC security","Mobile security","Tablet security"],
   "NotifyUpdates":true,
   "TCStatus":"Agreed",
   "AffiliateContact":{  
      "FirstName":"FN",
      "LastName":"LN",
      "Phone":"0040723483987",
      "Email":"FN.LN@2AFFLT.COM",
      "Country":"Spain"
   }
}

  • Was this article helpful?