Getting Started

Generating API Keys

Calling API Functions

JSON or XML

API Call Rate Limits

Affiliate Accounts

Functions

Types

Merchant Accounts

Functions

Types

Merchant Type

Represents a single merchant.


Properties

Name Type Description
Id
Integer The ID of the merchant.
DateCreated
DateTime The date and time that the merchant was launched.
DateModified
DateTime The date and time that the merchant was last modified.
Name
String The campaign name of the merchant.
AvatarUrl
Url The address of the avatar image of the merchant.
CommissionType
MerchantType The commission type of the merchant.
CommissionRate
Decimal The default commission rate of the merchant, in $ or % depending on commission type.
CommissionMinimum
Decimal The minimum commission rate. May be lower than the default commission rate if the merchant has commission rules in place.
CommissionMaximum
Decimal The maximum commission rate. May be higher than the default commission rate if the merchant has commission rules in place.
CommissionZero
Boolean Indicates whether or not the merchant has commission rules in place that might result in zero commission paid for some transactions.
Category
MerchantCategory The primary category of the merchant.
Category2
MerchantCategory The secondary category of the merchant.
Category3
MerchantCategory The secondary category of the merchant.
Summary
String A summary of the merchant's campaign.
TargetUrl
Url The address of the landing page on the merchant's website.
Status
MerchantStatus The status of the relationship between the affiliate and the merchant.
TrackingUrl
Url The tracking link for this merchant, used to keep track of clicks and transactions.
TrackingCode
String Fully formatted HTML code that can be embedded directly on an affiliate website.
TargetMarket
String The merchant’s primary market, or “Global” if the merchant targets customers globally.
TermsAndConditions String Terms and conditions that affiliates must agree to in order to work with the merchant.

JSON XML

Example

{
    "Id": 1,
    "DateCreated": "2000-01-01T00:00:00.000",
    "DateModified": "2000-01-01T00:00:00.000",
    "Name": "Example Pty Ltd",
    "AvatarUrl": "https://c.cfjump.com/Avatars/0.png",
    "CommissionType": "Percent per Sale",
    "CommissionRate": 10.00,
    "CommissionMinimum": 5.00,
    "CommissionMaximum": 15.00,
    "CommissionZero": false,
    "Category": "Children Games and Toys",
    "Category2": "Sports and Fitness",
    "Category3": null,
    "Summary": "Example Pty Ltd sells the best childrens toys.",
    "TargetUrl": "https://www.example.com/",
    "Status": "Joined",
    "TrackingUrl": "https://t.cfjump.com/0/t/1",
    "TrackingCode": "<a href=\"https://t.cfjump.com/0/t/1\">Example Pty Ltd</a>",
    "TargetMarket": "Australia",
    "TermsAndConditions": "<p>Affiliates must agree to...</p>"
}
<Merchant xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://api.commissionfactory.com/V1/Affiliate">
    <Id>1</Id>
    <DateCreated>2000-01-01T00:00:00.000</DateCreated>
    <DateModified>2000-01-01T00:00:00.000</DateModified>
    <Name>Example Pty Ltd</Name>
    <AvatarUrl>https://c.cfjump.com/Avatars/0.png</AvatarUrl>
    <CommissionType>Percent per Sale</CommissionType>
    <CommissionRate>10.00</CommissionRate>
    <CommissionMinimum>5.00</CommissionMinimum>
    <CommissionMaximum>15.00</CommissionMaximum>
    <CommissionZero>false</CommissionZero>
    <Category>Children Games and Toys</Category>
    <Category2>Sports and Fitness</Category2>
    <Category3 i:nil="true" />
    <Summary>Example Pty Ltd sells the best childrens toys.</Summary>
    <TargetUrl>https://www.example.com/</TargetUrl>
    <Status>Joined</Status>
    <TrackingUrl>https://t.cfjump.com/0/t/1</TrackingUrl>
    <TrackingCode>&lt;a href="https://t.cfjump.com/0/t/1"&gt;Example Pty Ltd&lt;/a&gt;</TrackingCode>
    <TargetMarket>Australia</TargetMarket>
    <TermsAndConditions>&lt;p&gt;Affiliates must agree to...&lt;/p&gt;</TermsAndConditions>
</Merchant>

Related Links