Getting Started

Generating API Keys

Calling API Functions

JSON or XML

API Call Rate Limits

Affiliate Accounts

Functions

Types

Merchant Accounts

Functions

Types

GET Transactions Function

Retrieves an array of transactions for a specified date range, optionally filtered by one or more properties.


Syntax

GET https://api.commissionfactory.com/V1/Affiliate/Transactions?apiKey=[apiKey]&fromDate=[fromDate]&toDate=[toDate]&dateProperty=[dateProperty]&merchantId=[merchantId]&merchantName=[merchantName]&trafficType=[trafficType]&trafficSource=[trafficSource]&creativeType=[creativeType]&creativeId=[creativeId]&creativeName=[creativeName]&customerIpAddress=[customerIpAddress]&customerCountryCode=[customerCountryCode]&customerCountryName=[customerCountryName]&orderId=[orderId]&uniqueId=[uniqueId]&trackingMethod=[trackingMethod]&customerIpBlacklisted=[customerIpBlacklisted]&trafficSourceApproved=[trafficSourceApproved]&status=[status]&voidReason=[voidReason]

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.
dateProperty
Optional
String Specifies which property is queried by the "fromDate" and "toDate" parameters. Can be either "DateCreated" or "DateModified". The default is "DateCreated".
merchantId
Optional
Integer If specified, filters results by merchant ID.
merchantName
Optional
String If specified, filters results by merchant name.
trafficType
Optional
TrafficType If specified, filters results by traffic source type.
trafficSource
Optional
String If specified, filters results by traffic source.
creativeType
Optional
CreativeType If specified, filters results by creative type.
creativeId
Optional
Integer If specified, filters results by creative ID.
creativeName
Optional
String If specified, filters results by creative name.
customerIpAddress
Optional
String If specified, filters results by customer IP address.
customerCountryCode
Optional
String If specified, filters results by customer country code.
customerCountryName
Optional
String If specified, filters results by customer country name.
orderId
Optional
String If specified, filters results by order ID.
uniqueId
Optional
String If specified, filters results by unique ID.
trackingMethod
Optional
TrackingMethod If specified, filters results by tracking method.
customerIpBlacklisted
Optional
Boolean If specified, filters results by the customer blacklisted flag.
trafficSourceApproved
Optional
Boolean If specified, filters results by the traffic source approved flag.
status
Optional
TransactionStatus If specified, filters results by status.
voidReason
Optional
TransactionVoidReason If specified, filters results by void reason.
amendedReason
Optional
TransactionAmendedReason The reason that the transaction was amended.

Return Value

Type Description
TransactionArray Represents zero or more transactions.

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

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/Transactions?apiKey=ABC123&fromDate=2000-01-01&toDate=2000-01-03 HTTP/1.1
Accept: application/json
Host: api.commissionfactory.com
GET /V1/Affiliate/Transactions?apiKey=ABC123&fromDate=2000-01-01&toDate=2000-01-03 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",
        "MerchantId": 1,
        "MerchantName": "Example Pty Ltd",
        "MerchantAvatarUrl": "https://c.cfjump.com/Avatars/0.png",
        "TrafficType": "Website",
        "TrafficSource": "https://www.example.com/",
        "CreativeType": "Text Link",
        "CreativeId": null,
        "CreativeName": null,
        "CustomerIpAddress": "1.1.1.1",
        "CustomerCountryCode": "AUS",
        "CustomerCountryName": "Australia",
        "OrderId": "T0001",
        "UniqueId": null,
        "TrackingMethod": "Cookie",
        "SaleValue": 100.0000,
        "Commission": 10.0000,
        "ReportedCurrencyCode": "AUD",
        "ReportedCurrencyName": "Australian Dollar",
        "ReportedSaleValue": 100.0000,
        "CustomerIpBlacklisted": false,
        "TrafficSourceApproved": true,
        "Status": "Approved",
        "VoidReason": null,
        "AmendedReason": null,
        "CouponCode": "FREE101"
    },
    {
        "Id": 2,
        "DateCreated": "2000-01-02T00:00:00.000",
        "DateModified": "2000-01-02T00:00:00.000",
        "MerchantId": 1,
        "MerchantName": "Example Pty Ltd",
        "MerchantAvatarUrl": "https://c.cfjump.com/Avatars/0.png",
        "TrafficType": "Website",
        "TrafficSource": "https://www.example.com/",
        "CreativeType": "Text Link",
        "CreativeId": null,
        "CreativeName": null,
        "CustomerIpAddress": "1.1.1.1",
        "CustomerCountryCode": "AUS",
        "CustomerCountryName": "Australia",
        "OrderId": "T0002",
        "UniqueId": null,
        "TrackingMethod": "Cookie",
        "SaleValue": 100.0000,
        "Commission": 10.0000,
        "ReportedCurrencyCode": "AUD",
        "ReportedCurrencyName": "Australian Dollar",
        "ReportedSaleValue": 100.0000,
        "CustomerIpBlacklisted": false,
        "TrafficSourceApproved": true,
        "Status": "Pending",
        "VoidReason": null,
        "AmendedReason": "Partial Order Return",
        "CouponCode": "FREE101"
    },
    {
        "Id": 3,
        "DateCreated": "2000-01-03T00:00:00.000",
        "DateModified": "2000-01-03T00:00:00.000",
        "MerchantId": 3,
        "MerchantName": "Example Pty Ltd",
        "MerchantAvatarUrl": "https://c.cfjump.com/Avatars/0.png",
        "TrafficType": "Website",
        "TrafficSource": "https://www.example.com/",
        "CreativeType": "Text Link",
        "CreativeId": null,
        "CreativeName": null,
        "CustomerIpAddress": "1.1.1.1",
        "CustomerCountryCode": "AUS",
        "CustomerCountryName": "Australia",
        "OrderId": "T0003",
        "UniqueId": null,
        "TrackingMethod": "Cookie",
        "SaleValue": 100.0000,
        "Commission": 10.0000,
        "ReportedCurrencyCode": "AUD",
        "ReportedCurrencyName": "Australian Dollar",
        "ReportedSaleValue": 100.0000,
        "CustomerIpBlacklisted": false,
        "TrafficSourceApproved": true,
        "Status": "Void",
        "VoidReason": "Cancelled Order",
        "AmendedReason": null,
        "CouponCode": null
    }
]
<TransactionArray xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://api.commissionfactory.com/V1/Affiliate">
    <Transaction>
        <Id>1</Id>
        <DateCreated>2000-01-01T00:00:00.000</DateCreated>
        <DateModified>2000-01-01T00:00:00.000</DateModified>
        <MerchantId>1</MerchantId>
        <MerchantName>Example Pty Ltd</MerchantName>
        <MerchantAvatarUrl>https://c.cfjump.com/Avatars/0.png</MerchantAvatarUrl>
        <TrafficType>Website</TrafficType>
        <TrafficSource>https://www.example.com/</TrafficSource>
        <CreativeType>Text Link</CreativeType>
        <CreativeId i:nil="true" />
        <CreativeName i:nil="true" />
        <CustomerIpAddress>1.1.1.1</CustomerIpAddress>
        <CustomerCountryCode>AUS</CustomerCountryCode>
        <CustomerCountryName>Australia</CustomerCountryName>
        <OrderId>T0001</OrderId>
        <UniqueId i:nil="true" />
        <TrackingMethod>Cookie</TrackingMethod>
        <SaleValue>100.0000</SaleValue>
        <Commission>10.0000</Commission>
        <ReportedCurrencyCode>AUD</ReportedCurrencyCode>
        <ReportedCurrencyName>Australian Dollar</ReportedCurrencyName>
        <ReportedSaleValue>100.0000</ReportedSaleValue>
        <CustomerIpBlacklisted>false</CustomerIpBlacklisted>
        <TrafficSourceApproved>true</TrafficSourceApproved>
        <Status>Approved</Status>
        <VoidReason i:nil="true" />
        <AmendedReason i:nil="true" />
        <CouponCode>FREE101</CouponCode>
    </Transaction>
    <Transaction>
        <Id>2</Id>
        <DateCreated>2000-01-02T00:00:00.000</DateCreated>
        <DateModified>2000-01-02T00:00:00.000</DateModified>
        <MerchantId>1</MerchantId>
        <MerchantName>Example Pty Ltd</MerchantName>
        <MerchantAvatarUrl>https://c.cfjump.com/Avatars/0.png</MerchantAvatarUrl>
        <TrafficType>Website</TrafficType>
        <TrafficSource>https://www.example.com/</TrafficSource>
        <CreativeType>Text Link</CreativeType>
        <CreativeId i:nil="true" />
        <CreativeName i:nil="true" />
        <CustomerIpAddress>1.1.1.1</CustomerIpAddress>
        <CustomerCountryCode>AUS</CustomerCountryCode>
        <CustomerCountryName>Australia</CustomerCountryName>
        <OrderId>T0002</OrderId>
        <UniqueId i:nil="true" />
        <TrackingMethod>Cookie</TrackingMethod>
        <SaleValue>100.0000</SaleValue>
        <Commission>10.0000</Commission>
        <ReportedCurrencyCode>AUD</ReportedCurrencyCode>
        <ReportedCurrencyName>Australian Dollar</ReportedCurrencyName>
        <ReportedSaleValue>100.0000</ReportedSaleValue>
        <CustomerIpBlacklisted>false</CustomerIpBlacklisted>
        <TrafficSourceApproved>true</TrafficSourceApproved>
        <Status>Pending</Status>
        <VoidReason i:nil="true" />
        <AmendedReason>Partial Order Return</AmendedReason>
        <CouponCode>FREE101</CouponCode>
    </Transaction>
    <Transaction>
        <Id>3</Id>
        <DateCreated>2000-01-03T00:00:00.000</DateCreated>
        <DateModified>2000-01-03T00:00:00.000</DateModified>
        <MerchantId>3</MerchantId>
        <MerchantName>Example Pty Ltd</MerchantName>
        <MerchantAvatarUrl>https://c.cfjump.com/Avatars/0.png</MerchantAvatarUrl>
        <TrafficType>Website</TrafficType>
        <TrafficSource>https://www.example.com/</TrafficSource>
        <CreativeType>Text Link</CreativeType>
        <CreativeId i:nil="true" />
        <CreativeName i:nil="true" />
        <CustomerIpAddress>1.1.1.1</CustomerIpAddress>
        <CustomerCountryCode>AUS</CustomerCountryCode>
        <CustomerCountryName>Australia</CustomerCountryName>
        <OrderId>T0003</OrderId>
        <UniqueId i:nil="true" />
        <TrackingMethod>Cookie</TrackingMethod>
        <SaleValue>100.0000</SaleValue>
        <Commission>10.0000</Commission>
        <ReportedCurrencyCode>AUD</ReportedCurrencyCode>
        <ReportedCurrencyName>Australian Dollar</ReportedCurrencyName>
        <ReportedSaleValue>100.0000</ReportedSaleValue>
        <CustomerIpBlacklisted>false</CustomerIpBlacklisted>
        <TrafficSourceApproved>true</TrafficSourceApproved>
        <Status>Void</Status>
        <VoidReason>Cancelled Order</VoidReason>
        <AmendedReason i:nil="true" />
        <CouponCode i:nil="true" />
    </Transaction>
</TransactionArray>

Related Links