Getting Started

Generating API Keys

Calling API Functions

JSON or XML

API Call Rate Limits

Affiliate Accounts

Functions

Types

Merchant Accounts

Functions

Types

Transaction Type

Represents a single transaction.

---

Properties

Name	Type	Description
Id	Integer	The ID of the transaction.
DateCreated	DateTime	The date and time that the transaction was created.
DateModified	DateTime	The date and time that the transaction was last modified.
MerchantId	Integer	The ID of the merchant that the transaction was generated for.
MerchantName	String	The campaign name of the merchant that the transaction was generated for.
MerchantAvatarUrl	Url	The address of the merchant's avatar image.
TrafficType	TrafficType	The type of traffic source that generated the transaction.
TrafficSource	String	The traffic source name or URL that generated the transaction.
CreativeType	CreativeType	The creative type that generated the transaction.
CreativeId	Integer	The ID of the creative that generated the transaction.
CreativeName	String	The name of the creative that generated the transaction.
CustomerCountryCode	String	The three letter ISO code of the country that the customer was from.
CustomerCountryName	String	The name of the country that the customer was from.
CustomerType	CustomerType	The type of customer.
OrderId	String	The unique order/transaction ID of the transaction, as specified by the merchant.
AdditionalNotes	String	Additional notes on the transaction.
UniqueId	String	A unique ID, as specified by the affiliate.
UniqueId2	String	A unique ID, as specified by the affiliate.
UniqueId3	String	A unique ID, as specified by the affiliate.
UniqueId4	String	A unique ID, as specified by the affiliate.
TrackingMethod	TrackingMethod	The method used to keep track of the customer.
SaleValue	Decimal	The total sale value of the transaction.
Commission	Decimal	The commission amount of the transaction.
ReportedCurrencyCode	String	The 3 letter ISO 4217 currency code of the currency that this transaction was originally reported in.
ReportedCurrencyName	String	The name of the currency that this transaction was originally reported in.
ReportedSaleValue	Decimal	The total sale value of the transaction in the original reported currency.
TrafficSourceApproved	Boolean	A flag indicating whether or not the traffic source was approved by the merchant.
Status	TransactionStatus	The status of the transaction. This property is deprecated, as it does not include the full range of possible transaction statuses. Please see Status2.
Status2	TransactionStatus2	The status of the transaction.
InvoiceId	Integer	The ID of the invoice that was generated to pay out the commission earned for this transaction.
Paid	Boolean	Indicates whether or not the invoice that was generated to pay out the commission earned for this transaction has been paid.
VoidReason	TransactionVoidReason	The reason that the transaction was marked as void.
AmendedReason	TransactionAmendedReason	The reason that the transaction was amended.
CouponCode	String	Coupon code used with the transaction
Items	TransactionItemArray	Zero or more items that were purchased as part of the transaction.

JSON XML

Example

{
    "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,
    "CustomerCountryCode": "AUS",
    "CustomerCountryName": "Australia",
    "CustomerType": "New",
    "OrderId": "T0001",
    "AdditionalNotes": null,
    "UniqueId": null,
    "UniqueId2": null,
    "UniqueId3": null,
    "UniqueId4": null,
    "TrackingMethod": "Cookie",
    "SaleValue": 100.0000,
    "Commission": 10.0000,
    "ReportedCurrencyCode": "AUD",
    "ReportedCurrencyName": "Australian Dollar",
    "ReportedSaleValue": 100.0000,
    "TrafficSourceApproved": true,
    "Status": "Approved",
    "Status2": "Paid",
    "InvoiceId": 12345,
    "Paid": true,
    "VoidReason": null,
    "AmendedReason": null,
    "CouponCode": "FREE101",
    "Items": [
        {
            "Sku": "P0001",
            "Quantity": 1,
            "ReportedSaleValue": 50.00,
            "SaleValue": 50.00,
            "Commission": 5.00,
            "Name": "Example Product 1",
            "Brand": "Example Brand 1",
            "Category": "Clothing"
        },
        {
            "Sku": "P0002",
            "Quantity": 1,
            "ReportedSaleValue": 25.00,
            "SaleValue": 25.00,
            "Commission": 2.50,
            "Name": "Example Product 2",
            "Brand": "Example Brand 1",
            "Category": "Shoes"
        },
        {
            "Sku": "P0003",
            "Quantity": 1,
            "ReportedSaleValue": 25.00,
            "SaleValue": 25.00,
            "Commission": 2.50,
            "Name": "Example Product 3",
            "Brand": "Example Brand 2",
            "Category": "Jewellery"
        }
    ]
}

<Transaction xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://api.commissionfactory.com/V1/Affiliate">
    <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" />
    <CustomerCountryCode>AUS</CustomerCountryCode>
    <CustomerCountryName>Australia</CustomerCountryName>
    <CustomerType>New</CustomerType>
    <OrderId>T0001</OrderId>
    <AdditionalNotes i:nil="true" />
    <UniqueId i:nil="true" />
    <UniqueId2 i:nil="true" />
    <UniqueId3 i:nil="true" />
    <UniqueId4 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>
    <TrafficSourceApproved>true</TrafficSourceApproved>
    <Status>Approved</Status>
    <Status2>Paid</Status2>
    <InvoiceId>12345</InvoiceId>
    <Paid>true</Paid>
    <VoidReason i:nil="true" />
    <AmendedReason i:nil="true" />
    <CouponCode>FREE101</CouponCode>
    <Items>
        <TransactionItem>
            <Sku>P0001<Sku>
            <Quantity>1<Quantity>
            <ReportedSaleValue>50.00<ReportedSaleValue>
            <SaleValue>50.00<SaleValue>
            <Commission>5.00<Commission>
            <Name>Example Product 1<Name>
            <Brand>Example Brand 1<Brand>
            <Category>Clothing<Category>
        </TransactionItem>
        <TransactionItem>
            <Sku>P0002<Sku>
            <Quantity>1<Quantity>
            <ReportedSaleValue>25.00<ReportedSaleValue>
            <SaleValue>25.00<SaleValue>
            <Commission>2.50<Commission>
            <Name>Example Product 2<Name>
            <Brand>Example Brand 1<Brand>
            <Category>Shoes<Category>
        </TransactionItem>
        <TransactionItem>
            <Sku>P0003<Sku>
            <Quantity>1<Quantity>
            <ReportedSaleValue>25.00<ReportedSaleValue>
            <SaleValue>25.00<SaleValue>
            <Commission>2.50<Commission>
            <Name>Example Product 3<Name>
            <Brand>Example Brand 2<Brand>
            <Category>Jewellery<Category>
        </TransactionItem>
    </Items>
</Transaction>

Related Links

• GET Transactions Function
• GET Transactions/[id] Function
• CreativeType Enumeration
• CustomerType Enumeration
• TrackingMethod Enumeration
• TrafficType Enumeration
• TransactionAmendedReason Enumeration
• TransactionArray Type
• TransactionItemArray Type
• TransactionStatus2 Enumeration
• TransactionVoidReason Enumeration