Getting Started

Generating API Keys

Calling API Functions

JSON or XML

API Call Rate Limits

Affiliate Accounts

Functions

Types

Merchant Accounts

Functions

Types

TransactionArray Type

Represents zero or more transactions.


Array Elements

Type Description
Transaction Represents a single transaction.

JSON XML

Example

[
    {
        "Id": 1,
        "DateCreated": "2000-01-01T00:00:00.000",
        "DateModified": "2000-01-01T00:00:00.000",
        "AffiliateId": 1,
        "AffiliateContactName": "John Smith",
        "AffiliateBusinessName: "Example Pty Ltd",
        "TrafficType": "Website",
        "TrafficSource": "https://www.example.com/",
        "CreativeType": "Text Link",
        "CreativeId": null,
        "CreativeName": null,
        "CustomerCountryCode": "AUS",
        "CustomerCountryName": "Australia",
        "CustomerIpAddress": "0123456789abcdef0123456789abcdef",
        "CustomerType": "New",
        "OrderId": "T0001",
        "AdditionalNotes": null,
        "TrackingMethod": "Cookie",
        "SaleValue": 100.0000,
        "Commission": 10.0000,
        "OverrideFee": 2.5000,
        "ReportedCurrencyCode": "AUD",
        "ReportedCurrencyName": "Australian Dollar",
        "ReportedSaleValue": 100.0000,
        "TrafficSourceApproved": true,
        "Status": "Approved",
        "InvoiceId": 12345,
        "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"
            }
        ]
    },
    {
        "Id": 2,
        "DateCreated": "2000-01-01T00:00:00.000",
        "DateModified": "2000-01-01T00:00:00.000",
        "AffiliateId": 1,
        "AffiliateContactName": "John Smith",
        "AffiliateBusinessName: "Example Pty Ltd",
        "TrafficType": "Website",
        "TrafficSource": "https://www.example.com/",
        "CreativeType": "Text Link",
        "CreativeId": null,
        "CreativeName": null,
        "CustomerCountryCode": "AUS",
        "CustomerCountryName": "Australia",
        "CustomerIpAddress": "0123456789abcdef0123456789abcdef",
        "CustomerType": "Return",
        "OrderId": "T0002",
        "AdditionalNotes": null,
        "TrackingMethod": "Cookie",
        "SaleValue": 100.0000,
        "Commission": 10.0000,
        "OverrideFee": 2.5000,
        "ReportedCurrencyCode": "AUD",
        "ReportedCurrencyName": "Australian Dollar",
        "ReportedSaleValue": 100.0000,
        "TrafficSourceApproved": true,
        "Status": "Pending",
        "InvoiceId": null,
        "VoidReason": null,
        "AmendedReason": "Partial Order Return",
        "CouponCode": "FREE101",
        "Items": [ ]
    },
    {
        "Id": 3,
        "DateCreated": "2000-01-01T00:00:00.000",
        "DateModified": "2000-01-01T00:00:00.000",
        "AffiliateId": 1,
        "AffiliateContactName": "John Smith",
        "AffiliateBusinessName: "Example Pty Ltd",
        "TrafficType": "Website",
        "TrafficSource": "https://www.example.com/",
        "CreativeType": "Text Link",
        "CreativeId": null,
        "CreativeName": null,
        "CustomerCountryCode": "AUS",
        "CustomerCountryName": "Australia",
        "CustomerIpAddress": "0123456789abcdef0123456789abcdef",
        "CustomerType": "New",
        "OrderId": "T0003",
        "AdditionalNotes": null,
        "TrackingMethod": "Cookie",
        "SaleValue": 100.0000,
        "Commission": 10.0000,
        "OverrideFee": 2.5000,
        "ReportedCurrencyCode": "AUD",
        "ReportedCurrencyName": "Australian Dollar",
        "ReportedSaleValue": 100.0000,
        "TrafficSourceApproved": true,
        "Status": "Void",
        "InvoiceId": null,
        "VoidReason": "Cancelled Order",
        "AmendedReason": null,
        "CouponCode": null,
        "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"
            }
        ]
    }
]
<TransactionArray xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://api.commissionfactory.com/V1/Merchant">
    <Transaction>
        <Id>1</Id>
        <DateCreated>2000-01-01T00:00:00.000</DateCreated>
        <DateModified>2000-01-01T00:00:00.000</DateModified>
        <AffiliateId>1</AffiliateId>
        <AffiliateContactName>John Smith</AffiliateContactName>
        <AffiliateBusinessName>Example Pty Ltd</AffiliateBusinessName>
        <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>
        <CustomerIpAddress>0123456789abcdef0123456789abcdef</CustomerIpAddress>
        <CustomerType>New</CustomerType>
        <OrderId>T0001</OrderId>
        <AdditionalNotes i:nil="true" />
        <TrackingMethod>Cookie</TrackingMethod>
        <SaleValue>100.0000</SaleValue>
        <Commission>10.0000</Commission>
        <OverrideFee>2.5000</OverrideFee>
        <ReportedCurrencyCode>AUD</ReportedCurrencyCode>
        <ReportedCurrencyName>Australian Dollar</ReportedCurrencyName>
        <ReportedSaleValue>100.0000</ReportedSaleValue>
        <TrafficSourceApproved>true</TrafficSourceApproved>
        <Status>Approved</Status>
        <InvoiceId>12345</InvoiceId>
        <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>
    <Transaction>
        <Id>2</Id>
        <DateCreated>2000-01-01T00:00:00.000</DateCreated>
        <DateModified>2000-01-01T00:00:00.000</DateModified>
        <AffiliateId>1</AffiliateId>
        <AffiliateContactName>John Smith</AffiliateContactName>
        <AffiliateBusinessName>Example Pty Ltd</AffiliateBusinessName>
        <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>
        <CustomerIpAddress>0123456789abcdef0123456789abcdef</CustomerIpAddress>
        <CustomerType>Return</CustomerType>
        <OrderId>T0002</OrderId>
        <AdditionalNotes i:nil="true" />
        <TrackingMethod>Cookie</TrackingMethod>
        <SaleValue>100.0000</SaleValue>
        <Commission>10.0000</Commission>
        <OverrideFee>2.5000</OverrideFee>
        <ReportedCurrencyCode>AUD</ReportedCurrencyCode>
        <ReportedCurrencyName>Australian Dollar</ReportedCurrencyName>
        <ReportedSaleValue>100.0000</ReportedSaleValue>
        <TrafficSourceApproved>true</TrafficSourceApproved>
        <Status>Pending</Status>
        <InvoiceId i:nil="true" />
        <VoidReason i:nil="true" />
        <AmendedReason>Partial Order Return</AmendedReason>
        <CouponCode>FREE101</CouponCode>
        <Items />
    </Transaction>
    <Transaction>
        <Id>3</Id>
        <DateCreated>2000-01-01T00:00:00.000</DateCreated>
        <DateModified>2000-01-01T00:00:00.000</DateModified>
        <AffiliateId>1</AffiliateId>
        <AffiliateContactName>John Smith</AffiliateContactName>
        <AffiliateBusinessName>Example Pty Ltd</AffiliateBusinessName>
        <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>
        <CustomerIpAddress>0123456789abcdef0123456789abcdef</CustomerIpAddress>
        <CustomerType>New</CustomerType>
        <OrderId>T0003</OrderId>
        <AdditionalNotes i:nil="true" />
        <TrackingMethod>Cookie</TrackingMethod>
        <SaleValue>100.0000</SaleValue>
        <Commission>10.0000</Commission>
        <OverrideFee>2.5000</OverrideFee>
        <ReportedCurrencyCode>AUD</ReportedCurrencyCode>
        <ReportedCurrencyName>Australian Dollar</ReportedCurrencyName>
        <ReportedSaleValue>100.0000</ReportedSaleValue>
        <TrafficSourceApproved>true</TrafficSourceApproved>
        <Status>Void</Status>
        <InvoiceId i:nil="true" />
        <VoidReason>Cancelled Order</VoidReason>
        <AmendedReason i:nil="true" />
        <CouponCode i:nil="true" />
        <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>
</TransactionArray>

Related Links