Escolar Documentos
Profissional Documentos
Cultura Documentos
Version 4
Introduction ..........................................................................3
Intended Audience ................................................................................................................ 3
The AffiliateService ............................................................................................................... 3
Updates and versioning ........................................................................................................ 3
Other services ....................................................................................................................... 3
Introduction
Intended Audience
This document is intended for developers who want to programmatically access Affiliate
Window affiliate accounts. It assumes the reader is familiar with web services and with the
programming language they will be using. It also assumes they are familiar with the affiliate
aspect of the Affiliate Window system.
The AffiliateService
The AffiliateService provides the necessary functionality to retrieve all the information about
an Affiliates transactions and Affiliate Window merchants
The API is built on the core open source standards of SOAP and WSDL.
To use the API to programmatically access an affiliate account you will need to build a web
service client in your chosen language.
Other services
ProductServeService provides access to Affiliate Window product data to allow
development of products such as the ShopWindow Toolkit.
API Overview
WSDL
The current version of the AffiliateService WSDL can be found at
http://api.affiliatewindow.com/v4/AffiliateService?wsdl
User authentication
User authentication is performed by SOAP-Headers, which must be passed with every single
request.
Quota
Every user has an allocated operations quota. The remaining quota is returned as a SOAPHeader, in the response of every request.
The quota is specific to this service and has no relation to any quota you may have for any
other Affiliate Window service.
Body
getCommissionGroup
getTransactionProduct
getTransactionList
getTransaction
getMerchant
getMerchantList
getTransactionQuerys
getClickStats
getImpressionStats
API Methods
Headers
UserAuthentication
(SOAP-Header) The authentication element, has to be sent with every single request
Parameters
Element
Type
Required
Description
iId
int
Yes
sPassword
string
Yes
sType
UserType
Yes
Response
none
getQuota
(SOAP-Header) Gets the remaining quota back in the response headers, with every single
request
Parameters
Element
Type
boolean
Response
Elements
Yes
Type
int
Required
Description
Indicate if the quota should be returned or not.
Description
The number of remaining operations.
Requests
getCommissionGroup
Gets the commission values for a given commission group
Parameters
Element
Type
Required
Description
iMerchantId
int
Yes
Id of a merchant
sCommissionGroupCode
string
Yes
Response
Element
Type
getCommissionGroupReturn
CommissionGroup
Type
Description
Commission Group object
Description
sCommissionGroupCode
string
mAmount
Money
fPercentage
float
Type
Description
fAmount
float
The Amount
sCurrency
string
getTransactionProduct
Gets the products that are associated with this transaction.
Parameters
Element
aTransactionIds
Type
Required
Array of Integers
Yes
Description
Array of transaction Ids
Response
Element
getTransactionProductReturn
Type
Description
ArrayOfTransactionProduct
Type
Description
iTransactionId
int
Transaction id
aProducts
ArrayOfProducts
Array of Product
Type
Description
iId
int
Product id
sName
string
Product name
mUnitPrice
Money
getTransactionList
Gets the transactions that fall under the specified criteria
Parameters
Element
Type
Required
aMerchantIds
ArrayOfInt
Yes
dStartDate
dateTime
Yes
dEndDate
dateTime
Yes
sDateType
DateType
Yes
sTransactionStatus
TransactionStatus
No
iOffset
int
No
iLimit
int
No
Values
transaction
validation
Description
Values
pending
confirmed
declined
Response
Element
Type
getTransactionListReturn
ArrayOfTransaction
Array of Transaction
objects.
getTransactionListCountReturn
RowCounts
Number of rows
returned/available.
Type
iId
int
sStatus
TransactionStatus
sType
TransactionType
sIp
string
bPaid
boolean
iPaymentId
int
sDeclinedReason
string
iMerchantId
int
mSaleAmount
Money
mCommissionAmount
Money
dClickDate
dateTime
dTransactionDate
dateTime
dValidationDate
dateTime
sClickRef
string
sSearchSiteName
string
sSearchSiteKeyword
string
aTransactionParts
ArrayOfTransactionPart
10
Description
Type
iRowsReturned
int
iRowsAvailable
int
Values
pending
confirmed
declined
Values
normal
bonus
second tier
untracked
Type
aCommissionGroupName
string
mSaleAmount
Money
mCommissionAmount
Money
iCommission
int
sCommissionType
commissionType
Values
percentage
amount
getTransaction
Gets the requested transactions.
Parameters
Element
aTransactionIds
Type
ArrayOfInt
Required
Yes
Description
The id's of the transactions
to get.
Response
Element
getTransactionReturn
11
Type
ArrayOfTransaction
Description
Array of Transaction objects.
getMerchant
Gets the requested merchants.
Parameters
Element
aMerchantIds
Type
Required
ArrayOfInt
Description
Yes
Response
Element
getMerchantReturn
Type
ArrayOfMerchant
12
Description
Array of Merchant objects.
Type
iId
int
sName
string
sDisplayUrl
string
sClickThroughUrl
string
sLogoUrl
string
iDetailsVersion
int
dDetailsModified
dateTime
iFeedVersion
int
dFeedModified
dateTime
sStrapline
string
sDescription
String
fApprovalPercentage
float
fEpc
float
fConversionRate
float
iValidationDays
float
fAwinGrade
float
aCommissionGroups
ArrayOfCommissionRanges
aSectors
ArrayOfMerchantSectors
oPrimaryRegion
Region
Type
sType
CommissionType
fMin
float
fMax
float
Type
iSectorId
int
sSectorName
string
Values
percentage
amount
Type
sName
string
sCountryCode
string
sCurrencyCode
String
getMerchantList
Gets the merchants that fall under the specified criteria.
Parameters
Element
sRelationship
Type
Relationship
Required
No
Description
The affiliate's relationship to
the merchant.
Value
joined
Response
Element
getMerchantListReturn
13
Type
ArrayOfMerchant
Description
Array of Merchant objects.
getTransactionQuerys
Gets the requested transaction queries
Note: To use any of the Transaction Query functionality it must be enabled within your
account.
Parameters
Element
Value
Required
Description
aMerchantIds
ArrayOfInt
Yes
aStatus
ArrayOfTransaction
PreStatus
No
Array of status
aClickRefs
array
No
iOffset
int
No
iLimit
int
No
Value
pending
confirmed
declined
Response
Element
14
Value
Description
getTransactionQuery
ArrayOfTransactionQuerys
Array of Transaction
Query objects.
getTransactionQueryCountReturn
RowCounts
Type
iEnquiryId
int
iMerchantId
int
sClickRef
string
sStatus
string
mAmount
Money
mCommission
Money
dDate
dateTime
sCustomerReference
string
sReference
string
sProgramName
string
sDeclineReason
string
sType
string
sDescription
string
getClickStats
Gets the requested link click stats.
Parameters
Element
15
Type
Required
Description
dStartDate
dateTime
Yes
dEndDate
dateTime
Yes
aMerchantIds
ArrayOfInt
Yes
sDateType
DateType
Yes
iOffset
int
No
iLimit
int
No
Response
Element
Value
Required
Description
getClicksStatsReturn
ArrayOfClick
Stats
Yes
Result set
getClickStatsCountReturn
RowCounts
Yes
Number of rows
returned/available.
Type
sLinkName
string
sLinkType
string
sMerchantName
string
iPendingCount
int
mPendingValue
M oney
mPendingCommission
Money
iConfirmedCount
int
mConfirmedValue
Money
mConfirmedCommission
Money
iDeclinedCount
Int
mDeclinedValue
Money
mDeclinedCommission
Money
iClick
int
getImpressionStats
Gets the requested link impression stats.
Parameters
Element
16
Value
Required
Description
dStartDate
dateTime
Yes
dEndDate
dateTime
Yes
aMerchantIds
ArrayOfInt
Yes
sDateType
DateType
Yes
iOffset
int
No
iLimit
int
No
Response
Element
Value
getImpressionStatsReturn
ArrayOfImpressionStats
Result set
getImpressionStatsCountReturn
RowCounts
Number of rows
returned/available.
17
Description
Type
sLlinkName
string
sLinkType
string
sMerchantName
string
iPendingCount
Int
mPendingValue
Money
mPendingCommission
Money
iConfirmedcount
Int
mConfirmedValue
Money
mConfimedCommission
Money
iDeclinedCount
int
mDeclinedValue
Money
mDeclinedCommission
Money
iImpressions
int