Getting Started

Generating API Keys

Calling API Functions

JSON or XML

API Call Rate Limits

Affiliate Accounts

Functions

Types

Merchant Accounts

Functions

Types

GET Reports/Merchant Function

Retrieves a report for a given date range, grouped by merchant.


Syntax

GET https://api.commissionfactory.com/V1/Affiliate/Reports/Merchant?apiKey=[apiKey]&fromDate=[fromDate]&toDate=[toDate]

Parameters

Name Type Description
apiKey
Required
String A valid API key that represents an affiliate account.
fromDate
Required
DateTime The start date of the date range to select.
toDate
Required
DateTime The end date of the date range to select.

Return Value

Type Description
MerchantReportArray Represents zero or more lines in a merchant report.

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.

Remarks

The selected date range is inclusive of the fromDate and toDate parameters.

Both parameters are truncated so that only their date components are used, and their time components (if present) are ignored.

If fromDate is greater than toDate, then the parameters are swapped.

JSON XML

Example

Request

GET /V1/Affiliate/Reports/Merchant?apiKey=ABC123&fromDate=2000-01-01&toDate=2000-01-03 HTTP/1.1
Accept: application/json
Host: api.commissionfactory.com
GET /V1/Affiliate/Reports/Merchant?apiKey=ABC123&fromDate=2000-01-01&toDate=2000-01-03 HTTP/1.1
Accept: application/xml
Host: api.commissionfactory.com

Response

[
    {
        "MerchantId": 1,
        "MerchantName": "Example Pty Ltd",
        "MerchantAvatarUrl": "https://c.cfjump.com/Avatars/0.png",
        "ImpressionsTotal": 3000,
        "ImpressionsBot": 10,
        "ClicksTotal": 1000,
        "ClicksBot": 10,
        "TransactionsPending": 10,
        "TransactionsApproved": 5,
        "TransactionsVoid": 1,
        "SaleValuePending": 1000.00,
        "SaleValueApproved": 500.00,
        "SaleValueVoid": 100.00,
        "CommissionPending": 100.00,
        "CommissionApproved": 50.00,
        "CommissionVoid": 10.00
    },
    {
        "MerchantId": 2,
        "MerchantName": "Sample Pty Ltd",
        "MerchantAvatarUrl": "https://c.cfjump.com/Avatars/0.png",
        "ImpressionsTotal": 3000,
        "ImpressionsBot": 10,
        "ClicksTotal": 1000,
        "ClicksBot": 10,
        "TransactionsPending": 10,
        "TransactionsApproved": 5,
        "TransactionsVoid": 1,
        "SaleValuePending": 1000.00,
        "SaleValueApproved": 500.00,
        "SaleValueVoid": 100.00,
        "CommissionPending": 100.00,
        "CommissionApproved": 50.00,
        "CommissionVoid": 10.00
    },
    {
        "MerchantId": 3,
        "MerchantName": "Demo Pty Ltd",
        "MerchantAvatarUrl": "https://c.cfjump.com/Avatars/0.png",
        "ImpressionsTotal": 3000,
        "ImpressionsBot": 10,
        "ClicksTotal": 1000,
        "ClicksBot": 10,
        "TransactionsPending": 10,
        "TransactionsApproved": 5,
        "TransactionsVoid": 1,
        "SaleValuePending": 1000.00,
        "SaleValueApproved": 500.00,
        "SaleValueVoid": 100.00,
        "CommissionPending": 100.00,
        "CommissionApproved": 50.00,
        "CommissionVoid": 10.00
    }
]
<MerchantReportArray xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://api.commissionfactory.com/V1/Affiliate">
    <MerchantReport>
        <MerchantId>1</MerchantId>
        <MerchantName>Example Pty Ltd</MerchantName>
        <MerchantAvatarUrl>https://c.cfjump.com/Avatars/0.png</MerchantAvatarUrl>
        <ImpressionsTotal>3000</ImpressionsTotal>
        <ImpressionsBot>10</ImpressionsBot>
        <ClicksTotal>1000</ClicksTotal>
        <ClicksBot>10</ClicksBot>
        <TransactionsPending>10</TransactionsPending>
        <TransactionsApproved>5</TransactionsApproved>
        <TransactionsVoid>1</TransactionsVoid>
        <SaleValuePending>1000.00</SaleValuePending>
        <SaleValueApproved>500.00</SaleValueApproved>
        <SaleValueVoid>100.00</SaleValueVoid>
        <CommissionPending>100.00</CommissionPending>
        <CommissionApproved>50.00</CommissionApproved>
        <CommissionVoid>10.00</CommissionVoid>
    </MerchantReport>
    <MerchantReport>
        <MerchantId>2</MerchantId>
        <MerchantName>Sample Pty Ltd</MerchantName>
        <MerchantAvatarUrl>https://c.cfjump.com/Avatars/0.png</MerchantAvatarUrl>
        <ImpressionsTotal>3000</ImpressionsTotal>
        <ImpressionsBot>10</ImpressionsBot>
        <ClicksTotal>1000</ClicksTotal>
        <ClicksBot>10</ClicksBot>
        <TransactionsPending>10</TransactionsPending>
        <TransactionsApproved>5</TransactionsApproved>
        <TransactionsVoid>1</TransactionsVoid>
        <SaleValuePending>1000.00</SaleValuePending>
        <SaleValueApproved>500.00</SaleValueApproved>
        <SaleValueVoid>100.00</SaleValueVoid>
        <CommissionPending>100.00</CommissionPending>
        <CommissionApproved>50.00</CommissionApproved>
        <CommissionVoid>10.00</CommissionVoid>
    </MerchantReport>
    <MerchantReport>
        <MerchantId>3</MerchantId>
        <MerchantName>Demo Pty Ltd</MerchantName>
        <MerchantAvatarUrl>https://c.cfjump.com/Avatars/0.png</MerchantAvatarUrl>
        <ImpressionsTotal>3000</ImpressionsTotal>
        <ImpressionsBot>10</ImpressionsBot>
        <ClicksTotal>1000</ClicksTotal>
        <ClicksBot>10</ClicksBot>
        <TransactionsPending>10</TransactionsPending>
        <TransactionsApproved>5</TransactionsApproved>
        <TransactionsVoid>1</TransactionsVoid>
        <SaleValuePending>1000.00</SaleValuePending>
        <SaleValueApproved>500.00</SaleValueApproved>
        <SaleValueVoid>100.00</SaleValueVoid>
        <CommissionPending>100.00</CommissionPending>
        <CommissionApproved>50.00</CommissionApproved>
        <CommissionVoid>10.00</CommissionVoid>
    </MerchantReport>
</MerchantReportArray>

Related Links