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/Merchant/Transactions?apiKey=[apiKey]&fromDate=[fromDate]&toDate=[toDate]&dateProperty=[dateProperty]&affiliateId=[affiliateId]&affiliateContactName=[affiliateContactName]&affiliateBusinessName=[affiliateBusinessName]&trafficType=[trafficType]&trafficSource=[trafficSource]&creativeType=[creativeType]&creativeId=[creativeId]&creativeName=[creativeName]&customerCountryCode=[customerCountryCode]&customerCountryName=[customerCountryName]&customerIpAddress=[customerIpAddress]&customerType=[customerType]&orderId=[orderId]&trackingMethod=[trackingMethod]&trafficSourceApproved=[trafficSourceApproved]&status=[status]&status2=[status2]&invoiceId=[invoiceId]&voidReason=[voidReason]

Parameters

Name	Type	Description
apiKey Required	String	A valid API key that represents a merchant 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".
affiliateId Optional	Integer	If specified, filters results by affiliate ID.
affiliateContactName Optional	String	If specified, filters results by affiliate contact name.
affiliateBusinessName Optional	String	If specified, filters results by affiliate business 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.
customerCountryCode Optional	String	If specified, filters results by customer country code.
customerCountryName Optional	String	If specified, filters results by customer country name.
customerIpAddress Optional	String	If specified, filters results by the hash of the customer's IP address.
customerType Optional	CustomerType	If specified, filters results by customer type.
orderId Optional	String	If specified, filters results by order ID.
trackingMethod Optional	TrackingMethod	If specified, filters results by tracking method.
trafficSourceApproved Optional	Boolean	If specified, filters results by the traffic source approved flag.
status Optional	TransactionStatus	If specified, filters results by status. This parameter is deprecated, as it does not include the full range of possible transaction statuses. Please see status2.
status2 Optional	TransactionStatus2	If specified, filters results by status.
invoiceId Optional	Integer	If specified, filters results by invoice ID.
voidReason Optional	TransactionVoidReason	If specified, filters results by void reason.
amendedReason Optional	TransactionAmendedReason	The reason that the transaction was amended.

Name

Type

Description

apiKey
Required

String

A valid API key that represents a merchant 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".

affiliateId
Optional

Integer

If specified, filters results by affiliate ID.

affiliateContactName
Optional

String

If specified, filters results by affiliate contact name.

affiliateBusinessName
Optional

String

If specified, filters results by affiliate business 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.

customerCountryCode
Optional

String

If specified, filters results by customer country code.

customerCountryName
Optional

String

If specified, filters results by customer country name.

customerIpAddress
Optional

String

If specified, filters results by the hash of the customer's IP address.

customerType
Optional

CustomerType

If specified, filters results by customer type.

orderId
Optional

String

If specified, filters results by order ID.

trackingMethod
Optional

TrackingMethod

If specified, filters results by tracking method.

trafficSourceApproved
Optional

Boolean

If specified, filters results by the traffic source approved flag.

status
Optional

TransactionStatus

If specified, filters results by status. This parameter is deprecated, as it does not include the full range of possible transaction statuses. Please see status2.

status2
Optional

TransactionStatus2

If specified, filters results by status.

invoiceId
Optional

Integer

If specified, filters results by invoice ID.

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.

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.
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.

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/Merchant/Transactions?apiKey=ABC123 HTTP/1.1
Accept: application/json
Host: api.commissionfactory.com

GET /V1/Merchant/Transactions?apiKey=ABC123 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",
        "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",
        "Status2": "Paid",
        "InvoiceId": 12345,
        "VoidReason": null,
        "AmendedReason": null,
        "CouponCode": "FREE101",
        "PlacementId": null,
        "PlacementName": 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",
                "CartItemReference": null,
                "CartItemReference2": null,
                "CartItemReference3": null,
                "CartItemReference4": null
            },
            {
                "Sku": "P0002",
                "Quantity": 1,
                "ReportedSaleValue": 25.00,
                "SaleValue": 25.00,
                "Commission": 2.50,
                "Name": "Example Product 2",
                "Brand": "Example Brand 1",
                "Category": "Shoes",
                "CartItemReference": null,
                "CartItemReference2": null,
                "CartItemReference3": null,
                "CartItemReference4": null
            },
            {
                "Sku": "P0003",
                "Quantity": 1,
                "ReportedSaleValue": 25.00,
                "SaleValue": 25.00,
                "Commission": 2.50,
                "Name": "Example Product 3",
                "Brand": "Example Brand 2",
                "Category": "Jewellery",
                "CartItemReference": null,
                "CartItemReference2": null,
                "CartItemReference3": null,
                "CartItemReference4": null
            }
        ]
    },
    {
        "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",
        "Status2": "Pending",
        "InvoiceId": null,
        "VoidReason": null,
        "AmendedReason": "Partial Order Return",
        "CouponCode": "FREE101",
        "PlacementId": null,
        "PlacementName": null,
        "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",
        "Status2": "Void",
        "InvoiceId": null,
        "VoidReason": "Cancelled Order",
        "AmendedReason": null,
        "CouponCode": null,
        "PlacementId": null,
        "PlacementName": 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",
                "CartItemReference": null,
                "CartItemReference2": null,
                "CartItemReference3": null,
                "CartItemReference4": null
            },
            {
                "Sku": "P0002",
                "Quantity": 1,
                "ReportedSaleValue": 25.00,
                "SaleValue": 25.00,
                "Commission": 2.50,
                "Name": "Example Product 2",
                "Brand": "Example Brand 1",
                "Category": "Shoes",
                "CartItemReference": null,
                "CartItemReference2": null,
                "CartItemReference3": null,
                "CartItemReference4": null
            },
            {
                "Sku": "P0003",
                "Quantity": 1,
                "ReportedSaleValue": 25.00,
                "SaleValue": 25.00,
                "Commission": 2.50,
                "Name": "Example Product 3",
                "Brand": "Example Brand 2",
                "Category": "Jewellery",
                "CartItemReference": null,
                "CartItemReference2": null,
                "CartItemReference3": null,
                "CartItemReference4": null
            }
        ]
    }
]

<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>
        <Status2>Paid</Status2>
        <InvoiceId>12345</InvoiceId>
        <VoidReason i:nil="true" />
        <AmendedReason i:nil="true" />
        <CouponCode>FREE101</CouponCode>
        <PlacementId i:nil="true" />
        <PlacementName 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>
                <CartItemReference i:nil="true" />
                <CartItemReference2 i:nil="true" />
                <CartItemReference3 i:nil="true" />
                <CartItemReference4 i:nil="true" />
            </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>
                <CartItemReference i:nil="true" />
                <CartItemReference2 i:nil="true" />
                <CartItemReference3 i:nil="true" />
                <CartItemReference4 i:nil="true" />
            </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>
                <CartItemReference i:nil="true" />
                <CartItemReference2 i:nil="true" />
                <CartItemReference3 i:nil="true" />
                <CartItemReference4 i:nil="true" />
            </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>
        <Status2>Pending</Status2>
        <InvoiceId i:nil="true" />
        <VoidReason i:nil="true" />
        <AmendedReason>Partial Order Return</AmendedReason>
        <CouponCode>FREE101</CouponCode>
        <PlacementId i:nil="true" />
        <PlacementName i:nil="true" />
        <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>
        <Status2>Void</Status2>
        <InvoiceId i:nil="true" />
        <VoidReason>Cancelled Order</VoidReason>
        <AmendedReason i:nil="true" />
        <CouponCode i:nil="true" />
        <PlacementId i:nil="true" />
        <PlacementName 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>
                <CartItemReference i:nil="true" />
                <CartItemReference2 i:nil="true" />
                <CartItemReference3 i:nil="true" />
                <CartItemReference4 i:nil="true" />
            </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>
                <CartItemReference i:nil="true" />
                <CartItemReference2 i:nil="true" />
                <CartItemReference3 i:nil="true" />
                <CartItemReference4 i:nil="true" />
            </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>
                <CartItemReference i:nil="true" />
                <CartItemReference2 i:nil="true" />
                <CartItemReference3 i:nil="true" />
                <CartItemReference4 i:nil="true" />
            </TransactionItem>
        </Items>
    </Transaction>
</TransactionArray>

GET Transactions Function

Syntax

Parameters

Return Value

Errors

Remarks

JSON XML

Example

Request

Response

Related Links

Getting Started

Affiliate Accounts

Merchant Accounts

Get in touch