Knowledgebase
API for Publishers: Cancellations API, Merchant List API, Payments API, Voucher Code API, Second Level Transactions API
Posted by Sam Coleman on 28 November 2016 12:09 PM

 

Affiliate Future API’s for Publishers

Here is a list of current API’s that will require a KEY and PASSWORD; the generic data is there for example purposes only to show you the basic structure of the XML.

Publishers can get their API Key / Password from –

http://afuk.affiliate.affiliatefuture.co.uk/my-profile/sitedetails.aspx

Publishers APIs:

Transaction API 
https://api.affiliatefuture.com/PublisherService.svc/GetTransactionListbyDate?key=API-KEY&passcode=API-PASSWORD&startDate=01-jan-20XX&endDate=31-Dec-20XX 

<TransactionList>

<TransactionID>12345ABCDE</TransactionID>

<TransactionDate>20XX-10-25T09:00:00+00:00</TransactionDate>

<MerchantID>0000</MerchantID>

<MerchantName>TrackingTestAF</MerchantName>

<ProgrammeID>00000</ProgrammeID>

<ProgrammeName>Tracking Test</ProgrammeName>

<TrackingReference>AFClickRef</TrackingReference>

<IPAddress>000.000.000.000 </IPAddress>

<SaleValue>0.0000</SaleValue>

<SaleCommission>0.0000</SaleCommission>

<LeadCommission>10.0000</LeadCommission>

</TransactionList>


Cancellations
https://api.affiliatefuture.com/PublisherService.svc/GetCancelledTransactionListbyDate?key=API-KEY&passcode=API-PASSWORD&startDate=01-jan-20XX&endDate=31-Dec-20XX 

<TransactionList>

<TransactionID>12345ABCDE</TransactionID>

<TransactionDate>20XX-10-25T09:00:00+00:00</TransactionDate>

<MerchantID>0000</MerchantID>

<MerchantName>TrackingTestAF</MerchantName>

<ProgrammeID>00000</ProgrammeID>

<ProgrammeName>Tracking Test</ProgrammeName>

<TrackingReference>AFClickRef</TrackingReference>

<IPAddress>000.000.000.000 </IPAddress>

<SaleValue>0.0000</SaleValue>

<SaleCommission>0.0000</SaleCommission>

<LeadCommission>10.0000</LeadCommission>

<DateCancelled>20XX-10-30T09:00:00+00:00</DateCancelled>

<CancellationReason>Payment Not Cleared</CancellationReason>

</TransactionList>

Merchant List
https://api.affiliatefuture.com/PublisherService.svc/GetAFMerchantList?key=API-KEY&passcode=API-PASSWORD&merchantsJoined=USE_YES_NO_ALL&newMerchants=USE_YES_NO 

<Merchant>

<MerchantName><![CDATA[Name]]></MerchantName>

<MerchantSiteId>0000</MerchantSiteId>

<SiteAddress><![CDATA[https://]]></SiteAddress>

<SiteDescription><![CDATA[Description.]]></SiteDescription>

<logo><![CDATA[https://banners.affiliatefuture.com/logos/Logo.jpg]]></logo>

<Categories>

<categoryName>Retail / Home & Garden</categoryName>

</Categories>

<Programmes>

<Programme>

<ProgrammeName><![CDATA[Name]]></ProgrammeName>

<ProgrammeId>21465</ProgrammeId>

<DefaultUrl><![CDATA[http://]]></DefaultUrl>

<programmeSubscribed>yes</programmeSubscribed>

<VouchersAvailable><![CDATA[no]]></VouchersAvailable>

<JoinUrl/>

<SampleTrackingUrl>

<![CDATA[https://scripts.affiliatefuture.com/AFClick.asp?affiliateID=000000&merchantID=0000&programmeID=00000&mediaID=0&tracking=&url=]]>

</SampleTrackingUrl>

<SaleCommission>0.0000</SaleCommission>

<LeadCommission/>

<SaleSecondLevelCommission/>

<LeadSecondLevelCommission/>

<SalesCommissionPercentage/>

<ProgrammeType>Sale</ProgrammeType>

</Programme>

</Programmes>

<MerchantJoined>yes</MerchantJoined>

</Merchant>

 

Payments
https://api.affiliatefuture.com/PublisherService.svc/GetPaymentReport?key=API-KEY&passcode=API-PASSWORD&startDate=DD-MMM-YYYY&endDate=DD-MMM-YYYY 

 

<AffPaymentList>

<transactionID>123456789</transactionID>

<paymentDate>20XX-10-25T09:00:00+00:00</paymentDate>

<originalTransactionDate>20XX-10-30T09:00:00+00:00</originalTransactionDate>

<transactionDate>20XX-10-30T09:00:00+00:00</transactionDate>

<merchantName> TrackingTestAF </merchantName>

<TransactionType>Sale</TransactionType>

<OrderID>12345ABCDE </OrderID>

<OrderValue>00.0000</OrderValue>

<CommissionAmount>0.0000</CommissionAmount>

<PaymentAmount>0.0000</PaymentAmount>

<clickReference> AFClickRef </clickReference>

<paymentID>000000</paymentID>

</AffPaymentList>

Voucher Code
https://api.affiliatefuture.com/PublisherService.svc/getAllVouchers?key=API-KEY&passcode=API-PASSWORD 

<Voucher>

<CategoryName>Retail / Fashion</CategoryName>

<EndDate>2016-12-31T00:00:00</EndDate>

<ImageURL/>

<Joined>No</Joined>

<LandingPage/>

<MerchantSiteID>0000</MerchantSiteID>

<MerchantSiteName>Fashion123</MerchantSiteName>

<ProgrammeID>00000</ProgrammeID>

<StartDate>20XX-10-30T09:00:00+00:00</StartDate>

<TermsAndCondition/>

<Tracking_URL/>

<VoucherCode>VCode1</VoucherCode>

<VoucherDescription>10% Off Sale </VoucherDescription>

<VoucherID>Voucher1</VoucherID>

</Voucher>

 

 

2nd level transactions 
https://api.affiliatefuture.com/PublisherService.svc/Get2ndLevelLeadsTransactionListbyDate?key=API-KEY&passcode=API-PASSWORD&startDate=DD-MMM-YYYY&endDate=DD-MMM-YYYY

 

<TransactionList>

<TransactionID>12345ABCDE</TransactionID>

<LogDate>20XX-10-25T09:00:00+00:00</LogDate>

<MerchantID>0000</MerchantID>

<OrderNumber>12345ABCDE</OrderNumber>

<MerchantName>TrackingTestAF</MerchantName>

<ProgrammeID>00000</ProgrammeID>

<ProgrammeName> Tracking Test </ProgrammeName>

<TrackingReference>AFClickRef</TrackingReference>

<IPAddress>000.000.000.000 </IPAddress>

<type>lead</type>

<SaleValue>0.0000</SaleValue>

<Commission>0.0000</Commission>

<Status>Upgraded</Status>

<StatusChangeDate>20XX-10-30T09:00:00+00:00</StatusChangeDate>

</TransactionList>

 

(5 vote(s))
Helpful
Not helpful

Comments (0)
Post a new comment
 
 
Full Name:
Email:
Comments: