Getting Started

Generating API Keys

Calling API Functions

JSON or XML

API Call Rate Limits

Affiliate Accounts

Functions

Types

Merchant Accounts

Functions

Types

Affiliate Type

Represents a single affiliate.

---

Properties

Name	Type	Description
Id	Integer	The ID of the affiliate
DateCreated	DateTime	The date and time that the affiliate joined the network.
DateModified	DateTime	The date and time that the affiliate was last modified.
DateApplied	DateTime	The date and time that the affiliate applied to join the merchant campaign.
DateApproved	DateTime	The date and time that the advertiser approved the affiliate. Will be NULL if the affiliate is not yet approved.
ContactName	String	The first and last names of the affiliate.
BusinessName	String	The business name of the affiliate.
Status	AffiliateStatus	The status of the relationship between the merchant and the affiliate.
TrafficSources	TrafficSourceArray	Zero or more traffic sources that the affiliate will use to promote the advertiser.

JSON XML

Example

{
    "Id": 1,
    "DateCreated": "2000-01-01T00:00:00.000",
    "DateModified": "2000-01-01T00:00:00.000",
    "DateApplied": "2000-01-01T00:00:00.000",
    "DateApproved": "2000-01-01T00:00:00.000",
    "ContactName": "John Smith",
    "BusinessName": "Example Pty Ltd",
    "Status": "Approved",
    "TrafficSources": [
        {
            "Type": "Website",
            "Status": "Approved",
            "WebsiteDateCreated": "2000-01-01T00:00:00.000",
            "WebsiteDateModified": "2000-01-01T00:00:00.000",
            "WebsiteUrl": "https://www.example.com/",
            "WebsiteName": "Example Domain",
            "WebsiteDescription": "This domain is established to be used for illustrative examples in documents. You may use this domain in examples without prior coordination or asking for permission.",
            "WebsiteCategory": "Internet Services",
            "WebsiteType": "Content",
            "WebsiteWeeklyVisitors": 1001,
            "WebsiteYearsOnline": 10,
            "WebsiteChannel": "Content",
            "WebsiteVerified": true
        },
        {
            "Type": "Email List",
            "Status": "Pending",
            "EmailListDateCreated": "2000-01-01T00:00:00.000",
            "EmailListDateModified": "2000-01-01T00:00:00.000",
            "EmailListName": "Motorbike Enthusiasts",
            "EmailListDescription": "An email list of over 10,000 motorbike enthusiasts",
            "EmailListCategory": "Cars and Bikes",
            "EmailListSize": 5001,
            "EmailListFrequency": "Weekly",
            "EmailListOptIn": "Double"
        },
        {
            "Type": "Social Media Page",
            "Status": "Declined",
            "SocialMediaPageDateCreated": "2000-01-01T00:00:00.000",
            "SocialMediaPageDateModified": "2000-01-01T00:00:00.000",
            "SocialMediaPageType": "Facebook",
            "SocialMediaPageName": "Example Page",
            "SocialMediaPageUrl": "https://www.facebook.com/example",
            "SocialMediaPageCategory": "Electrical",
            "SocialMediaPageFollowers": 123,
            "SocialMediaPageFacebookCategory": "Electronics",
            "SocialMediaPageFacebookLikes": 1234
        }
    ]
}

<Affiliate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://api.commissionfactory.com/V1/Merchant">
    <Id>1</Id>
    <DateCreated>2000-01-01T00:00:00.000</DateCreated>
    <DateModified>2000-01-01T00:00:00.000</DateModified>
    <DateApplied>2000-01-01T00:00:00.000</DateApplied>
    <DateApproved>2000-01-01T00:00:00.000</DateApproved>
    <ContactName>John Smith</ContactName>
    <BusinessName>Example Pty Ltd</BusinessName>
    <Status>Approved</Status>
    <TrafficSources>
        <TrafficSource>
            <Type>Website</Type>
            <Status>Approved</Status>
            <WebsiteDateCreated>2000-01-01T00:00:00.000</WebsiteDateCreated>
            <WebsiteDateModified>2000-01-01T00:00:00.000</WebsiteDateModified>
            <WebsiteUrl>https://www.example.com</WebsiteUrl>
            <WebsiteName>Example Domain</WebsiteName>
            <WebsiteDescription>This domain is established to be used for illustrative examples in documents. You may use this domain in examples without prior coordination or asking for permission</WebsiteDescription>
            <WebsiteCategory>Internet Services</WebsiteCategory>
            <WebsiteType>Content</WebsiteType>
            <WebsiteWeeklyVisitors>1001</WebsiteWeeklyVisitors>
            <WebsiteYearsOnline>10</WebsiteYearsOnline>
            <WebsiteChannel>Content</WebsiteChannel>
            <WebsiteVerified>true</WebsiteVerified>
        </TrafficSource>
        <TrafficSource>
            <Type>Email List</Type>
            <Status>Pending</Status>
            <EmailListDateCreated>2000-01-01T00:00:00.000</EmailListDateCreated>
            <EmailListDateModified>2000-01-01T00:00:00.000</EmailListDateModified>
            <EmailListName>Motorbike Enthusiasts</EmailListName>
            <EmailListDescription>An email list of over 10,000 motorbike enthusiasts</EmailListDescription>
            <EmailListCategory>Cars and Bikes</EmailListCategory>
            <EmailListSize>5001</EmailListSize>
            <EmailListFrequency>Weekly</EmailListFrequency>
            <EmailListOptIn>Double</EmailListOptIn>
        </TrafficSource>
        <TrafficSource>
            <Type>Social Media Page</Type>
            <Status>Declined</Status>
            <SocialMediaPageDateCreated>2000-01-01T00:00:00.000</SocialMediaPageDateCreated>
            <SocialMediaPageDateModified>2000-01-01T00:00:00.000</SocialMediaPageDateModified>
            <SocialMediaPageType>Facebook</SocialMediaPageType>
            <SocialMediaPageName>Example Page</SocialMediaPageName>
            <SocialMediaPageUrl>https://www.facebook.com/example</SocialMediaPageUrl>
            <SocialMediaPageCategory>Electrical</SocialMediaPageCategory>
            <SocialMediaPageFollowers>123</SocialMediaPageFollowers>
            <SocialMediaPageFacebookCategory>Electronics</SocialMediaPageFacebookCategory>
            <SocialMediaPageFacebookLikes>1234</SocialMediaPageFacebookLikes>
        </TrafficSource>
    </TrafficSources>
<Affiliate>

Related Links

• GET Affiliates Function
• GET Affiliates/[id] Function
• AffiliateArray Type
• AffiliateStatus Enumeration
• TrafficSource Type
• TrafficSourceArray Type