Getting Started

Generating API Keys

Calling API Functions

JSON or XML

API Call Rate Limits

Affiliate Accounts

Functions

Types

Merchant Accounts

Functions

Types

GET Merchants Function

Retrieves an array of merchants, optionally filtered by one or more properties.

---

Syntax

GET https://api.commissionfactory.com/V1/Affiliate/Merchants?apiKey=[apiKey]&commissionType=[commissionType]&category=[category]&status=[status]

Parameters

Name	Type	Description
apiKey Required	String	A valid API key that represents an affiliate account.
commissionType Optional	MerchantType	If specified, filters results by commission type.
category Optional	MerchantCategory	If specified, filters results by primary and secondary categories.
status Optional	MerchantStatus	If specified, filters results by status.

Return Value

Type	Description
MerchantArray	Represents zero or more merchants.

Errors

Error	Description
400 Bad Request	One or more parameters could not be parsed correctly.
401 Unauthorised	The API key is missing, invalid, or for a different account type; or the user account has been suspended or closed.
429 Too Many Requests	The API call rate limit for the user account has been exceeded.
500 Internal Server Error	An unexpected error occurred while processing your request.

JSON XML

Example

Request

GET /V1/Affiliate/Merchants?apiKey=ABC123 HTTP/1.1
Accept: application/json
Host: api.commissionfactory.com

GET /V1/Affiliate/Merchants?apiKey=ABC123 HTTP/1.1
Accept: application/xml
Host: api.commissionfactory.com

Response

[
    {
        "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>"
    },
    {
        "Id": 2,
        "DateCreated": "2000-01-01T00:00:00.000",
        "DateModified": "2000-01-01T00:00:00.000",
        "Name": "Sample Pty Ltd",
        "AvatarUrl": "https://c.cfjump.com/Avatars/0.png",
        "CommissionType": "Percent per Sale",
        "CommissionRate": 10.00,
        "CommissionMinimum": 10.00,
        "CommissionMaximum": 10.00,
        "CommissionZero": true,
        "Category": "Business Supplies and Services",
        "Category2": null,
        "Category3": null,
        "Summary": "Sample Pty Ltd sells the best business supplies.",
        "TargetUrl": "https://www.example.com/",
        "Status": "Pending",
        "TrackingUrl": null,
        "TrackingCode": null,
        "TargetMarket": "New Zealand",
        "TermsAndConditions": "<p>Affiliates must agree to...</p>"
    },
    {
        "Id": 3,
        "DateCreated": "2000-01-01T00:00:00.000",
        "DateModified": "2000-01-01T00:00:00.000",
        "Name": "Demo Pty Ltd",
        "AvatarUrl": "https://c.cfjump.com/Avatars/0.png",
        "CommissionType": "Percent per Sale",
        "CommissionRate": 10.00,
        "CommissionMinimum": 10.00,
        "CommissionMaximum": 10.00,
        "CommissionZero": false,
        "Category": "Gadgets and Gifts",
        "Category2": null,
        "Category3": null,
        "Summary": "Demo Pty Ltd sells the best gadgets.",
        "TargetUrl": "https://www.example.com/",
        "Status": "Not Joined",
        "TrackingUrl": null,
        "TrackingCode": null,
        "TargetMarket": "Global",
        "TermsAndConditions": "<p>Affiliates must agree to...</p>"
    }
]

<MerchantArray xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://api.commissionfactory.com/V1/Affiliate">
    <Merchant>
        <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>
    <Merchant>
        <Id>2</Id>
        <DateCreated>2000-01-01T00:00:00.000</DateCreated>
        <DateModified>2000-01-01T00:00:00.000</DateModified>
        <Name>Sample Pty Ltd</Name>
        <AvatarUrl>https://c.cfjump.com/Avatars/0.png</AvatarUrl>
        <CommissionType>Percent per Sale</CommissionType>
        <CommissionRate>10.00</CommissionRate>
        <CommissionMinimum>10.00</CommissionMinimum>
        <CommissionMaximum>10.00</CommissionMaximum>
        <CommissionZero>true</CommissionZero>
        <Category>Business Supplies and Services</Category>
        <Category2 i:nil="true" />
        <Category3 i:nil="true" />
        <Summary>Sample Pty Ltd sells the best business supplies.</Summary>
        <TargetUrl>https://www.example.com/</TargetUrl>
        <Status>Pending</Status>
        <TrackingUrl i:nil="true" />
        <TrackingCode i:nil="true" />
        <TargetMarket>New Zealand</TargetMarket>
        <TermsAndConditions>&lt;p&gt;Affiliates must agree to...&lt;/p&gt;</TermsAndConditions>
    </Merchant>
    <Merchant>
        <Id>3</Id>
        <DateCreated>2000-01-01T00:00:00.000</DateCreated>
        <DateModified>2000-01-01T00:00:00.000</DateModified>
        <Name>Demo Pty Ltd</Name>
        <AvatarUrl>https://c.cfjump.com/Avatars/0.png</AvatarUrl>
        <CommissionType>Percent per Sale</CommissionType>
        <CommissionRate>10.00</CommissionRate>
        <CommissionMinimum>10.00</CommissionMinimum>
        <CommissionMaximum>10.00</CommissionMaximum>
        <CommissionZero>false</CommissionZero>
        <Category>Gadgets and Gifts</Category>
        <Category2 i:nil="true" />
        <Category3 i:nil="true" />
        <Summary>Demo Pty Ltd sells the best gadgets.</Summary>
        <TargetUrl>https://www.example.com/</TargetUrl>
        <Status>Not Joined</Status>
        <TrackingUrl i:nil="true" />
        <TrackingCode i:nil="true" />
        <TargetMarket>Global</TargetMarket>
        <TermsAndConditions>&lt;p&gt;Affiliates must agree to...&lt;/p&gt;</TermsAndConditions>
    </Merchant>
</MerchantArray>

Related Links

• GET Merchants/[id] Function
• Merchant Type
• MerchantArray Type
• MerchantCategory Enumeration
• MerchantStatus Enumeration
• MerchantType Enumeration