Getting Started

Generating API Keys

Calling API Functions

JSON or XML

API Call Rate Limits

Affiliate Accounts

Functions

Types

Merchant Accounts

Functions

Types

GET Affiliates Function

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


Syntax

GET https://api.commissionfactory.com/V1/Merchant/Affiliates?apiKey=[apiKey]&status=[status]

Parameters

Name Type Description
apiKey
Required
String A valid API key that represents a merchant account.
status
Optional
AffiliateStatus If specified, filters results by status.

Return Value

Type Description
AffiliateArray Represents zero or more affiliates.

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.
500 Internal Server Error An unexpected error occured while processing your request.
503 Service Unavailable The API call rate limit for the user account has been exceeded.
NOTE: As of 2019-02-01, the response from the server will change:
429 Too Many Requests

JSON XML

Example

Request

GET /V1/Merchant/Affiliates?apiKey=ABC123 HTTP/1.1
Accept: application/json
Host: api.commissionfactory.com
GET /V1/Merchant/Affiliates?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",
        "ContactName": "John Smith",
        "BusinessName": "Example Pty Ltd",
        "Status": "Approved"
    },
    {
        "Id": 2,
        "DateCreated": "2000-01-01T00:00:00.000",
        "DateModified": "2000-01-01T00:00:00.000",
        "ContactName": "Jane Doe",
        "BusinessName": "Sample Pty Ltd",
        "Status": "Approved"
    },
    {
        "Id": 3,
        "DateCreated": "2000-01-01T00:00:00.000",
        "DateModified": "2000-01-01T00:00:00.000",
        "ContactName": "John Citizen",
        "BusinessName": null,
        "Status": "Pending"
    }
]
<AffiliateArray xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://api.commissionfactory.com/V1/Merchant">
    <Affiliate>
        <Id>1</Id>
        <DateCreated>2000-01-01T00:00:00.000</DateCreated>
        <DateModified>2000-01-01T00:00:00.000</DateModified>
        <ContactName>John Smith</ContactName>
        <BusinessName>Example Pty Ltd</BusinessName>
        <Status>Approved</Status>
    </Affiliate>
    <Affiliate>
        <Id>2</Id>
        <DateCreated>2000-01-01T00:00:00.000</DateCreated>
        <DateModified>2000-01-01T00:00:00.000</DateModified>
        <ContactName>Jane Doe</ContactName>
        <BusinessName>Sample Pty Ltd</BusinessName>
        <Status>Approved</Status>
    </Affiliate>
    <Affiliate>
        <Id>3</Id>
        <DateCreated>2000-01-01T00:00:00.000</DateCreated>
        <DateModified>2000-01-01T00:00:00.000</DateModified>
        <ContactName>John Citizen</ContactName>
        <BusinessName i:nil="true" />
        <Status>Pending</Status>
    </Affiliate>
<AffiliateArray>

Related Links