Getting Started

Generating API Keys

Calling API Functions

JSON or XML

API Call Rate Limits

Affiliate Accounts

Functions

Types

Merchant Accounts

Functions

Types

AffiliateReportArray Type

Represents zero or more lines in an affiliate report.

---

Array Elements

Type	Description
AffiliateReport	Represents a single line in an affiliate report.

JSON XML

Example

[
    {
        "AffiliateId": 1,
        "AffiliateContactName": "John Smith",
        "AffiliateBusinessName": "Example Pty Ltd",
        "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,
        "OverridePending": 25.00,
        "OverrideApproved": 12.50,
        "OverrideVoid": 2.50
    },
    {
        "AffiliateId": 2,
        "AffiliateContactName": "Jane Doe",
        "AffiliateBusinessName": "Sample Pty Ltd",
        "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,
        "OverridePending": 25.00,
        "OverrideApproved": 12.50,
        "OverrideVoid": 2.50
    },
    {
        "AffiliateId": 3,
        "AffiliateContactName": "John Citizen",
        "AffiliateBusinessName": null,
        "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,
        "OverridePending": 25.00,
        "OverrideApproved": 12.50,
        "OverrideVoid": 2.50
    }
]

<AffiliateReportArray xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://api.commissionfactory.com/V1/Merchant">
    <AffiliateReport>
        <AffiliateId>1</AffiliateId>
        <AffiliateContactName>John Smith</AffiliateContactName>
        <AffiliateBusinessName>Example Pty Ltd<AffiliateBusinessName>
        <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>
        <OverridePending>25.00</OverridePending>
        <OverrideApproved>12.50</OverrideApproved>
        <OverrideVoid>2.50</OverrideVoid>
    </AffiliateReport>
    <AffiliateReport>
        <AffiliateId>2</AffiliateId>
        <AffiliateContactName>Jane Doe</AffiliateContactName>
        <AffiliateBusinessName>Sample Pty Ltd<AffiliateBusinessName>
        <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>
        <OverridePending>25.00</OverridePending>
        <OverrideApproved>12.50</OverrideApproved>
        <OverrideVoid>2.50</OverrideVoid>
    </AffiliateReport>
    <AffiliateReport>
        <AffiliateId>3</AffiliateId>
        <AffiliateContactName>John Citizen</AffiliateContactName>
        <AffiliateBusinessName i:nil="true" />
        <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>
        <OverridePending>25.00</OverridePending>
        <OverrideApproved>12.50</OverrideApproved>
        <OverrideVoid>2.50</OverrideVoid>
    </AffiliateReport>
</AffiliateReportArray>

Related Links

• GET Reports/Affiliate Function
• AffiliateReport Type