Version 1
Extend and interact with
Commission Factory
Extend and interact with
Commission Factory
Represents a single transaction.
| 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. |
| AffiliateId |
Integer | The ID of the affiliate that generated the transaction. |
| AffiliateContactName |
String | The contact name of the affiliate that generated the transaction. |
| AffiliateBusinessName |
String | The business name of the affiliate that generated the transaction. |
| 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. |
| CustomerIpAddress |
String | The hash of the customer's IP address. |
| 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. |
| 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. |
| OverrideFee |
Decimal | The override fee 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 the Status2. |
| Status2 |
TransactionStatus2 | The status of the transaction. |
| InvoiceId |
Integer | The ID of the invoice that was generated to pay for the commission and override on this transaction. |
| 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. |
| PlacementId |
Integer | The ID of the placement that was active at the time of this transaction. |
| PlacementName |
String | The name of the placement that was active at the time of this transaction. |
| Items |
TransactionItemArray | Zero or more items that were purchased as part of the transaction. |
{
"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
}
]
}
<Transaction xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://api.commissionfactory.com/V1/Merchant">
<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>
Copyright © 2014 - 2024,
Commission Factory Pty Ltd
ABN: 15 149 765 631
Generating API Keys
Calling API Functions
JSON or XML
API Call Rate Limits
