Retrieves a single transaction by its ID.
GET https://api.commissionfactory.com/V1/Affiliate/Transactions/[id]?apiKey=[apiKey]
Name | Type | Description |
---|---|---|
id Required |
Integer | The ID of a single transaction to retrieve. |
apiKey Required |
String | A valid API key that represents an affiliate account. |
Type | Description |
---|---|
Transaction | Represents a single transaction. |
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. |
404 Not Found | The requested item could not be found. |
429 Too Many Requests | The API call rate limit for the user account has been exceeded. |
500 Internal Server Error | An unexpected error occured while processing your request. |
GET /V1/Affiliate/Transactions/1?apiKey=ABC123 HTTP/1.1 Accept: application/json Host: api.commissionfactory.com
GET /V1/Affiliate/Transactions/1?apiKey=ABC123 HTTP/1.1 Accept: application/xml Host: api.commissionfactory.com
{ "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" }
<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" /> <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>