Search affiliates

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

Request parameters

Parameter
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.

Response parameters

Parameter
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.

CommissionList.ListName

Name of the affiliate commission list.

CommissionList.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.

AffiliateContact.FirstName

Affiliate first name.

AffiliateContact.LastName

Affiliate last name.

AffiliateContact.Phone

Affiliate phone number.

AffiliateContact.Email

Affiliate email.

AffiliateContact.Country

Country of the affiliate.

Response sample

Last updated

Was this helpful?