Affilinet Advertiser

Action

integer

This field defines the kind of change you wish to perform: to change the status of the transaction(s) or to change the NetPrice.

dimension

Article Number

string

The SKU this item has within your system. Can be an alphanumerical string of up to 80 characters. Either BasketId and PositionNumber or OrderId and ArticleNumber must be specified.

dimension

Article Number

string

The unique identifier, which the advertiser uses within his own system for this product.

dimension

Auto Order Management Action

integer

This field tells whether or not the order is connected to automatic order management. And if so, to which status the transaction will be changed (Cancelled or Confirmed).

dimension

Auto Order Management ActionDate

datatime

If an Auto Order Management Action is configured for this order, this field tells when the automatic action will take place or has taken place.

dimension

Basket Id

integer

The unique identifier of this basket within the affilinet system. Can be used e.g. in order to obtain the single basket items with GetBasketItems).

dimension

Basket Id

integer

The unique Id of this basket within the affilinet system. This Id can be used to request the single basket items, using the method GetBasketItems .

dimension

Basket Ids

integer

If specified, only baskets are returned that have any of these Ids. The values given in the parameters Page and PageSize are ignored in this case.

dimension

Basket Info

float

If the returned order is a shopping basket, this object contains summary information on the current status of that shopping basket, along with its Id (which can then be used e.g. in order to obtain the single basket items with GetBasketItems).

metric

Basket Info

float

Some affilinet advertisers are using basket tracking, so certain transactions can be grouped together in one basket. If this transaction is part of a basket, then this element contains basic information about the basket. Otherwise, it is null.

metric

Basket Item Collection

string

The collection of basket items, which match the given search criteria.

dimension

Basket ItemCollection

string

A container for the basket items.

dimension

Basket Items Query

string

Search criteria which the desired basket items ought to fulfil.

dimension

Bonus

long

Detailed information on the bonus payments granted to this publisher.

metric

Brand

string

The make of the bought product.

dimension

Brand

string

The make of the bought product.

dimension

Cancellation Reason

string

If a transaction is cancelled or its NetPrice is changed (if Action is SetCancelled or SetNewNetPrice), a reason for this change must be given. Must be a string of minimum length 5 non-empty characters.

dimension

Cancellation Reason

string

If a transaction has been cancelled or the NetPrice has been reduced by the advertiser, he has to specify a reason.

dimension

Cancelled Commission

long

The total commission value of all cancelled transactions of this publisher

metric

Cancelled Count

long

The amount of transactions in status Cancelled .

metric

Cancelled Sales

long

Total number of cancelled sales

metric

Cancelled Value

float

The sum of net prices in cancelled transactions

metric

Category

string

The category of the advertiser s system, in which the bought product is located, including category path, if available. E.g. Electronics > Portable devices > Mp3 players .

dimension

Category

string

The category, in which this product is kept in the advertiser s system.

dimension

Channel 1

integer

Limits the results to publishers, which belong to this channel 1. Input can be generated with the method GetChannels .

dimension

Channel 2

integer

Limits the results to publishers, which belong to this channel 2. Input can be generated with the method GetChannels .

dimension

Channel Collection

string

List of all channels of the requested channel group

dimension

Channel Group

integer

In this parameter, you can define, of which channel group you wish to receive the single channels.

dimension

Channel Id

integer

The ID of the found channel

dimension

Channel Name

string

The name of the found channel

dimension

Check Date

datatime

The timestamp when the status of the transaction was last changed.

dimension

Click Date

datatime

Please enter here when the click took place, which led to this transaction. If not specified, then the OrderDate is used. ClickDate has to be formatted like this: 2010-11-24T12:34:56

dimension

Click Date

datatime

The timestamp when the click has been recorded, which led to this transaction.

dimension

Click Outs

long

The publisher s ClickOuts, which meet the set filter criteria.

metric

Click Status

string

Information on the status of the click.

dimension

Click through

long

Number of clicks devided by the number of views

metric

Clicks

long

The publisher s Clicks, which meet the set filter criteria.

metric

Clicks

long

Total number of clicks

metric

Combined Programs

string

Summary of commission information regarding combined programs

dimension

Commission

long

Total amount of earnings

metric

Commission Rates

string

Detailed information on the applicable commission rates

dimension

Confirmed

long

Monetary value of this transaction, if it was confirmed

metric

Confirmed Commission

long

The total commission value of all confirmed transactions of this publisher

metric

Confirmed Count

long

The amount of transactions in status Confirmed .

metric

Confirmed Sales

long

Total number of confirmed sales

metric

Confirmed Value

float

The sum of net prices in confirmed transactions

metric

Cookie Sharing Program

integer

If this program shares its cookies with a different program and the other program s cookie was used when this order was created, then the Id of the program, whose cookie was used, is returned here.

dimension

Count

float

The total number of bonus payments to this publisher, summed up by their status ( Open , Confirmed or Cancelled )

metric

Creative Collection

string

List of all creatives of the requested creative type

dimension

Creative Info

string

Limits the results to orders, which have been triggered by the creative specified with these criteria.

dimension

Creative Info

string

Detailed information on the creative, which was used to transfer the customer to the advertiser.

dimension

Creative Name

string

The name of the found creative

dimension

Creative Number

integer

The Id of the creative, which was clicked on. The combination of ProgramId, CreativeType and CreativeNumber is unique throughout the affilinet system.

dimension

Creative Number

integer

The ID of the creative, identifying this creative among all creatives of this program

dimension

Creative Type

integer

The type of the creative, which was clicked on. The combination of ProgramId, CreativeType and CreativeNumber is unique throughout the affilinet system. Possible values are: Text, Banner and HTML

dimension

Creative Type

integer

The type of the creative on which was clicked.

dimension

Credential Token

string

The authentification token you receive from the method Logon

dimension

Currency

string

The currency which shall be applied to the monetary values specified in the call. At the time of the call, we convert this value into EUR or GBP, depending on the program s currency. Values have to follow the ISO standard 4217 and can have 3-characterabbreviations like CHF , GBP , USD , EUR , etc., case insensitive. If a submitted value cannot get recognized, we reject the whole basket. We support all reference currencies of the ECB.

dimension

Current Page

integer

Defines which result page of the size PageSize shall be returned. Counting starts at 1.

dimension

Current Page

integer

The number of the page of transactions which shall be returned. Must be 1 or bigger.

dimension

Date

datatime

Date of record

dimension

Description

string

A description on the found publisher segment

dimension

Display Settings

string

Allows you to define the paging of the results.

dimension

EndDate

datatime

If specified, only basket items will be returned, which were created with this date or earlier. Time span between StartDate and EndDate cannot exceed 3 months.

dimension

EndDate

datatime

This parameter defines the end date for which the statistics ought to be generated. It is included in the evaluation. Currently only the date part is considered.

dimension

Get Daily Statistics

string

The object which contains the search parameters

dimension

Get Statistics Per Publisher Query

string

The filter settings of the statistics request

dimension

Gross Count

long

The amount of clicks or views before filtering was applied.

metric

Ip

string

IP from which the click came

dimension

Is Locked

boolean

This flag indicates whether or not this item can still be edited - that is: whether or not the basket, to which this item belongs, is still in status open .

dimension

Is Tiered Commission

long

Open transactions, which have a tiered commission, are normally worked on only once each month, and are flagged with this field. For confirmed and cancelled transactions, this flag is NULL.

metric

Is Tiered Rate

boolean

Indicates whether or not the program is using a tiered rate system. If so, then its orders can only be confirmed by the automatic confirmation process, not manually or by a web service call.

dimension

Is Tiered Rate

boolean

Indicates whether or not the program is using a tiered rate system.

dimension

Last Status Change Date

datatime

The date when the transaction has last been edited.

dimension

Lead Multiplier

integer

If the commission of a lead rate shall be assigned not once but n times for this publisher, you can specify n in the LeadMultiplier parameter.

dimension

Leads

float

Information on the leads of this publisher, summed up by their status ( Open , Confirmed or Cancelled ).

metric

Net Count

long

The amount of clicks or views after filtering.

metric

Net Price

long

The value of the action, which the customer has performed on the advertiser s platform, e.g. his shopping cart value. For sale transactions, this price is used to calculate the commissions for sale rates and is mandatory.

metric

Net Price

long

This is what has been transmitted as the net value of the customer s action. For sale transactions, this is the base for the calculation of the commission. For lead transactions, NetPrice is optional.

metric

Net Price Max

long

Only orders will be returned, whose total net price doesn t exceed this limit.

metric

Net Price Max

long

Lets you restrict the returned transactions to those with a NetPrice of no more than this limit.

metric

Net Price Min

long

Only orders will be returned, whose total net price is at least this high.

metric

Net Price Min

long

Lets you restrict the returned transactions to those with a NetPrice of at least this limit or more.

metric

Net Price Summary

float

Information on the turnover which this publisher is responsible for (based on the parameter price of the registersale-call), summed up by the status of the transactions ( Open , Confirmed or Cancelled ).

metric

Network Fee

long

The amount of money which has been remunerated to affilinet.

metric

Network Fee Summary

float

Information on the network commission which is due to the transactions of this publisher, summed up by the status of the transactions ( Open , Confirmed or Cancelled ).

metric

New Net Price

long

Here you can specify a new NetPrice of the transaction. Must be a Double > 0.

metric

Number

string

A unique identifier, which helps us to identify this order, in case the publisher has questions about it.

dimension

Open Basket Item Count

integer

The amount of not-cancelled basket items within this basket.

dimension

Open Basket Item Count

integer

The amount of basket items, which have not been cancelled by the advertiser. Only not cancelled basket items are used to calculate the publisher commission.

dimension

Open Commission

long

The total commission value of all open transactions of this publisher

metric

Open Commission

long

Total amount of pending commissions

metric

Open Count

long

The amount of transactions in status Open .

metric

Open Sales

long

Total number of open sales

metric

Open Value

float

The sum of net prices in open transactions

metric

Order Collection

string

List of all found data sets. Each record stands for one transaction or basket.

dimension

Order Date

datatime

The timestamp on which the transaction was generated. Can be the current timestamp or anywhere in the last 180 days. If not specified, then the current timestamp is used.

dimension

Order ID v5

string

The identifier of the order, as it was submitted in the registersale call

dimension

Order Id

string

This is the Id, which the advertiser has transmitted to affilinet for the order.

dimension

Original Quantity

integer

This quantity was specified when this item got created - later changes to the quantity are reflected in the field Quantity.

dimension

Original Quantity

integer

This quantity was specified when this item got created - later changes to the quantity are reflected in the field Quantity.

dimension

Page

integer

Defines which result page of the size PageSize shall be returned. Counting starts at 1. Please note the exception if TransactionIds is specified (see below).

dimension

Page Size

integer

Defines how many records each result page shall hold. Cannot be bigger than 1000. Please note the exception if TransactionIds is specified (see below).

dimension

Page Size

integer

The amount of transactions you would like to see per page. Must be between 1 and 100.

dimension

PayPer Click

long

Summary of commission regarding clicks

metric

PayPer Sale Lead

long

Summary of commission information regarding pay per lead / sale

metric

Position Number

integer

The position of the affected item within the basket (can be obtained through GetBasketItems). In an UpdateBasketItemRequest, either BasketId and PositionNumber or OrderId and ArticleNumbermust be specified.

dimension

Position Number

integer

The position, which this item has within its basket.

dimension

Previous PublisherIds

integer

If we know of other publishers, who generated a click before the remunerated publisher, those publishers Ids are returned here.

dimension

Price

long

The total NetValue (normally: shopping cart value) of all transactions matching the given search criteria, split up by status

metric

Price

long

If a sale was done on the advertiser s platform, this is the value of the sale

metric

Processing Id

string

The temporary Id, which was assigned to the transaction request.

dimension

Product Name

string

The title of the product.

dimension

Product Name

string

The title of the product.

dimension

Program Id

integer

The Id of the requesting advertiser.

dimension

Program Status

string

This parameter defines the status in which the returned programs ought to be.

dimension

Program Title

string

The name of the program.

dimension

Program Types

string

This parameter defines the commission type of the requested statistics.

dimension

ProgramId

string

The ID of the program for which the transaction has been generated.

dimension

ProgramIds

string

This parameter defines the program IDs for which the statistcs ought to be generated. Array must contain no more than 200 ProgramIds

dimension

Properties

string

Additional information on the bought product. Up to 5 additional fields can be specified. This information is also displayed to the publisher.

dimension

Properties

string

The advertiser can define up to 5 separate optional parameters for each single basket item. These parameters can be used by the advertiser for all kinds of purposes. Typical use cases are - e.g. in the case of clothing - size, colour, material,...

dimension

Publisher Commission

long

The amount of money which has been remunerated to the publisher.

metric

Publisher Commission

long

Total amount of money this transaction is worth for the requesting publisher. The currency is tied to the country of the publisher: GBP for English publisher accounts, EUR for all others.

metric

Publisher Commission Max

long

Only orders will be returned, through which the publisher earned this much or less.

metric

Publisher Commission Min

long

Only orders will be returned, through which the publisher earned this much or more.

metric

Publisher Commission Summary

float

Information on the publisher commission, summed up by the status of the transactions ( Open , Confirmed or Cancelled ).

metric

Publisher ID v5

integer

The ID of the publisher represented in this data set

dimension

Publisher Id

integer

The ID of the publisher to whom this transaction is assigned.

dimension

Publisher Ids

integer

Restricts the orders to those, which have been generated through one of these publishers. If this is empty, the orders of all publishers are returned. Array can hold max. 100 elements.

dimension

Publisher Name

string

Limits the results to publishers, whose names contain this string

dimension

Publisher Segment

integer

Only orders triggered by publishers of this publisher segment will be returned. Input can be generated with the method GetPublisherSegments

dimension

Publisher Statistics Record Collection

string

List of all found data sets. Each record stands for one publisher.

dimension

Publisher URL

string

Limits the results to publishers, whose URLs contain this string.

dimension

PublisherId

string

Publisher ID.

dimension

Quantity

long

The count of bought articles with this ArticleNumber. We multiply Quantity with SinglePrice to calculate the NetPrice, based on which the publisher s commission is calculated.

metric

Quantity

long

The current quantity of this article within this basket. Based on Quantity and SinglePrice, the net price is calculated, which is used to calculate the publisher s commission.

metric

Rate Collection

string

List of all rates which the requesting program has defined

dimension

Rate Description

string

Normally orders are displayed to the publisher together with the name of the commissioned rate. If you would like the order to get a different text instead, you can submit it using the RateDescription parameter.

dimension

Rate Description

string

A description of the applied rate. Normally this is the rate name.

dimension

Rate Details Collection

string

The Id and the amounts of open, confirmed and cancelled transactions of this lead

dimension

Rate Filter

string

Restricts the returned transactions to only those of the given commission type.

dimension

Rate Identifier

string

If you wish to explicitly specify, which rate shall be used when remunerating the sale of this product, you can specify it here. If you don t, then this program s rate mapping settings will be applied.

dimension

Rate Info

string

Information on the rate, which applies to this transaction.

dimension

Rate Info

string

Detailed information on the rate, which has been used for this transaction.

dimension

Rate Mode

integer

The mode of the transaction.

dimension

Rate Mode

integer

Restricts the returned transactions to only those of the given commission type.

dimension

Rate Name

string

The name of the found rate

dimension

Rate Number

integer

The identifier of the desired rate.

dimension

Rate Number

integer

Each program can have several sale, lead or clickout rates. With this parameter, you can restrict the output to only those of a given rate. If RateNumber is specified, then RateMode is also required, and we recommend to also specify one ProgramId, because e.g. lead rate number 3 can mean two totally different things in two different

dimension

Rate Query

string

If specified, then only those basket items get returned, which were remunerated with this rate.

dimension

Rate QueryCollection

string

Limits the statistics to transactions, where one of these rates was used for remuneration. Input can be generated with the method GetRateList .

dimension

Rate Value

long

The value of this rate. If the rate mode is PayPerSale, this is a percentage value, otherwise it is an absolute monetary value.

metric

Rate Value

long

The value of this rate. If the rate mode is PayPerSale, this is a percentage value, otherwise it is an absolute monetary value.

metric

Referer

string

URL from which the user was coming

dimension

Referrer Token

string

The information on the publisher, who triggered the transaction. The ReferrerToken contains the Id of the publisher and if applicable it is suffixed with - and the SubId, which the publisher has submitted.

dimension

Register Basket Item Data Collection

string

Contains the detailed information on the single basket items involved.

dimension

Register Succeeded

boolean

True if the creation of the temporary transaction was successful. Otherwise a FaultException will be thrown.

dimension

Registered Net Price

long

The total net price of all not-cancelled basket items within this basket.

metric

Registered NetPrice

long

The total value of the basket, regardless of the status of the contained basket items.

metric

Registration Date

datatime

The date when the transaction has been added to our database.

dimension

Registration Date

datatime

The timestamp when the transaction has been recorded in our database.

dimension

Request Message

string

dimension

Sales

string

This publisher s sales, which meet the set filter criteria

dimension

Sales

string

Total amount of generated sales

dimension

Segment Id

integer

The ID of the found publisher segment

dimension

Segment Name

string

The name of the found publisher segment

dimension

Show Details

boolean

Set this flag to true if you would like to receive detail information on the single leads. If set to false , the LeadRateDetails property of the returned leads will be empty. Please note that setting this to true can lead to performance issues in large result sets. Default is false .

dimension

Single Price

long

The price, which one article of this ArticleNumber costs. Based on Quantity and SinglePrice, the net price is calculated, which is used to calculate the publisher s commission.

metric

Single Price

long

The price, which one article of this ArticleNumber costs. Based on Quantity and SinglePrice, the net price is calculated, which is used to calculate the publisher s commission.

metric

Sort Filter

string

Criteria by which the results should be sorted.

dimension

Start Date

datatime

If specified, only basket items will be returned, which were created with this date or later. Time span between StartDate and EndDate cannot exceed 3 months.

dimension

StartDate

datatime

This parameter defines the start date for which the statistics ought to be generated. It is included in the evaluation. Currently only the date part is considered.

dimension

Statistics Overview

float

Aggregated statistical information

metric

Status

integer

If specified, lets you restrict to the status of the desired basket items.

dimension

Status

integer

The current status of this basket item.

dimension

Sub Ids

string

Along with each order you can specify sub-Ids for your own purposes. Currently we support the keys pSub1 and pSub2.

dimension

SubId

string

Lets you restrict the returned transactions to only those matching this SubId expression. The % character can be used for wildcard searching. E.g. %A%B%C% returns all transactions which contain A , B and C somewhere within their SubId (in this order). This string can hold up to 80 characters incl. wildcards.

dimension

Successful

boolean

True if the update request has succeeded. Otherwise a FaultException will be thrown.

dimension

Time

datatime

The time when the click was made

dimension

Total Basket Item Count

long

The total amount of basket items contained in this basket, cancelled or not-cancelled.

metric

Total Basket ItemCount

float

The total amount of items within this basket, regardless of their status.

metric

Total Commission

long

Total amount of earnings

metric

Total Count

long

The total amount of found data sets.

metric

Total Net Price

float

The total NetPrice value of transacions of this RateMode, summed up by their status ( Open , Confirmed or Cancelled ).

metric

Total Network Fee

float

The sum of NetworkFees of all transactions of this RateMode, summed up by their status ( Open , Confirmed or Cancelled ).

metric

Total Open Commission

long

Total amount of pending commissions

metric

Total Price

long

The total value of this basket item, calculated as Quantity * SinglePrice.

metric

Total Price

long

The total value of this basket item, calculated as Quantity * SinglePrice.

metric

Total Publisher Commission

float

The sum of PublisherCommissions, summed up by their status ( Open , Confirmed or Cancelled ).

metric

Total Records

long

The total amount of transactions matching the given search criteria.

metric

Tracking Method

string

The recording method, which has been used to create the transaction.

dimension

Transaction

string

Type of transaction.

dimension

Transaction Collection

string

The transactions matching the given search criteria.

dimension

Transaction Id

integer

The unique identifier, which affilinet has assigned to the desired transaction.

dimension

Transaction Id

integer

The unique identifier of this transaction within our database.

dimension

Transaction Ids

integer

If specified, only transactions are returned, which have any of these IDs. The entries in Page and PageSize are ignored in this case. Array can hold up to 100 IDs. If specified, baskets are not returned, but only transactions.

dimension

Transaction Ids

integer

This parameter lets you access specific transactions by their unique TransactionId. Up to 100 TransactionIds can be specified with each request. If this parameter is set, all other input parameters of the TransactionQuery and the RateFilter must be left empty. PageSettings still have to be defined.

dimension

Transaction Status

integer

The status which the transaction currently has.

dimension

Transaction Status

integer

Depicts the status of the sale or lead.

dimension

Transaction Summary

long

The number of transactions for the given search criteria, split up by status

metric

Valuation Type

integer

Defines whether you want the defined StartDate and EndDate to define the day when the orders were registered (RegistrationDate) or edited Advertiser Webservices Page 3 (LastStatusChangeDate).

dimension

Valuation Type

integer

This parameter defines the event on which StartDate and EndDate shall operate.

dimension

Views

long

The publisher s Views, which meet the set filter criteria.

metric

Views

long

Total number of views

metric

Volume Max

long

Limits the statistics to publishers who have this much or less of whatever is defined in VolumeType. If VolumeMax is specified, VolumeType also needs to be filled.

metric

Volume Min

long

Limits the statistics to publishers who have this much or more of whatever is defined in VolumeType. If VolumeMin is specified, VolumeType also needs to be filled.

metric

Volume Type

integer

Defines the statistical figure, which shall be applied to VolumeMax and/or VolumeMin.

dimension

Volume Type Rate Number

string

If VolumeType is set to SalesByRate or LeadsByRate , this field specifies, which sale rate resp. lead rate shall be considered.

dimension

Voucher Code

string

If in the shopping process, a voucher code was used, you can submit the involved voucher code here.

dimension