Webservices Merchants

 ALLGEMEIN

„Login“ – Function

erstellt Loginsession, mit der dann der Zugriff auf den Webservice erfolgen kann. – Lebensdauer  (15min).

Input:
Username

String

UserID (affiliateid oder merchantid)
Password

String

Webservice Passwort
Output:
Token

String

Loginkey, aktiv 15min

„Logout“ – Function

Funktion beendet Loginsession

Input:
Token

String

Loginkey, aktiv 15min
Output:
none

 

MERCHANT BEREICH

 

„MerchantProgramStatistics“

 

Input:
Token

String

Loginkey aus Login-Aufruf
StartDate

DateTime

 Datum von
EndDate

DateTime

 Datum bis
ProgramIDs

Array

 Liste mit ProgrammIDs
AffiliateIDs

Array

Liste mit AffiliateIDs
TransactionStatus

Enum

 all,approved,cancelled,rejected,pending
default: all
ValuationType

Enum

 DateOfRegistration/DateOfConfirmation
default: DateOfRegistration
Output:
Views

Integer

 Views
Clicks

Integer

 Clicks
Sales

Integer

 Sales
Leads

Integer

 Leads
Commission

Double

 Provisonen
OpenCommission

Double

 offene Provisionen
Records List of MerchantProgramStatisticsRecord

MerchantProgramStatisticsRecord
ProgramID

Integer

 ProgrammID
ProgramTitle

String

 Programmbezeichnung
Views

Integer

 Views
Clicks

Integer

 Clicks
CTR

Double

 Clickthruerate
OpenLeads

Integer

 Offene Leads
ConfirmedLeads

Integer

 Bestätigte Leads
CancelledLeads

Integer

 Stornierte Leads
OpenSales

Integer

 Offene Sales
ConfirmedSales

Integer

 Bestätigte Sales
CancelledSales

Integer

 Stornierte Sales
OpenCommission

Double

 Offene Provisionen
ConfirmedCommission

Double

 Bestätigte Provisionen
CancelledCommission

Double

 Stornierte Provisionen

 

„MerchantSalesLeadsStatistics“

 

Input:
Token

String

 Loginkey aus Login-Aufruf
StartDate

DateTime

 von
EndDate

DateTime

 bis
ProgramIDs

Array

 Liste mit ProgrammIds
TransactionStatus

Enum

 all,approved,cancelled,rejected,pending
ValuationType

Enum

 DateOfRegistration/DateOfConfirmation
MaximumRecords

Integer

 default 0/leer – unbegrenzt
Output:
SalesTotalOpen

Integer

 Gesamt offene Sales
SalesTotalConfirmed

Integer

 Gesamt bestätigte Sales
SalesTotalCancelled

Integer

 Gesamt stornierte Sales
LeadsTotalOpen

Integer

 Gesamt offene Leads
LeadsTotalConfirmed

Integer

 Gesamt bestätigte Leads
LeadsTotalCancelled

Integer

 Gesamt stornierte Leads
TransactionsRecords List of SubIdStatisticsTransactionRecord’s
TransactionRecord
TransactionID

Integer

 Transaction Nummer
OrderID

Integer

 Unique Order ID
TransactionType

Enum

 click /sale/lead
TransactionStatus

Enum

 pending / approved / cancelled
TransactionTime

DateTime

 Transaktionsdatum
ProgramID

Integer

 ProgrammID
ProgramTitle

String

 Programmbezeichnung
PublisherID

Integer

 PublisherID
PublisherURL

String

 PublisherURL
Amount

Double

 Bestellwert
Commission

Double

 Provision
CheckDate

Date

 Bestätigungsdatum

 

„MerchantTransactionImport“

Integer

Input:
Token

String

 Loginkey aus Login-Aufruf
TransactionType

Enum

 sale, lead, click
TransactionStatus

Enum

 pending / approved / aancelled
ProgID

Integer

 ProgrammID
AffiliateID

Integer

 AffiliateID
IdentifierWMID

Integer

 Identfier WMID, sofern dieser Parameter genutzt wird,
um Conversions auf andere Prog umzuleiten (optional)
UserID

Integer

 Publisher UserID
SubID  Publisher SubID
OrderID

Integer

 Unique Orderid
Amount

Double

 Warenkorbwert (bei % Vergütung Pflicht)
Comment

String

 Kommentar zur Transaktion
 TransactionDateTime

Datetime

  Transaktionsdatum
(wenn frei dann wird aktuelle Datum gezogen)
Output:
Error

Integer

TransactionCacheID

Integer

 Ausgabe TransactionID Moneytrax

 

„MerchantTransactionModify by OrderID“

Input:
Token

String

 Loginkey aus Login-Aufruf
TransactionType

Enum

 sale, lead, click
TransactionStatus

Enum

 pending / approved / cancelled
OrderID

Integer

 Orderid
Amount

Double

 Warenkorbwert (optional)
Comment

String

 Kommentar zur Transaktion (optional)
ConfirmationDate

Datetime

 Bestätigungsdatum
Output:
Error

Integer

 Error
Status

Integer

 Status

 

„MerchantTransactionModify by TransactionID“ – unreleased

Input:
Token

String

 Loginkey aus Login-Aufruf
TransactionStatus

Enum

 pending / approved / cancelled
TransactionID

Integer

 TransactionID
Amount

Double

 Warenkorbwert (optional)
Comment

String

 Kommentar zur Transaktion (optional)
ConfirmationDate

Date

 Bestätigungsdatum
Output:
Error

Integer

 Error
Status

Integer

 Status